Avito RisksAssessment 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 RisksAssessment API
  version: '1'
servers:
- url: https://api.avito.ru/
tags:
- name: RisksAssessment
  x-displayName: Оценка рисков
  x-subdivName: Оценка рисков
paths:
  /autoteka/v1/scoring/by-vehicle-id:
    post:
      description: 'Метод для запроса скоринга рисков по идентификатору авто (vin/frame). Возвращает идентификатор, по которому скоринг можно получить в [методе для получения скоринга рисков по его идентификатору](#operation/scoringGetById). При запросе происходит списание доступных проверок.


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

        '
      operationId: scoringByVehicleId
      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/CreateScoringResponseBodyAutoteka'
          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:
      - RisksAssessment
      x-trailing-slash: true
  /autoteka/v1/scoring/{scoring_id}:
    parameters:
    - $ref: '#/components/parameters/authHeader'
    - description: Идентификатор скоринга.
      in: path
      name: scoring_id
      required: true
      schema:
        minimum: 1
        type: integer
    get:
      description: 'Получение скоринга рисков по его идентификатору, полученному из [запроса на создание скоринга](#operation/scoringByVehicleId).


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

        '
      operationId: scoringGetById
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScoring'
          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:
      - RisksAssessment
      x-trailing-slash: true
components:
  schemas:
    GetScoringResult:
      properties:
        risksAssessment:
          $ref: '#/components/schemas/ScoringAutoteka'
      type: object
    tooManyRequestsError:
      properties:
        error:
          properties:
            code:
              description: Код ошибки
              example: 429
              format: int32
              type: integer
          required:
          - code
          type: object
      type: object
    ScoringAutoteka:
      properties:
        createdAt:
          description: Дата формирования отчета
          example: 1699882792
          format: int64
          type: integer
        data:
          $ref: '#/components/schemas/ScoringDataAutoteka'
        isCompleted:
          description: Признак, что формирование всех блоков скоринга завершено
          example: true
          type: boolean
        scoringId:
          description: Идентификатор скоринга, по которому его можно получить
          example: 1
          format: int64
          minimum: 1
          type: integer
      required:
      - scoringId
      - isCompleted
      - createdAt
      type: object
    ScoringIdResultAutoteka:
      properties:
        scoringId:
          description: Идентификатор скоринга, по которому его можно получить
          example: 1
          format: int64
          minimum: 1
          type: integer
      required:
      - scoringId
      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
    forbiddenError:
      properties:
        error:
          properties:
            code:
              description: Код ошибки
              example: 403
              format: int32
              type: integer
            message:
              description: Сообщение об ошибке
              example: Forbidden
              type: string
          required:
          - code
          - message
          type: object
      type: object
    ScoringNormalizedValue:
      description: Нормализованное значение
      nullable: true
      properties:
        value:
          type: string
        valueId:
          description: Идентификатор значения из каталога Авито
          minimum: 1
          nullable: true
          type: integer
      required:
      - value
      - valueId
      type: object
    ScoringTechSpecification:
      nullable: true
      properties:
        bodyNumber:
          nullable: true
          properties:
            gibddValue:
              description: Строковое значение
              type: string
          required:
          - gibddValue
          type: object
        brand:
          description: Бренд
          nullable: true
          properties:
            gibddValue:
              description: Текстовое значение
              example: BMW
              nullable: true
              type: string
            normalizedValue:
              $ref: '#/components/schemas/ScoringNormalizedValue'
          type: object
        chasisNumber:
          nullable: true
          properties:
            gibddValue:
              description: Строковое значение
              type: string
          required:
          - gibddValue
          type: object
        color:
          description: Цвет кузова
          nullable: true
          properties:
            gibddValue:
              description: Текстовое значение
              example: Синий
              type: string
          type: object
        engineNumber:
          nullable: true
          properties:
            gibddValue:
              description: Строковое значение
              type: string
          required:
          - gibddValue
          type: object
        engineType:
          description: Тип двигателя
          nullable: true
          properties:
            gibddValue:
              description: Текстовое значение
              example: Бензиновый
              nullable: true
              type: string
            normalizedValue:
              $ref: '#/components/schemas/ScoringNormalizedValue'
          type: object
        horsepower:
          description: Количество лошадиных сил
          nullable: true
          properties:
            gibddValue:
              description: Числовое значение
              example: 265
              format: int64
              nullable: true
              type: integer
            normalizedValue:
              $ref: '#/components/schemas/ScoringNormalizedValue'
          type: object
        maxWeight:
          description: Разрешенная максимальная масса
          nullable: true
          properties:
            gibddValue:
              description: Числовое значение
              example: 1645
              format: int64
              type: integer
          type: object
        model:
          description: Модель
          nullable: true
          properties:
            gibddValue:
              description: Текстовое значение
              example: Serie 1
              nullable: true
              type: string
            normalizedValue:
              $ref: '#/components/schemas/ScoringNormalizedValue'
          type: object
        netWeight:
          description: Масса без нагрузки
          nullable: true
          properties:
            gibddValue:
              description: Числовое значение
              example: 1245
              format: int64
              type: integer
          type: object
        vehicleCategory:
          description: Категория ТС
          nullable: true
          properties:
            gibddValue:
              description: Текстовое значение
              enum:
              - A
              - B
              - C
              - D
              - E
              - O
              - M1
              - M1G
              - N1
              example: D
              type: string
          type: object
        vehicleType:
          description: Тип ТС
          nullable: true
          properties:
            gibddValue:
              description: Текстовое значение
              enum:
              - Автобусы прочие
              - Грузовой бортовой
              - Грузовой прочий
              - Грузовой фургон
              - Грузовые автомобили бортовые
              - Грузовые автомобили фургоны
              - Легковое купе
              - Легковой прочий
              - Легковой седан
              - Легковой универсал
              - Легковой хэтчбек (комби)
              - Легковые автомобили кабриолет
              - Легковые автомобили комби (хэтчбек)
              - Легковые автомобили купе
              - Легковые автомобили прочие
              - Легковые автомобили седан
              - Легковые автомобили универсал
              - Мотоциклы
              nullable: true
              type: string
            normalizedValue:
              $ref: '#/components/schemas/ScoringNormalizedValue'
          type: object
        volume:
          description: Объем двигателя
          nullable: true
          properties:
            gibddValue:
              description: Числовое значение
              example: 2996
              format: int64
              nullable: true
              type: integer
            normalizedValue:
              $ref: '#/components/schemas/ScoringNormalizedValue'
          required:
          - gibddValue
          type: object
        year:
          description: Год выпуска
          nullable: true
          properties:
            gibddValue:
              description: Числовое значение
              example: 2008
              format: int64
              nullable: true
              type: integer
            normalizedValue:
              $ref: '#/components/schemas/ScoringNormalizedValue'
          required:
          - gibddValue
          type: object
      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
    CreateScoringResponseBodyAutoteka:
      properties:
        result:
          $ref: '#/components/schemas/CreateScoringResponseDataAutoteka'
      type: object
    CreateScoringResponseDataAutoteka:
      properties:
        scoring:
          $ref: '#/components/schemas/ScoringIdResultAutoteka'
      type: object
    notFoundError:
      properties:
        error:
          properties:
            code:
              description: Код ошибки
              example: 404
              format: int32
              type: integer
            message:
              description: Сообщение об ошибке
              example: Not found
              type: string
          required:
          - code
          - message
          type: object
      type: object
    ScoringSeriousDamage:
      description: Серьезные повреждения
      nullable: true
      properties:
        relevanceDate:
          description: Дата актуальности данных
          example: 1699882792
          format: int64
          type: integer
        salvageCarAuctions:
          description: Аукционы аварийных автомобилей
          nullable: true
          properties:
            auctionsCount:
              description: Количество аукционов
              example: 2
              format: int64
              type: integer
            lastAuctionDate:
              description: Дата последнего аукциона
              example: 1678599575
              format: int64
              type: integer
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
          required:
          - relevanceDate
          - auctionsCount
          - lastAuctionDate
          type: object
        value:
          description: Признак наличия серьезных повреждений
          example: true
          type: boolean
      required:
      - relevanceDate
      - value
      type: object
    ScoringDataAutoteka:
      description: Представление скоринга для партнерского API
      nullable: true
      properties:
        accidents:
          $ref: '#/components/schemas/ScoringAccidents'
        carsharing:
          description: Каршеринг
          nullable: true
          properties:
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
            value:
              description: Признак, что использовалось в каршеринге
              example: true
              type: boolean
          required:
          - relevanceDate
          - value
          type: object
        epts:
          description: ЭПТС
          nullable: true
          properties:
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
            status:
              description: Статус ЭПТС
              example: Действующий
              type: string
          required:
          - relevanceDate
          - status
          type: object
        import:
          description: Ввоз из-за рубежа
          nullable: true
          properties:
            company:
              description: Получатель
              example: ООО Авто
              nullable: true
              type: string
            fromCountry:
              description: Страна вывоза
              example: Япония
              nullable: true
              type: string
            importDate:
              description: Дата прохождения таможни
              example: 1641053779
              format: int64
              nullable: true
              type: integer
            ownerType:
              description: Тип получателя
              enum:
              - unknown
              - company
              - person
              example: company
              nullable: true
              type: string
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
            value:
              description: Признак, что авто было ввезено не новым
              example: true
              type: boolean
          required:
          - relevanceDate
          - value
          type: object
        leasing:
          description: Лизинг
          nullable: true
          properties:
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
            value:
              description: Признак, что авто находится в лизинге
              example: true
              type: boolean
          required:
          - relevanceDate
          - value
          type: object
        placements:
          $ref: '#/components/schemas/ScoringPlacements'
        pledges:
          description: Залоги
          nullable: true
          properties:
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
            value:
              description: Признак наличия залогов
              example: true
              type: boolean
          required:
          - relevanceDate
          - value
          type: object
        priceEvaluation:
          description: Оценка автомобиля
          nullable: true
          properties:
            avgMarketPrice:
              description: Средняя цена по рынку
              example: 950000
              nullable: true
              type: integer
            avgMileage:
              description: Средний пробег аналогов
              example: 50000
              nullable: true
              type: integer
            avgPriceWithCondition:
              description: Средняя цена с учетом состояния автомобиля
              example: 936000
              nullable: true
              type: integer
            avgYear:
              description: Средний год выпуска аналогов
              example: 2012.9999
              format: float
              nullable: true
              type: number
            imvUrl:
              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
            maxPrice:
              description: Максимальная граница цены похожих автомобилей по совершенным сделкам
              example: 1000000
              nullable: true
              type: integer
            minPrice:
              description: Минимальная граница цены похожих автомобилей по совершенным сделкам
              example: 800000
              nullable: true
              type: integer
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
          required:
          - relevanceDate
          type: object
        registrations:
          description: Регистрации авто
          nullable: true
          properties:
            isActual:
              description: Признак наличия действующей регистрации
              example: true
              type: boolean
            owners:
              description: Количество владельцев
              example: 3
              type: integer
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
          required:
          - relevanceDate
          - owners
          - isActual
          type: object
        restrictions:
          description: Ограничения
          nullable: true
          properties:
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
            value:
              description: Признак наличия ограничений на регистрационные действия
              example: true
              type: boolean
          required:
          - relevanceDate
          - value
          type: object
        seriousDamage:
          $ref: '#/components/schemas/ScoringSeriousDamage'
        stealing:
          description: Угоны
          nullable: true
          properties:
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
            value:
              description: Признак нахождения в угоне
              example: true
              type: boolean
          required:
          - relevanceDate
          - value
          type: object
        taxi:
          description: Такси
          nullable: true
          properties:
            isActual:
              description: Признак наличия действующего разрешения
              example: true
              type: boolean
            relevanceDate:
              description: Дата актуальности данных
              example: 1699882792
              format: int64
              type: integer
            value:
              description: Признак, что использовалось в такси
              example: true
              type: boolean
          required:
          - relevanceDate
          - value
          - isActual
          type: object
        techSpecification:
          $ref: '#/components/schemas/ScoringTechSpecification'
      type: object
    RequestReportByVehicleIdAutoteka:
      properties:
        vehicleId:
          description: Идентификатор запрашиваемого авто (vin/frame).
          minLength: 1
          type: string
      required:
      - vehicleId
      type: object
    ScoringAccidents:
      description: ДТП
      nullable: true
      properties:
        relevanceDate:
          description: Дата актуальности данных
          example: 1699882792
          format: int64
          type: integer
        value:
          description: Признак наличия ДТП
          example: true
          type: boolean
      required:
      - relevanceDate
      - value
      type: object
    GetScoring:
      properties:
        result:
          $ref: '#/components/schemas/GetScoringResult'
      type: object
    ScoringPlacements:
      description: Размещения объявлений
      nullable: true
      properties:
        isActive:
          description: Есть активное размещение
          example: true
          nullable: true
          type: boolean
        lastPlacementDate:
          description: Дата последнего размещения
          example: 1699882792
          format: int64
          nullable: true
          type: integer
        lastPlacementIsCrashed:
          description: Признак "Битый" в последнем размещении
          example: true
          nullable: true
          type: boolean
        lastPlacementPrice:
          description: Цена в последнем размещении
          example: 2500000
          format: int64
          nullable: true
          type: integer
        minPrice:
          description: Минимальная цена среди всех размещений
          example: 2100000
          format: int64
          nullable: true
          type: integer
        number:
          description: Общее количество размещений
          example: 3
          format: int64
          nullable: true
          type: integer
        placementsWithCrashesNumber:
          description: Количество размещений с меткой "Битый"
          example: 3
          format: int64
          nullable: true
          type: integer
        relevanceDate:
          description: Дата актуальности данных
          example: 1699882792
          format: int64
          type: integer
      required:
      - relevanceDate
      type: object
  headers:
    X-RateLimit-Limit:
      description: Количество запросов в минуту
      schema:
        format: int32
        type: integer
    X-RateLimit-Remaining:
      description: Доступное количество запросов в текущем временном окне
      schema:
        format: int32
        type: integer
  parameters:
    authHeader:
      description: Токен для авторизации
      example: Bearer ACCESS_TOKEN
      in: header
      name: Authorization
      schema:
        type: string
  securitySchemes:
    AuthorizationCode:
      description: Это API использует OAuth 2 с механизмом authorization_code. Используйте его для доступа к данным других пользователей при разработке стороннего приложения. [Подробнее](/api-catalog/auth/documentation#tag/ApplicationAccess)
      flows:
        authorizationCode:
          authorizationUrl: https://avito.ru/oauth
          scopes:
            ah:access: Взаимодействие с иерархией аккаунтов
          tokenUrl: https://api.avito.ru/token
      type: oauth2
    ClientCredentials:
      description: Это API использует OAuth 2 с механизмом client_credentials. Используйте его для доступа к возможностям своей личной учетной записи. [Подробнее](#tag/Access)
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://api.avito.ru/token
      type: oauth2