Документація 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 для search, API повертає offset error.	Зменште page або perPage, щоб offset залишався в межах 10000.
`500`	Неочікувана помилка сервера.	Повторіть запит або зверніться до підтримки, якщо проблема не зникає.

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

Огляд

Покриття

Доставка

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

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

HTTP запит

Почати синхронізацію

Продовжити синхронізацію

Пошук за ключовим словом

Пошук із фільтрами

Бренди

Моделі

GET параметри

Типи кузова

Кольори

Паливо

Тип продавця

Положення керма

Трансмісія

Подушки безпеки

Пошкодження

Стани

Доступність

Викиди

Привід

JSON відповідь

Відповіді з помилками