Документация Auction API

Обзор

Auction API содержит информацию об объявлениях о транспорте, которые сейчас доступны через включенные источники данных. Данные включают характеристики автомобиля, цены, сведения о продавце, локацию, изображения, URL объявления и аукционные поля, когда они доступны.

Ваш API key выдается отдельно и должен передаваться как api_key GET-параметр на каждом endpoint.

Покрытие

Активные объявления о транспорте доступны в рамках вашей подписки и ограничены включенными источниками данных.

Доставка

Данные передаются через Elasticsearch scroll-запросы, оптимизированные для пакетной обработки больших наборов данных.

Синхронизация

Stream endpoint возвращает только текущие активные, не архивные автомобили.

Контроль доступа

Каждый запрос проверяется по API key, активной подписке, включенным источникам данных и IP whitelist, если он включен.

HTTP запрос

Endpoint

запросGET

поток cars

GEThttps://api.auctionsapi.com/cars?api_key=YOUR_API_KEY

Пример — Laravel / HTTP Client

Платформа:

Клиент:

SyncCars.php

1use Illuminate\Support\Facades\Http;2 3$response = Http::acceptJson()4    ->timeout(60)5    ->get('https://api.auctionsapi.com/cars', [6        'api_key' => 'YOUR_API_KEY',7    ]);8 9return $response->json();

API endpoints

GET/carsШаг 1

Старт синхронизации

Начать синхронизацию

api_keylimitscroll_time

https://api.auctionsapi.com/cars?api_key=YOUR_API_KEY&limit=1000&scroll_time=10

GET/carsШаг 2

Продолжение

Продолжить синхронизацию

api_keyscroll_id

https://api.auctionsapi.com/cars?api_key=YOUR_API_KEY&scroll_id=SCROLL_ID

GET/search

Поиск

Поиск по ключевому слову

api_keyquerypageperPagesort

https://api.auctionsapi.com/search?api_key=YOUR_API_KEY&query=toyota&page=1&perPage=20&sort=newest

GET/search

Поиск

Поиск с фильтрами

priceyearenumsbrands

https://api.auctionsapi.com/search?api_key=YOUR_API_KEY&price_from=5000&price_to=15000&currency_id=1&year_from=2015&year_to=2020&body_types[]=5&fuels[]=1&colors[]=13&transmission=1&drive_wheels[]=3&brands[0][id]=10&brands[0][models][]=101

GET/brands

Справочник

Бренды

api_key

https://api.auctionsapi.com/brands?api_key=YOUR_API_KEY

GET/models/{brand_id}

Справочник

Модели

brand_idapi_key

https://api.auctionsapi.com/models/58?api_key=YOUR_API_KEY

Сценарий пагинации

Начните с /cars без scroll_id.
Ответ содержит scroll_id и next_url.
Если next_url не пустой, запрашивайте его до тех пор, пока он не станет пустым или API не вернет больше данных.
Если автомобиль не возвращался за последние 24 часа, пометьте его как архивный или удалите из базы.

GET параметры

Параметр	Endpoint	Тип	По умолчанию / лимиты	Описание
`api_key`	`Все endpoints`	`string`	По умолчанию: -	Ваш уникальный API key. Должен передаваться как GET-параметр.
`scroll_time`	`/cars`	`int`	По умолчанию: 10 Лимиты: Макс.: 15 минут	Длительность scroll-сессии.
`limit`	`/cars`	`int`	По умолчанию: 1000 Лимиты: Макс.: 2000	Количество автомобилей в одном пакете.
`scroll_id`	`/cars`	`string`	По умолчанию: -	Используйте для получения следующего пакета данных.
`page`	`/search`	`int`	По умолчанию: 1 Лимиты: Мин.: 1	Номер страницы.
`perPage`	`/search`	`int`	По умолчанию: 50 Лимиты: Мин.: 2, Макс.: 50	Элементов на страницу.
`sort`	`/search`	`string`	По умолчанию: newest Лимиты: См. варианты сортировки	Порядок сортировки.
`query`	`/search`	`string`	По умолчанию: - Лимиты: Макс. длина: 200	Полнотекстовый поисковый запрос.
`price_from`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 0	Минимальная цена включительно.
`price_to`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 1	Максимальная цена включительно.
`currency_id`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 1	Валюта для фильтра цены. Игнорируется, если диапазон цены не задан.
`year_from`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 1800, Макс.: 3000	Год модели от, включительно.
`year_to`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 1800, Макс.: 3000	Год модели до, включительно.
`odometer_from`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 0, Макс.: 999999999	Пробег от, включительно.
`odometer_to`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 0, Макс.: 999999999	Пробег до, включительно.
`engine_volume_from`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 0, Макс.: 999999999	Объем двигателя от, включительно.
`engine_volume_to`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 0, Макс.: 999999999	Объем двигателя до, включительно.
`power_hp_from`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 0, Макс.: 100000	Мощность от, включительно.
`power_hp_to`	`/search`	`int`	По умолчанию: - Лимиты: Мин.: 1, Макс.: 100000	Мощность до, включительно.
`brands`	`/search`	`array<object>`	По умолчанию: - Лимиты: id, optional models[]	Фильтр бренда. Если модели не указаны, подходит любая модель выбранного бренда.
`body_types`	`/search`	`int[]`	По умолчанию: - Лимиты: См. enum	ID типов кузова.
`colors`	`/search`	`int[]`	По умолчанию: - Лимиты: См. enum	ID цветов.
`fuels`	`/search`	`int[]`	По умолчанию: - Лимиты: См. enum	ID топлива.
`seller_type`	`/search`	`int`	По умолчанию: - Лимиты: См. enum	ID типа продавца.
`steering_wheel_position`	`/search`	`int`	По умолчанию: - Лимиты: См. enum	ID положения руля.
`transmission`	`/search`	`int`	По умолчанию: - Лимиты: См. enum	ID коробки передач.
`airbags`	`/search`	`int`	По умолчанию: - Лимиты: См. enum	ID состояния подушек безопасности.
`damages`	`/search`	`int[]`	По умолчанию: - Лимиты: См. enum	ID повреждений.
`conditions`	`/search`	`int[]`	По умолчанию: - Лимиты: См. enum	ID состояний.
`availabilities`	`/search`	`int[]`	По умолчанию: - Лимиты: См. enum	ID наличия.
`emissions`	`/search`	`int[]`	По умолчанию: - Лимиты: См. enum	ID экологического стандарта.
`drive_wheels`	`/search`	`int[]`	По умолчанию: - Лимиты: См. enum	ID привода.
`keys_available`	`/search`	`boolean`	По умолчанию: - Лимиты: true/false или 1/0	Фильтр по наличию ключей.
`brand_id`	`/models/{brand_id}`	`int`	По умолчанию: - Лимиты: Path parameter	Brand ID для возврата моделей конкретного бренда.

Варианты сортировки

Значение	Описание
`newest`	Сначала новые объявления.
`oldest`	Сначала старые объявления.
`cheaper`	Сначала самая низкая цена.
`expensive`	Сначала самая высокая цена.
`odometer_asc`	Сначала минимальный пробег.
`odometer_desc`	Сначала максимальный пробег.
`year_asc`	Сначала самый старый год модели.
`year_desc`	Сначала самый новый год модели.
`auction_nearest`	Сначала ближайшая дата аукциона.

Массивы и вложенные параметры

Простые массивыcolors[]=13&colors[]=15&fuels[]=1&fuels[]=4

Бренды и моделиbrands[0][id]=10&brands[0][models][]=101&brands[0][models][]=102&brands[1][id]=12

Если модели не указаны, фильтр соответствует любой модели выбранного бренда. Для пагинации поиска page * perPage должно быть меньше или равно 10000.

Enum значения

Используйте numeric ID в query-параметрах. Например, colors[]=13 означает белый цвет, а transmission=1 означает автоматическую коробку.

Типы кузова

body_types

1Седан2Универсал3Купе4Пикап5SUV6Кабриолет7Фургон11Хэтчбек12Родстер13Лимузин20Лифтбек22Катафалк27Спорткар

Цвета

colors

1Серебристый2Фиолетовый3Оранжевый4Зеленый5Красный6Золотой8Коричневый9Серый10Бирюзовый11Синий12Бронзовый13Белый14Кремовый15Черный16Желтый17Бежевый18Розовый100Два цвета

Топливо

fuels

1Дизель2Электро3Гибрид4Бензин5Газ6Flexible7Водород8Этанол

Тип продавца

seller_type

1Частное лицо2Дилер

Положение руля

steering_wheel_position

1Левый2Правый

Коробка передач

transmission

1Автомат2Механика

Подушки безопасности

airbags

1Целые2Сработали3Отсутствуют

Повреждения

damages

1Бок2Кража3Пожар4Электро5Вандализм6Вода7Крыша8Transmission9Подвеска10Биологическая опасность11Утилизационная программа12Изъятие13Переворот14По всему кузову15Двигатель16Рама17Перед18Зад19Перед и зад20Град21Механика22Небольшие вмятины/царапины23VIN24Обычный износ25Отклоненный или частичный ремонт26Шторм27Разукомплектован28Днище

Состояния

conditions

1Б/у2Новый3Поврежденный

Наличие

availabilities

1В наличии2В пути3Под заказ

Экостандарты

emissions

1Euro 12Euro 23Euro 34Euro 45Euro 56Euro 67Zev

Привод

drive_wheels

1Зад2Перед3Полный

JSON ответ

Ответ включает нормализованную информацию об автомобиле, данные объявления, изображения, цену, локацию, тип продавца, состояние, аукционные поля и данные пагинации для продолжения потока.

Поля ответа

Параметр	Описание
`data`	Массив нормализованных записей автомобилей по вашей подписке или пустой массив, когда данных в потоке больше нет.
`id`	Внутренний идентификатор автомобиля AuctionsAPI.
`brand / model`	Нормализованные объекты марки и модели с ID и названиями.
`engine_volume`	Объем двигателя, если доступен.
`body_type / transmission / fuel / color`	Нормализованные enum-объекты с ID и названием.
`listings`	Записи объявлений источника с URL объявления, заголовком, ценой, типом продавца, изображениями, датами и статусом.
`external`	Оригинальный идентификатор объявления, placeholder домена источника и URL объявления.
`price`	Цена объявления, валюта, флаг торга и опциональная история цены.
`location`	Метаданные локации объявления и координаты, если доступны.
`condition / damage / auction fields`	Состояние, дата аукциона, ставка, ключи, повреждения, состояние подушек и документы, если доступны.
`scroll_id`	Токен пагинации, возвращаемый stream endpoint, когда доступны следующие пакеты.
`next_url`	Готовый URL для следующего пакета. Остановитесь, когда он пустой или данных больше нет.
`hash`	Стабильный hash нормализованных данных автомобиля.
`message`	Возвращается stream endpoint, когда данных больше нет.

Ответ200 OK

application/json

1{2  "data": [3    {4      "id": "0z2OgJ0B0FUJVEfmXKRZ",5      "year": 2022,6      "vin": "wba5p9c02nfm40627",7      "brand": {8        "id": 16,9        "name": "BMW"10      },11      "model": {12        "id": 93,13        "name": "3er"14      },15      "body_type": {16        "name": "sedan",17        "id": 118      },19      "transmission": {20        "name": "automatic",21        "id": 122      },23      "transmission_steps": 5,24      "fuel": {25        "name": "gasoline",26        "id": 427      },28      "color": {29        "name": "grey",30        "id": 931      },32      "market_origin": {33        "name": "europe",34        "id": 135      },36      "drive_wheels": {37        "name": "all",38        "id": 339      },40      "badge": "330e xDrive Plug-In Hybrid - Leather - Sunroof !!",41      "listings": [42        {43          "external": {44            "id": "EXTERNAL_LISTING_ID",45            "domain": {46              "id": 1000,47              "name": "{domain.com}"48            },49            "url": "https://{domain.com}/vehicle-listing/example"50          },51          "archived": false,52          "title": {53            "en": "2022 BMW 3 Series 330e xDrive Plug-In Hybrid - Leather - Sunroof !!"54          },55          "odometer": 39650,56          "location": {57            "iso": "ca",58            "position": {59              "lon": -113.64258,60              "lat": 60.1086761            }62          },63          "images": [64            {65              "preview": "https://{image-domain.com}/vehicles/example-1-preview.jpg",66              "original": "https://{image-domain.com}/vehicles/example-1.jpg"67            },68            {69              "preview": "https://{image-domain.com}/vehicles/example-2-preview.jpg",70              "original": "https://{image-domain.com}/vehicles/example-2.jpg"71            },72            {73              "preview": "https://{image-domain.com}/vehicles/example-3-preview.jpg",74              "original": "https://{image-domain.com}/vehicles/example-3.jpg"75            },76            {77              "preview": "https://{image-domain.com}/vehicles/example-4-preview.jpg",78              "original": "https://{image-domain.com}/vehicles/example-4.jpg"79            },80            {81              "preview": "https://{image-domain.com}/vehicles/example-5-preview.jpg",82              "original": "https://{image-domain.com}/vehicles/example-5.jpg"83            }84          ],85          "video": null,86          "created_at": "2026-04-12T07:18:25.915404Z",87          "last_seen_at": "2026-04-29T07:59:47.901334Z",88          "updated_at": "2026-04-29T07:59:47.901337Z",89          "price": {90            "price": 30888,91            "currency": {92              "id": 28,93              "name": "cad"94            },95            "negotiable": false,96            "history": null97          },98          "seller_type": {99            "name": "dealer",100            "id": 2101          },102          "is_auction": false,103          "current_bid": null,104          "auction_at": null,105          "availability": null,106          "condition": {107            "name": "used",108            "id": 1109          },110          "keys_available": null,111          "damage": null,112          "second_damage": null,113          "airbag_state": null,114          "document_id": null,115          "description": "Sample 2022 BMW 330e xDrive Plug-In Hybrid listing with leather, sunroof, navigation, reverse camera, heated seats, and driver assistance features."116        }117      ],118      "hash": "60b52121bedf682865247f58ac068d217d2bc7d4dc3db88d2f7856b0dfa6e79e"119    }120  ],121  "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAx...",122  "next_url": "https://api.auctionsapi.com/cars?scroll_id=DXF1ZX...&api_key=YOUR_API_KEY"123}

Больше данных в потоке нет

Ответ200 OK

application/json

1{2  "scroll_id": null,3  "data": [],4  "message": "No more data"5}

Ответ со списком брендов

Ответ200 OK

application/json

1[2  {3    "id": 9,4    "name": "Audi"5  },6  {7    "id": 13,8    "name": "Bentley"9  },10  {11    "id": 16,12    "name": "BMW"13  },14  {15    "id": 88,16    "name": "Mercedes-Benz"17  },18  {19    "id": 110,20    "name": "Porsche"21  }22]

Ответ со списком моделей

Ответ200 OK

application/json

1[2  {3        "id": 1665,4        "name": "X5",5        "generations": [6            {7                "name": "III (F15)",8                "from": 2013,9                "to": 201810            },11            {12                "name": "IV (G05)",13                "from": 2018,14                "to": 202215            },16            ...17        ]18    },19  {20    "id": 102,21    "name": "X6",22    "generations": []23  }24]

Ответы с ошибками

error

Когда возникает ошибка, API возвращает статус ошибки с кодом и сообщением.

Код	Описание	Решение
`400`	scroll_time должен быть меньше 15.	Используйте scroll_time до 15 минут.
`400`	limit должен быть меньше 2000.	Используйте limit до 2000 автомобилей на пакет.
`403`	добавьте api_key в GET-параметр.	Добавьте api_key как GET-параметр.
`403`	неверный api key.	Проверьте, что API key действителен.
`403`	ваша API подписка не активна.	Активируйте или продлите подписку.
`403`	IP-адрес не находится в whitelist.	Отправьте запрос с разрешенного IP или обновите whitelist.
`403`	в вашей подписке нет данных.	Убедитесь, что источники данных включены для подписки.
`422`	page * perPage превышает 10000 для поиска, API возвращает offset error.	Уменьшите page или perPage, чтобы offset оставался в пределах 10000.
`500`	Неожиданная ошибка сервера.	Повторите запрос или обратитесь в поддержку, если проблема сохраняется.

Auction APIДокументация

Обзор

Покрытие

Доставка

Синхронизация

Контроль доступа

HTTP запрос

Начать синхронизацию

Продолжить синхронизацию

Поиск по ключевому слову

Поиск с фильтрами

Бренды

Модели

GET параметры

Типы кузова

Цвета

Топливо

Тип продавца

Положение руля

Коробка передач

Подушки безопасности

Повреждения

Состояния

Наличие

Экостандарты

Привод

JSON ответ

Ответы с ошибками