Avito Report API

openapi: 3.2.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:
    EventsAutoteka:
      deprecated: true
      description: Блок с предупреждениями об авто
      properties:
        avitoOnSale:
          description: Находится ли в данный момент в продаже на Авито
          properties:
            additionalInfo:
              description: Доп. информация по объявлению
              properties:
                date:
                  description: Дата последнего обновления
                  format: int64
                  type: integer
                price:
                  description: Цена
                  format: int64
                  type: integer
                title:
                  description: Заголовк объявления
                  type: string
                url:
                  description: Ссылка на объявление
                  type: string
              required:
              - date
              - price
              - title
              - url
              type: object
            description:
              description: Текстовое описание
              example: Авто в продаже
              type: string
            type:
              description: статус события `caution`, `ok`, `warning`
              example: ok
              type: string
            value:
              description: true - находится, false - не находится
              example: true
              type: boolean
          required:
          - additionalInfo
          - type
          - value
          - description
          type: object
        bodyRepair:
          description: наличие кузовных ремонтов
          properties:
            description:
              description: Текстовое описание
              example: 1 кузовной ремонт
              type: string
            type:
              description: статус события `caution`, `ok`, `warning`
              example: caution
              type: string
            value:
              description: есть или нет кузовные ремонты
              example: true
              type: boolean
          required:
          - description
          - type
          - value
          type: object
        crashes:
          description: Наличие ДТП
          properties:
            description:
              description: Текстовое описание
              example: 3 ДТП
              type: string
            type:
              description: статус события `caution`, `ok`, `warning`
              example: warning
              type: string
            value:
              description: Наличие ДТП
              example: true
              type: boolean
          required:
          - description
          - type
          - value
          type: object
        dealerDataAvailable:
          description: Наличие диллерских данных
          properties:
            description:
              description: Текстовое описание
              example: Нет данных от дилера
              type: string
            type:
              description: статус события `caution`, `ok`, `warning`
              example: ok
              type: string
            value:
              description: true - в отчете есть данные дилера, false - данных дилера нет
              example: true
              type: boolean
          required:
          - description
          - type
          - value
          type: object
        firstSellDate:
          description: Дата первой продажи
          properties:
            type:
              description: статус события `caution`, `ok`, `warning`
              example: ok
              type: string
            value:
              description: дата первой продажи
              example: '2020-01-01'
              type: string
          required:
          - type
          - value
          type: object
        lastMileageRecord:
          description: Последний зафиксированный пробег
          properties:
            description:
              description: Текстовое описание
              example: Пробег 105 125 км
              type: string
            type:
              description: статус события `caution`, `ok`, `warning`
              example: warning
              type: string
            value:
              description: значение пробега в километрах
              example: 105125
              format: int64
              type: integer
          required:
          - description
          - type
          - value
          type: object
        owners:
          description: Количество владельцев
          properties:
            description:
              description: Количество владельце
              example: 3 владельца
              type: string
            type:
              description: статус события `caution`, `ok`, `warning`
              example: ok
              type: string
            value:
              description: Количество владельце
              example: 3
              format: int64
              type: integer
          required:
          - description
          - type
          - value
          type: object
        pledge:
          description: Наличие залогов
          properties:
            description:
              description: Текстовое описание
              example: Залоги не обнаружены
              type: string
            type:
              description: статус события `caution`, `ok`, `warning`
              example: caution
              type: string
            value:
              description: true - залог есть, false - залогов нет
              example: false
              type: boolean
          required:
          - description
          - type
          - value
          type: object
        publicPerson:
          description: Владелец частное или юридическое лицо
          properties:
            description:
              description: Текстовое описание
              example: Регистрация на юрлицо
              type: string
            type:
              description: статус события `caution`, `ok`, `warning`
              example: ok
              type: string
            value:
              description: владелец true - юрлицо, false -  физлицо
              example: true
              type: boolean
          required:
          - description
          - type
          - value
          type: object
      required:
      - crashes
      - bodyRepair
      - publicPerson
      - owners
      - dealerDataAvailable
      - lastMileageRecord
      - pledge
      - avitoOnSale
      - firstSellDate
      type: object
    validatingError:
      properties:
        error:
          properties:
            code:
              description: Код ошибки
              example: 400
              format: int32
              type: integer
            message:
              description: Сообщение об ошибке
              example: Validation error
              type: string
          required:
          - code
          - message
          type: object
      type: object
    DiagnosticsEventPhoto:
      description: Фотография с диагностического осмотра
      properties:
        name:
          description: Описание фотографии
          example: Кузов справа
          type: string
        url:
          description: Ссылка на фото
          example: http://s32.gcdn.co/?file=201703102F1799506
          type: string
      required:
      - url
      - name
      type: object
    CarsharingDataEventAutoteka:
      description: Информация об использовании ТС в каршеринге
      properties:
        company:
          description: Компания эксплуатант ТС
          example: OOO Вектор
          type: string
        inaccurateData:
          description: Автомобиль мог не использоваться в каршеринге. Такое возможно, если компания оказывает услуги лизинга помимо каршеринга.
          example: false
   

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