Avito Report API

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

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

    '
  title: Иерархия Аккаунтов Access Report API
  version: '1'
servers:
- url: https://api.avito.ru/
tags:
- name: Report
  x-displayName: Отчеты Автотеки
  x-subdivName: Отчеты Автотеки
paths:
  /autoteka/v1/previews:
    post:
      description: 'Возвращает идентификатор `previewId`, по которому асинхронно с помощью [запроса на получение превью по ID](#operation/getPreview) можно получить результат

        '
      operationId: postPreviewByVin
      parameters:
      - $ref: '#/components/parameters/authHeader'
      requestBody:
        content:
          application/json:
            example:
              vin: XTA210990Y2766111
            schema:
              $ref: '#/components/schemas/RequestByVinAutoteka'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestPreviewResponseBodyAutoteka'
          description: Успешный ответ
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notFoundError'
          description: Информация не найдена
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tooManyRequestsError'
          description: Превышено допустимое количество запросов
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internalError'
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: 'Превью по VIN или номеру кузова

        '
      tags:
      - Report
      x-trailing-slash: true
  /autoteka/v1/previews/{previewId}:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    - description: Идентификатор превью
      in: path
      name: previewId
      required: true
      schema:
        minimum: 1
        type: integer
    get:
      description: 'Возвращает текущий статус сбора информации превью, и краткую инфо по запрашиваемому `VIN`

        '
      operationId: getPreview
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPreviewResponseBodyAutoteka'
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notFoundError'
          description: Информация не найдена
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internalError'
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: 'Получение превью по его ID

        '
      tags:
      - Report
      x-trailing-slash: true
  /autoteka/v1/reports:
    post:
      description: 'Метод для запроса отчета по `previewId`, возвращает идентификатор отчета по которому сформированный отчет можно получить в [методе для получения отчета по его идентификатору](#operation/getReport). При запросе происходит списание доступных отчетов

        '
      operationId: postReport
      parameters:
      - $ref: '#/components/parameters/authHeader'
      requestBody:
        content:
          application/json:
            example:
              previewId: 123
            schema:
              $ref: '#/components/schemas/RequestReportByPreviewIdAutoteka'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateReportResponseBodyAutoteka'
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notFoundError'
          description: Данные по превью не найдены
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internalError'
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: 'Отчет по превью

        '
      tags:
      - Report
      x-trailing-slash: true
  /autoteka/v1/reports-by-vehicle-id:
    post:
      description: 'Метод для запроса отчета по идентификатору авто (vin/frame), возвращает идентификатор отчета по которому сформированный отчет можно получить в [методе для получения отчета по его идентификатору](#operation/getReport). При запросе происходит списание доступных отчетов

        '
      operationId: postReportByVehicleId
      parameters:
      - $ref: '#/components/parameters/authHeader'
      requestBody:
        content:
          application/json:
            example:
              vehicleId: XTA210990Y2766111
            schema:
              $ref: '#/components/schemas/RequestReportByVehicleIdAutoteka'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateReportResponseBodyAutoteka'
          description: Успешный ответ
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notFoundError'
          description: Информация не найдена
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tooManyRequestsError'
          description: Превышено допустимое количество запросов
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internalError'
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: 'Отчет по идентификатору авто (vin/frame)

        '
      tags:
      - Report
      x-trailing-slash: true
  /autoteka/v1/reports/{report_id}:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    - description: Идентификатор отчета.
      in: path
      name: report_id
      required: true
      schema:
        minimum: 1
        type: integer
    get:
      description: 'Получение подробного отчета по его идентификатору, полученному из [запроса на создание отчета](#operation/postReport)

        '
      operationId: getReport
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportAsync'
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notFoundError'
          description: Отчет не найден
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internalError'
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: 'Получение отчета по его ID

        '
      tags:
      - Report
      x-trailing-slash: true
  /autoteka/v1/request-preview-by-external-item:
    post:
      description: 'Возвращает идентификатор `previewId`, по которому асинхронно с помощью [запроса на получение превью по ID](#operation/getPreview) можно получить результат

        '
      operationId: postPreviewByExternalItem
      parameters:
      - $ref: '#/components/parameters/authHeader'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                itemId:
                  minLength: 3
                  type: string
                site:
                  minLength: 3
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestPreviewResponseBodyAutoteka'
          description: Успешный ответ
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notFoundError'
          description: Информация не найдена
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tooManyRequestsError'
          description: Превышено допустимое количество запросов
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internalError'
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: 'Превью по ID объявления другой площадки

        '
      tags:
      - Report
  /autoteka/v1/request-preview-by-item-id:
    post:
      description: 'Возвращает идентификатор `previewId`, по которому асинхронно с помощью [запроса на получение превью по ID](#operation/getPreview) можно получить результат

        '
      operationId: postPreviewByItemId
      parameters:
      - $ref: '#/components/parameters/authHeader'
      requestBody:
        content:
          application/json:
            example:
              itemId: 1234567
            schema:
              $ref: '#/components/schemas/RequestPreviewByItemIdAutoteka'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestPreviewResponseBodyAutoteka'
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notFoundError'
          description: Preview не найдено
        '500':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      codex:
                        description: Код ошибки
                        example: 400
                        format: int32
                        type: integer
                      message:
                        description: Сообщение об ошибке
                        example: Service is temporary unavailable
                        type: string
                    required:
                    - codex
                    - message
                    type: object
                type: object
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: Превью по ID объявления Авито
      tags:
      - Report
  /autoteka/v1/request-preview-by-regnumber:
    x-gateway:
      timeouts:
        connect: 200ms
        envoy: 5.0s
        read: 5s
        send: 5s
    post:
      description: 'Возвращает идентификатор `previewId`, по которому асинхронно с помощью [запроса на получение превью по ID](#operation/getPreview) можно получить результат

        '
      operationId: postPreviewByRegNumber
      parameters:
      - $ref: '#/components/parameters/authHeader'
      requestBody:
        content:
          application/json:
            example:
              regNumber: X777XX777
            schema:
              $ref: '#/components/schemas/RequestByRegNumberAutoteka'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestPreviewResponseBodyAutoteka'
          description: Успешный ответ
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notFoundError'
          description: Информация не найдена
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tooManyRequestsError'
          description: Превышено допустимое количество запросов
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internalError'
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: 'Превью по государственному номеру

        '
      tags:
      - Report
  /autoteka/v1/sync/create-by-regnumber:
    post:
      description: 'Метод для создания отчета по государственному регистрационному номеру в синхронном режиме без превью. Возвращает отчет. Таймаут - 30 секунд. Списывает проверку. Если в течение 30 секунд отчет не был сформирован, повторный запрос в течение часа не спишет дополнительных проверок.

        Чтобы подключить эту возможность, обратитесь к менеджеру Автотеки.

        '
      operationId: postSyncCreateReportByRegNumber
      parameters:
      - $ref: '#/components/parameters/authHeader'
      requestBody:
        content:
          application/json:
            example:
              regNumber: X777XX777
            schema:
              $ref: '#/components/schemas/RequestByRegNumberAutoteka'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReport'
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internalError'
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: 'Синхронное создание отчета по ГРЗ

        '
      tags:
      - Report
  /autoteka/v1/sync/create-by-vin:
    post:
      description: 'Метод для создания отчета по VIN или номеру кузова в синхронном режиме без превью. Возвращает отчет. Таймаут - 30 секунд. Списывает проверку. Если в течение 30 секунд отчет не был сформирован, повторный запрос в течение часа не спишет дополнительных проверок.

        Чтобы подключить эту возможность, обратитесь к менеджеру Автотеки.

        '
      operationId: postSyncCreateReportByVin
      parameters:
      - $ref: '#/components/parameters/authHeader'
      requestBody:
        content:
          application/json:
            example:
              vin: XTA210990Y2766111
            schema:
              $ref: '#/components/schemas/RequestByVinAutoteka'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReport'
          description: Успешный ответ
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validatingError'
          description: Ошибка валидации входных параметров
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forbiddenError'
          description: Операцию невозможно выполнить
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internalError'
          description: Информация об ошибке
      security:
      - ClientCredentials: []
      summary: 'Синхронное создание отчёта по VIN или номеру кузова

        '
      tags:
      - Report
components:
  schemas:
    CreateReportResponseBodyAutoteka:
      properties:
        result:
          $ref: '#/components/schemas/CreateReportResponseDataAutoteka'
      type: object
    GetPreviewResponseDataAutoteka:
      properties:
        preview:
          $ref: '#/components/schemas/PreviewAutoteka'
      type: object
    GetPreviewResponseBodyAutoteka:
      properties:
        result:
          $ref: '#/components/schemas/GetPreviewResponseDataAutoteka'
      type: object
    TaxiDataAutoteka:
      description: Сведения об использовании в такси
      nullable: true
      properties:
        events:
          description: Список записей об использовании в такси
          items:
            $ref: '#/components/schemas/TaxiDataEventAutoteka'
          type: array
        recaps:
          deprecated: true
          description: Суммарная информация
          items:
            $ref: '#/components/schemas/RecapAutoteka'
          type: array
        requestTime:
          description: Дата запроса к источнику UnixTime
          example: 1566507600
          nullable: true
          type: integer
      required:
      - events
      - recaps
      type: object
    TechInspectionHistoryEvent:
      description: Информация о событии прохождения тех. осмотра
      properties:
        cardNumber:
          description: Номер диагностической карты
          example: 65320071902728
          nullable: true
          type: string
        endDate:
          description: Действителен до
          example: 1566507600
          format: int64
          nullable: true
          type: integer
        mileage:
          description: Пробег
          example: 75000
          format: int64
          nullable: true
          type: integer
        startDate:
          description: Дата техосмотра
          example: 1566507600
          format: int64
          type: integer
      required:
      - startDate
      - endDate
      - mileage
      - cardNumber
      type: object
    internalError:
      properties:
        error:
          properties:
            code:
              description: Код ошибки
              example: 500
              format: int32
              type: integer
            message:
              description: Сообщение об ошибке
              example: Service is temporary unavailable
              type: string
          required:
          - code
          - message
          type: object
      type: object
    RequestReportByPreviewIdAutoteka:
      properties:
        previewId:
          description: Идентификатор превью.
          minimum: 1
          type: integer
      required:
      - previewId
      type: object
    AvitoPriceValuation:
      description: Оценка подержаного автомобиля от Авито
      nullable: true
      properties:
        avgMarketPrice:
          description: Оценка на основе объявлений
          example: 950000
          nullable: true
          type: integer
        avgMileage:
          description: Средний пробег аналогов
          example: 50000
          nullable: true
          type: integer
        avgPriceWithCondition:
          description: Оценка с учетом состояния автомобилей на основе реальных сделок
          example: 936000
          type: integer
        avgYear:
          description: Средний год выпуска аналогов
          example: 2012.9999
          format: float
          nullable: true
          type: number
        imvUrl:
          deprecated: true
          description: Поле больше не заполняется. Ссылка на страницу Авито IMV вида https://www.avito.ru/au-imv-info/2963331288
          example: https://www.avito.ru/au-imv-info/2963331288
          nullable: true
          type: string
        itemsCount:
          description: Количество машин, учтенных в оценке
          example: 121
          nullable: true
          type: integer
        marketNormalPriceRange:
          description: Диапазон "рыночной" оценки данного автомобиля по закрытым сделкам
          nullable: true
          properties:
            max:
              description: Максимальная граница "рыночной" оценки данного автомобиля по закрытым сделкам
              example: 5248900
              type: integer
            min:
              description: Минимальная граница "рыночной" оценки данного автомобиля по закрытым сделкам
              example: 3248900
              type: integer
          required:
          - min
          - max
          type: object
        maxPrice:
          description: Максимальная цена похожих авто на основе объявлений
          example: 1000000
          nullable: true
          type: integer
        minPrice:
          description: Минимальная цена похожих авто на основе объявлений
          example: 800000
          nullable: true
          type: integer
      required:
      - avgPriceWithCondition
      type: object
    ArbitrationCases:
      description: Арбитражные дела
      nullable: true
      properties:
        cases:
          items:
            description: Список арбитражных дел
            properties:
              caseId:
                description: ID дела
                example: c9babcc7-e797-429c-b6e4-xxyyzzd7334a
                type: string
              caseNumber:
                description: Номер дела
                example: А53-30848/2015
                type: string
              caseUrl:
                description: Ссылка на дело на kad.arbitr.ru
                example: https://kad.arbitr.ru/Card/c9babcc7-e797-429c-b6e4-xxyyzzd7334a
                type: string
              contentTypes:
                description: Уточненные типы документа
                items:
                  example: Оставить без изменения определение первой инстанции, а жалобу - без удовлетворения (ст.272 АПК)
                  type: string
                type: array
              court:
                description: Название суда
                example: 15 арбитражный апелляционный суд
                type: string
              fileName:
                description: Название файла
                example: А53-837163-2015__20181221.pdf
                type: string
              fileUrl:
                description: Ссылка для загрузки файла
                example: https://kad.arbitr.ru/PdfDocument/c9babcc7-e797-429c-b6e4-6287b5d7334a/b6e2f927-00ea-4dee-8fca-xxyyzzd7334a/А53-30848-2015__20181221.pdf?download=true
                type: string
              instanceLevel:
                description: Уровень инстанции
                example: 2
                format: int64
                type: integer
              instanceNumber:
                description: Номер инстанции
                example: 15АП-20855/2018
                type: string
              registrationDate:
                description: Дата регистрации документа в формате Unixtime
                example: 1520889000
                format: int64
                type: integer
              type:
                description: Тип документа
                example: Постановление апелляционной инстанции
                type: string
            required:
            - caseId
            - caseUrl
            - registrationDate
            - instanceNumber
            - caseNumber
            - fileName
            - fileUrl
            - instanceLevel
            - court
            - type
            - contentTypes
            type: object
          type: array
      type: object
    RequestPreviewResponseBodyAutoteka:
      properties:
        result:
          $ref: '#/components/schemas/RequestPreviewResponseDataAutoteka'
      type: object
    validatingError:
      properties:
        error:
          properties:
            code:
              description: Код ошибки
              example: 400
              format: i

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