Avito Realty API

The Realty API from Avito — 7 operation(s) for realty.

Documentation

📖
Documentation
https://developers.avito.ru/api-catalog/accounts-hierarchy/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/ads/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/auction/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/auth/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/autoload/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/autostrategy/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/autoteka/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/avito-promo/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/calltracking/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/cpa/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/cpxpromo/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/delivery-sandbox/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/item/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/job/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/messenger/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/order-management/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/promotion/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/ratings/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/realty-reports/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/sbc-gateway/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/stock-management/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/str/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/tariff/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/trxpromo/documentation
📖
Documentation
https://developers.avito.ru/api-catalog/user/documentation

Specifications

OpenAPI Specification

avito-realty-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  contact:
    email: supportautoload@avito.ru
  description: 'API для взаимодействия с иерархией аккаунтов в Авито

    **Авито API для бизнеса предоставляется согласно [Условиям использования](https://www.avito.ru/legal/pro_tools/public-api).**

    '
  title: Иерархия Аккаунтов Access Realty API
  version: '1'
servers:
- url: https://api.avito.ru/
tags:
- name: Realty
paths:
  /realty/v1/marketPriceCorrespondence/{itemId}/{price}:
    get:
      description: 'Получение соответствия переданной цены рыночной цене


        **Данный метод доступен только пользователям с активной подпиской «Лидер» в категории «Недвижимость»**

        '
      operationId: market_price_correspondence_v1
      parameters:
      - description: Идентифиактор объявления
        in: path
        name: itemId
        required: true
        schema:
          type: integer
      - description: Цена
        in: path
        name: price
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  correspondence:
                    description: 'Признак соответствия рыночной цене

                      - below - цена ниже рыночной

                      - normal - цена соответствует рыночной

                      - above - цена выше рыночной'
                    enum:
                    - below
                    - normal
                    - above
                    type: string
                  error:
                    $ref: '#/components/schemas/Error'
                type: object
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                - error
                type: object
          description: Некорректный запрос
        '401':
          description: Неавторизован
        '403':
          content:
            application/json:
              schema:
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                - error
                type: object
          description: Ошибка доступа
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                - error
                type: object
          description: Не найдено
        '500':
          content:
            application/json:
              schema:
                properties:
                  error:
                    $ref: '#/components/schemas/Error'
                required:
                - error
                type: object
          description: Внутренняя ошибка
      security:
      - ClientCredentials: []
      summary: Получение соответствия переданной цены рыночной цене
      x-rate-limiter:
        default: 60
      tags:
      - Realty
  /realty/v1/report/create/{itemId}:
    post:
      description: 'Получение аналитического отчета по недвижимости


        **Данный метод доступен только пользователям с активной подпиской «Лидер» в категории «Недвижимость»**

        '
      operationId: CreateReportForClassified
      parameters:
      - description: Идентификатор объявления
        in: path
        name: itemId
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  success:
                    format: enum
                    properties:
                      errors:
                        properties:
                          accessDenied:
                            description: Объект не принадлежит агенту
                            type: boolean
                          featureDisabled:
                            description: Фича получения отчета по API недоступна
                            type: boolean
                          invalidItem:
                            description: Неверный идентификатор объявления
                            type: boolean
                          message:
                            description: Сообщение об ошибке
                            type: string
                        type: object
                      success:
                        properties:
                          reportLink:
                            description: Ссылка на аналитический отчет
                            type: string
                        required:
                        - reportLink
                        type: object
                    type: object
                required:
                - success
                type: object
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                properties:
                  bad-request:
                    $ref: '#/components/schemas/ErrorMessage'
                required:
                - bad-request
                type: object
          description: Некорректный запрос
        '401':
          content:
            application/json:
              schema:
                properties:
                  unauthenticated:
                    $ref: '#/components/schemas/ErrorMessage'
                required:
                - unauthenticated
                type: object
          description: Неавторизован
        '403':
          content:
            application/json:
              schema:
                properties:
                  forbidden:
                    $ref: '#/components/schemas/ErrorMessage'
                required:
                - forbidden
                type: object
          description: Ошибка доступа
        '500':
          content:
            application/json:
              schema:
                properties:
                  internal-error:
                    $ref: '#/components/schemas/ErrorMessage'
                required:
                - internal-error
                type: object
          description: Внутренняя ошибка
      security:
      - ClientCredentials: []
      summary: Получение аналитического отчета по недвижимости
      x-rate-limiter:
        default: 60
      tags:
      - Realty
  /core/v1/accounts/{user_id}/items/{item_id}/bookings:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    - $ref: '#/components/parameters/pathUserId'
    - $ref: '#/components/parameters/pathItemId'
    post:
      description: 'Заполнение календаря занятости объекта недвижимости (для краткосрочной аренды)

        '
      operationId: putBookingsInfo
      requestBody:
        content:
          application/json:
            example:
              bookings:
              - comment: Комментарий
                date_end: '2026-03-24'
                date_start: '2026-03-23'
              - date_end: '2026-03-25'
                date_start: '2026-03-24'
                type: manual
              - date_end: '2026-03-26'
                date_start: '2026-03-25'
                type: booking
              source: pms
            schema:
              $ref: '#/components/schemas/PostCalendarData'
        description: 'Последний день брони доступен для пользователя (открытый конец),

          так, бронь в один день занимается промежутком в два дня.

          Промежутки не должны пересекаться (допустимо совпадение конца одной брони и начала второй в силу открытости).

          При пересечении любого интервала с оплаченной бронью на Авито, будет возвращена ошибка.  Закрыты будут только интервалы без пересечений.

          '
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    description: Результат обработки запроса
                    enum:
                    - success
                    type: string
                type: object
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Пользователь не владеет айтемом
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Айтем не найден
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatesOverlapBookingError'
          description: На заданные даты есть оплаченные брони
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Неверные данные
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Внутренняя ошибка
      security:
      - AuthorizationCode:
        - short_term_rent:write
      - ClientCredentials: []
      summary: Заполнение календаря занятости объекта недвижимости
      tags:
      - Realty
  /realty/v1/accounts/{user_id}/items/{item_id}/bookings:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    - $ref: '#/components/parameters/pathUserId'
    - $ref: '#/components/parameters/pathItemId'
    - $ref: '#/components/parameters/skipError'
    - description: Фильтр, ограничивающий выборку по нижней границе дат, не в прошлом
      in: query
      name: date_start
      required: true
      schema:
        example: '2026-01-01'
        format: date
        type: string
    - description: Фильтр, ограничивающий выборку по верхней границе дат, не в прошлом
      in: query
      name: date_end
      required: true
      schema:
        example: '2026-05-01'
        format: date
        type: string
    - description: Флаг, позволяющий получить неоплаченные брони (возвращаются в статусе pending)
      in: query
      name: with_unpaid
      schema:
        example: true
        type: boolean
    get:
      description: 'Возвращает информацию о бронированиях объекта за весь период.

        '
      operationId: getRealtyBookings
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  bookings:
                    description: Список броней
                    items:
                      $ref: '#/components/schemas/RealtyBooking'
                    type: array
                required:
                - bookings
                type: object
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Пользователь не владеет айтемом
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Айтем не найден
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Неверные данные
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Внутренняя ошибка
      security:
      - AuthorizationCode:
        - short_term_rent:read
      - ClientCredentials: []
      summary: 'Получение списка броней по объявлению

        '
      tags:
      - Realty
  /realty/v1/accounts/{user_id}/items/{item_id}/prices:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    - $ref: '#/components/parameters/pathUserId'
    - $ref: '#/components/parameters/pathItemId'
    - $ref: '#/components/parameters/skipError'
    post:
      description: 'Обновляет параметры (цена за ночь, доплата за гостя, минимальная продолжительность брони) для каждого из переданных диапазонов дат, изменения применяются к каждой дате диапазона. В случае, если на занимаемые даты есть брони в неподтвержденных статусах, то брони переводятся в статус overbook.

        '
      operationId: postRealtyPrices
      requestBody:
        content:
          application/json:
            example:
              prices:
              - date_from: '2026-06-02'
                date_to: '2026-06-14'
                extra_guest_fee: 500
                minimal_duration: 1
                night_price: 1500
              - date_from: '2026-06-15'
                date_to: '2026-06-15'
                extra_guest_fee: 1000
                minimal_duration: 7
                night_price: 5000
            schema:
              $ref: '#/components/schemas/ParamPricesRealty'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    description: Результат обработки запроса
                    enum:
                    - success
                    type: string
                type: object
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Пользователь не владеет айтемом
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Айтем не найден
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Неверные данные
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Внутренняя ошибка
      security:
      - AuthorizationCode:
        - short_term_rent:write
      - ClientCredentials: []
      summary: 'Актуализация параметров для выбранных периодов

        '
      tags:
      - Realty
  /realty/v1/items/intervals:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    - $ref: '#/components/parameters/skipError'
    post:
      description: 'Заполнение календаря доступности объекта недвижимости с квотами и без (для краткосрочной аренды)

        '
      operationId: putIntervals
      requestBody:
        content:
          application/json:
            example:
              intervals:
              - date_end: '2024-03-24'
                date_start: '2024-03-23'
                open: 10
              - date_end: '2024-03-25'
                date_start: '2024-03-24'
                open: 2
              item_id: 270000555
              source: pms
            schema:
              $ref: '#/components/schemas/PostCalendarDataV2'
        description: 'Последний день интервала недоступен для пользователя (открытый конец), так, открытость одного дня  указывается промежутком в два дня. Интервалы на год вперед, которые не приходят в запросе, считаются закрытыми. Возможен пустой список во входном запросе: в этом случае считается, что продажи закрыты на год вперед. Промежутки не должны пересекаться (допустимо совпадение конца одного и начала другого). Работает как для объявлений с квотами, так и для обычных объявлений.

          '
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    description: Результат обработки запроса
                    enum:
                    - success
                    type: string
                type: object
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Пользователь не владеет айтемом
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Айтем не найден
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Неверные данные
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Внутренняя ошибка
      security:
      - AuthorizationCode:
        - short_term_rent:write
      - ClientCredentials: []
      summary: Заполнение доступности объекта недвижимости с квотами и без
      tags:
      - Realty
  /realty/v1/items/{item_id}/base:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    - $ref: '#/components/parameters/pathItemId'
    post:
      description: 'Обновляет базовые параметры: цена за ночь, минимальное количество ночей, доплата за гостя,  количество гостей больше которых активируется опция доплаты за гостя, период бесплатной отмены, параметры мгновенного бронирования (активность, максимальное/минимальное количество дней до заселения), скидки на бронирование.

        '
      operationId: postBaseParams
      requestBody:
        content:
          application/json:
            example:
              discount:
              - percent: 10
                threshold: 3
              - percent: 15
                threshold: 7
              extra_guest_fee: 500
              extra_guest_threshold: 4
              instant:
                active: true
                max_days: 30
                min_days: 3
              minimal_duration: 1
              night_price: 3000
              refund:
                days: 7
            schema:
              $ref: '#/components/schemas/BaseParams'
        required: true
      responses:
        '200':
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Пользователь не владеет айтемом
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Айтем не найден
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Неверные данные
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
          description: Внутренняя ошибка
      security:
      - AuthorizationCode:
        - short_term_rent:write
      - ClientCredentials: []
      summary: 'Установка базовых параметров

        '
      tags:
      - Realty
components:
  schemas:
    BaseParams:
      description: Базовые параметры
      properties:
        discount:
          description: Скидки при бронировании от threshold ночей
          items:
            properties:
              percent:
                description: Процент скидки от суммы бронирования
                format: int64
                type: integer
              threshold:
                description: Порог ночей, после которых применяется скидка
                enum:
                - 3
                - 7
                - 30
                format: int64
                type: integer
            type: object
          type: array
        extra_guest_fee:
          description: Доплата за гостя (рубли)
          format: int64
          nullable: true
          type: integer
        extra_guest_threshold:
          description: Порог гостей, при котором цена - night_price
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          format: int64
          nullable: true
          type: integer
        fees:
          description: Настройки доплат
          nullable: true
          properties:
            cleaning:
              description: Доплата за уборку после выезда
              nullable: true
              properties:
                amount:
                  description: Сумма доплаты в рублях. Можно указать 0, если уборка включена в стоимость
                  format: int64
                  type: integer
              type: object
            pets:
              description: Доплата за проживание с питомцем
              nullable: true
              properties:
                allowed:
                  description: Разрешено ли размещение с питомцем
                  type: boolean
                amount:
                  description: Стоимость проживания с питомцем в рублях
                  format: int64
                  type: integer
                application:
                  description: Тип применения доплаты за питомца (за ночь, за бронь)
                  enum:
                  - by_booking
                  - by_night
                  type: string
              type: object
          type: object
        instant:
          description: Параметры мгновенного бронирования
          nullable: true
          properties:
            active:
              description: Включено ли мгновенное бронирование
              type: boolean
            max_days:
              description: Максимальное количество дней до заселения для работы МБ (если нет, то без ограничений)
              enum:
              - 30
              - 60
              - 90
              - 120
              - 150
              format: int64
              nullable: true
              type: integer
            min_days:
              description: Минимальное количество дней до заселения для работы МБ (если нет, то без ограничений)
              enum:
              - 1
              - 2
              - 3
              - 4
              - 5
              format: int64
              nullable: true
              type: integer
          type: object
        minimal_duration:
          description: Минимальная продолжительность (ночи)
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          format: int32
          nullable: true
          type: integer
        night_price:
          description: Цена проживания за ночь (рубли)
          format: int64
          nullable: true
          type: integer
        refund:
          description: Параметры возврата
          nullable: true
          properties:
            days:
              description: Количество дней до заезда, когда за отмену налагается штраф
              enum:
              - 0
              - 1
              - 3
              - 5
              - 7
              - 14
              format: int64
              type: integer
          type: object
      type: object
    DatesOverlapBookingError:
      properties:
        error:
          properties:
            code:
              description: Код ошибки
              example: 409
              format: int32
              type: integer
            conflicts:
              description: Список периодов, конфликтующих с оплаченными бронями на Авито
              items:
                $ref: '#/components/schemas/ConflictedInterval'
              type: array
            message:
              description: Сообщение об ошибке
              example: error
              type: string
          required:
          - code
          - message
          - conflicts
          type: object
      type: object
    PostCalendarData:
      description: Информация о занятости объекта на определённые периоды
      properties:
        bookings:
          description: Список броней для выбранного объекта недвижимости (объявления)
          items:
            properties:
              comment:
                description: Дополнительная информация
                example: Дополнительная информация
                nullable: true
                type: string
              date_end:
                description: Дата окончания периода аренды, не в прошлом
                example: '2026-04-01'
                format: date
                type: string
              date_start:
                description: Дата начала периода аренды, не в прошлом
                example: '2026-03-23'
                format: date
                type: string
              type:
                description: Даты закрыты вручную или по данными другого OTA (manual, booking)
                enum:
                - manual
                - booking
                nullable: true
                type: string
            type: object
          type: array
        source:
          description: Название PMS системы
          example: pms
          nullable: true
          type: string
      type: object
    Error_2:
      properties:
        error:
          properties:
            code:
              description: Код ошибки
              format: int32
              type: integer
            message:
              description: Сообщение об ошибке
              example: error
              type: string
          required:
          - code
          - message
          type: object
      type: object
    validatingError:
      properties:
        error:
          properties:
            code:
              description: Код ошибки
              example: 400
              format: int32
              type: integer
            fields:
              additionalProperties: {}
              description: Информация об ошибке валидации параметров в формате ключ-значение
              nullable: true
              type: object
            message:
              description: Сообщение об ошибке
              example: Validation error
              type: string
          required:
          - code
          - message
          type: object
      type: object
    ConflictedInterval:
      description: Период, конфликтующий с оплаченными бронями на Авито
      properties:
        bookings:
          description: Список оплаченных броней на Авито, конфликтующих с периодом
          items:
            $ref: '#/components/schemas/AvitoBooking'
          type: array
        interval:
          description: Период аренды из запроса
          properties:
            date_end:
              description: Дата окончания периода аренды
              example: '2026-04-01'
              format: date
              type: string
            date_start:
              description: Дата начала периода аренды
              example: '2026-03-23'
              format: date
              type: string
          required:
          - date_start
          - date_end
          type: object
      required:
      - interval
      - bookings
      type: object
    AvitoBooking:
      description: Оплаченная на Авито бронь
      properties:
        avito_booking_id:
          description: Идентификатор брон

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/avito/refs/heads/main/openapi/avito-realty-api-openapi.yml