Підключити ключ
GET/searchАвтомобілі

Пошук автомобілів

Фільтруйте активні автомобілі в увімкнених джерелах. Результати легкі: кожен автомобіль містить прапорці звітів, а не тіла звітів.

  • vehicle_type=automobile / 1 — типово; motorcycle / 2 вибирає мотоцикли в /search, /search/count і /cars. У довідниках використовуйте той самий тип.
  • Повна вкладеність: brands[] → models[] → generations[] → variants[] / trims[]. У кожного об’єкта бренду, моделі й покоління обов’язковий id. Між сусідами та значеннями variants/trims — АБО; між умовами однієї гілки — І. Відсутній або порожній дочірній список означає будь-яких нащадків. До 100 елементів у масиві. Невідомі або несумісні ID дають порожній результат; неправильний формат — 422.
  • Попередній brands[0][models][]=573 працює. Для нащадків використовуйте brands[0][models][0][id]=573. Приберіть попереднє поле додавання ID перед об’єктами моделей цього бренду, інакше PHP перезапише індекс 0.
  • is_auction приймає true/false/1/0. False включає false, null і відсутній прапорець; без параметра фільтр вимкнено. Має збігатися з is_leasing в одному активному оголошенні доступного домену; інші оголошення можуть залишитися в listings[].
  • perPage — від 2 до 50 (за замовчуванням 50). perPage=1 повертає 422.
  • page × perPage має бути не більше 10,000. Щоб читати далі, використовуйте /cars.
  • data може містити perPage + 1 автомобілів, а meta.total обмежується 10,000. Для точних підсумків використовуйте /search/count.
  • sort=auction_nearest вибирає машини з майбутнім аукціоном: auction_at >= now в активному оголошенні вибраного домену. Передайте той самий sort до /search/count.
  • Сортування за ціною (cheaper, expensive) порівнює ціни у валюті currency.
  • Використовуйте price для Buy Now, current_bid для поточної ставки, а /listing-fields — для доступних додаткових сум. Грошові порівняння потребують вихідну валюту всередині кожної умови custom-field; суми джерела не перераховуються.

Параметри запиту

48
Запит, сторінки та охоплення
vinstring1–19 chars

Частковий VIN без урахування регістру. Для точного VIN довжиною 16–19 символів використовуйте /cars/vin/{vin}.

pageinteger≥ 1 · default 1

Номер сторінки. Для /search явно передавайте perPage і дотримуйтеся page × perPage ≤ 10000. /search/count ігнорує пагінацію і пропускає цю перевірку зсуву.

perPageinteger2–50 · default 50

Розмір сторінки пошуку: мінімум 2, максимум 50. perPage=1 повертає 422; щоб отримати невелику вибірку, використовуйте perPage=2. Якщо значення пагінації не передано або вони null, використовуються page=1 і perPage=50, зокрема й для перевірки вікна результатів пошуку. Недійсні значення повертають 422.

sortstring

Sort order. Price sorting requires a resolved currency. auction_nearest selects only cars with an active listing in an enabled/selected domain with auction_at >= now; past dates do not participate in sorting. Pass the same sort to /search/count for a matching count.

currencystring3 chars · default usd

Код валюти без урахування регістру для фільтрації/сортування за ціною. Має існувати в довіднику валют. Не конвертує ціни оголошень у відповіді.

currency_idinteger≥ 1

Необов'язковий внутрішній ID валюти; має пріоритет над currency.

domains[]integer[]≥ 1

Необов'язковий набір джерел. Використовуйте ID, які повертає GET /domains. Не передавайте, щоб використати всі увімкнені домени. Повторюйте параметр із квадратними дужками: domains[]=33&domains[]=34. Кожен ID має бути ввімкнений для цього ключа.

vehicle_typestringdefault automobile

vehicle_type=automobile / 1 — типово; motorcycle / 2 вибирає мотоцикли в /search, /search/count і /cars. У довідниках використовуйте той самий тип.

langstring

Локаль відповіді. Переклади опцій також обмежено мовами акаунта. Сторінка автоматично обирає поточну мову.

Марка, модель і локація
brands[0][id]integer≥ 1

Повна вкладеність: brands[] → models[] → generations[] → variants[] / trims[]. У кожного об’єкта бренду, моделі й покоління обов’язковий id. Між сусідами та значеннями variants/trims — АБО; між умовами однієї гілки — І. Відсутній або порожній дочірній список означає будь-яких нащадків. До 100 елементів у масиві. Невідомі або несумісні ID дають порожній результат; неправильний формат — 422.

brands[0][models][]integer[]≥ 1 · ≤ 100 items

Попередній brands[0][models][]=573 працює. Для нащадків використовуйте brands[0][models][0][id]=573. Приберіть попереднє поле додавання ID перед об’єктами моделей цього бренду, інакше PHP перезапише індекс 0.

brands[0][models][0][id]integer≥ 1

Повна вкладеність: brands[] → models[] → generations[] → variants[] / trims[]. У кожного об’єкта бренду, моделі й покоління обов’язковий id. Між сусідами та значеннями variants/trims — АБО; між умовами однієї гілки — І. Відсутній або порожній дочірній список означає будь-яких нащадків. До 100 елементів у масиві. Невідомі або несумісні ID дають порожній результат; неправильний формат — 422.

brands[0][models][0][generations][0][id]integer≥ 1

Повна вкладеність: brands[] → models[] → generations[] → variants[] / trims[]. У кожного об’єкта бренду, моделі й покоління обов’язковий id. Між сусідами та значеннями variants/trims — АБО; між умовами однієї гілки — І. Відсутній або порожній дочірній список означає будь-яких нащадків. До 100 елементів у масиві. Невідомі або несумісні ID дають порожній результат; неправильний формат — 422.

brands[0][models][0][generations][0][variants][]integer[]≥ 1 · ≤ 100 items

Повна вкладеність: brands[] → models[] → generations[] → variants[] / trims[]. У кожного об’єкта бренду, моделі й покоління обов’язковий id. Між сусідами та значеннями variants/trims — АБО; між умовами однієї гілки — І. Відсутній або порожній дочірній список означає будь-яких нащадків. До 100 елементів у масиві. Невідомі або несумісні ID дають порожній результат; неправильний формат — 422.

brands[0][models][0][generations][0][trims][]integer[]≥ 1 · ≤ 100 items

Повна вкладеність: brands[] → models[] → generations[] → variants[] / trims[]. У кожного об’єкта бренду, моделі й покоління обов’язковий id. Між сусідами та значеннями variants/trims — АБО; між умовами однієї гілки — І. Відсутній або порожній дочірній список означає будь-яких нащадків. До 100 елементів у масиві. Невідомі або несумісні ID дають порожній результат; неправильний формат — 422.

countries[0][id]integer

Внутрішній ID першої країни з /countries. Додаткові країни передаються через countries[1][id] тощо.

countries[0][regions][]integer[]

Необов'язкові внутрішні ID регіонів, що належать першій країні.

Діапазони
seatsinteger1–200

Точна кількість місць.

price_fromint64≥ 0

Мінімальна ціна оголошення в обраній валюті. Максимум 9223372036854775807 (64-бітне ціле зі знаком); значення, що перевищують безпечні цілі числа JavaScript, клієнти мають зберігати як десятковий текст.

price_toint64≥ 1

Максимальна ціна оголошення в обраній валюті. Максимум 9223372036854775807 (64-бітне ціле зі знаком); значення, що перевищують безпечні цілі числа JavaScript, клієнти мають зберігати як десятковий текст.

year_frominteger1,800–3,000

Мінімальний рік випуску.

year_tointeger1,800–3,000

Максимальний рік випуску.

odometer_frominteger0–999,999,999

Мінімальний пробіг у кілометрах.

odometer_tointeger0–999,999,999

Максимальний пробіг у кілометрах.

engine_volume_frominteger0–999,999,999

Мінімальний об'єм двигуна.

engine_volume_tointeger0–999,999,999

Максимальний об'єм двигуна.

power_hp_frominteger0–100,000

Мінімальна потужність у кінських силах.

power_hp_tointeger1–100,000

Максимальна потужність у кінських силах.

Прапорці
is_leasingboolean

Необов'язковий фільтр лізингу. Надсилайте true (або 1) для оголошень, явно позначених is_leasing=true. Надсилайте false (або 0), щоб виключити true, включно зі збереженими false, null і відсутніми полями. Не передавайте, щоб не фільтрувати за лізингом; порожні або недійсні значення повертають 422. Автомобіль повинен мати принаймні одне відповідне активне оголошення в межах увімкнених/обраних доменів. Інші оголошення можуть залишатися у відповіді, тож автомобілі зі змішаними типами оголошень можуть відповідати обом значенням. Для /cars задайте його в першому запиті й переходьте за next_url без змін; false зберігається. Продовження лише зі scroll_id зберігає фільтр. Зміна або додавання фільтра посеред прокручування повертає 422. Якщо кешований стан фільтра втрачено або прокручування почалося до появи цього параметра, явне значення повертає 422; почніть нове прокручування.

is_auctionboolean

Optional auction filter. Send true (or 1) for listings explicitly marked is_auction=true. Send false (or 0) to exclude true, including stored false, null and missing fields. Omit for no auction filter; empty or invalid values return 422. Combined is_auction and is_leasing must match the same listing. A car must have at least one matching active listing in the enabled/selected domain scope. Other listings can remain in the response, so cars with mixed listing types can match both values. For /cars, set this on the first request and follow next_url unchanged; false is preserved. Continuing with only scroll_id retains the filter. Changing or adding the filter mid-scroll returns 422. If cached filter state is lost or the scroll predates this parameter, an explicit value returns 422; start a new scroll.

keys_availableinteger

Оголошення має ключі. Надсилайте 1 (true) або 0 (false). Не передавайте, щоб прийняти будь-яке значення; рядки "true"/"false" не приймаються.

is_manufacturer_certifiedinteger

Оголошення сертифіковано виробником або офіційною дилерською програмою. Надсилайте 1 (true) або 0 (false). Не передавайте, щоб прийняти будь-яке значення; рядки "true"/"false" не приймаються.

has_inspectionsinteger

Кореневий автомобіль має публічний огляд. Надсилайте 1 (true) або 0 (false). Не передавайте, щоб прийняти будь-яке значення; рядки "true"/"false" не приймаються.

has_history_reportsinteger

Оголошення в обраному наборі доменів має публічний звіт про історію. Надсилайте 1 (true) або 0 (false). Не передавайте, щоб прийняти будь-яке значення; рядки "true"/"false" не приймаються.

Категорії
body_types[]integer[]

Repeat to match any of the values.

colors[]integer[]

Repeat to match any of the values.

fuels[]integer[]

Repeat to match any of the values.

transmissioninteger

One value.

seller_typeinteger

One value.

steering_wheel_positioninteger

One value.

airbagsinteger

One value.

damages[]integer[]

Repeat to match any of the values.

conditions[]integer[]

Repeat to match any of the values.

availabilities[]integer[]

Repeat to match any of the values.

emissions[]integer[]

Repeat to match any of the values.

drive_wheels[]integer[]

Repeat to match any of the values.

interior_colors[]integer[]≤ 100 items

ID кольорів салону з довідника кольорів. Усередині списку діє АБО; відсутні значення не збігаються. Застосовується в /search, /search/count і /cars. Не змінюйте під час продовження scroll.

cylinders[]integer[]1–99 · ≤ 99 items

Точна кількість циліндрів (1–99), АБО всередині списку; невідомі значення не збігаються. Застосовується в /search, /search/count і /cars. Не змінюйте під час продовження scroll.

Додаткові поля оголошень

Завантажте /listing-fields після перевірки ключа. Визначення, обмеження, оператори й пояснення джерел стосуються лише цього ключа та вибраних доменів.

Рядки: eq, in, exists. Числа й дати також gt, gte, lt, lte. Boolean: eq або exists. Використовуйте eq, in, exists чи діапазон; exists окремо. До 20 полів і 100 значень у in.

Усі умови, вибрані домени й активність мають збігтися в одному оголошенні. Нуль і false є значеннями. Масив збігається за відповідним елементом. Невідомі або недоступні поля/оператори повертають 422.

Фільтрація лише для filterable. Індексовані значення: listings[].custom_fields; решта: listings[].source_data. Публікація вмикає фільтри, наступні звичайні імпорти заповнюють значення. Старі документи окремо не оновлюються.

У /cars умови зберігаються на весь scroll. Несумісне визначення чи втрачене збережене налаштування потребують нового scroll. Сортування й агрегації не підтримуються.

Замініть FIELD_KEY ключем доступного каталогу. Для грошових порівнянь також задайте валюту оголошення; конвертація Buy Now тут не застосовується.

Історичні ринкові оцінки джерела — довідкові неіндексовані значення. Вони описують порівнювані продажі, а не ціну, ставку або резерв цього оголошення. Перевіряйте опис поля, критерії порівняння та дату розрахунку; валюту оголошення підставляти не можна. Зареєстровані числові поля можуть бути null, якщо оцінки немає.

custom_fields[FIELD_KEY][gte]=2
custom_fields[FIELD_KEY][in][]=a&custom_fields[FIELD_KEY][in][]=b
custom_fields[FIELD_KEY][eq]=false
custom_fields[FIELD_KEY][lte]=15000&custom_fields[FIELD_KEY][currency]=cad

Додаткові поля оголошень

Підключіть ключ, щоб побачити поля доступних доменів.

Повертає · Сторінка об'єктів Car у data із links і meta. Масиви inspections і vehicle_history_reports пропускаються.
GET/search
curl -g "https://api.auctionsapi.com/search?perPage=5&api_key=$CARS_API_KEY" \
  -H "Accept: application/json"
ПрикладиЗаписано
{3 keys
"data": [1 item
0: {21 keys
"id": "l_eCJb-8zB_XcJ-z6Y7oZWjw"
"has_inspections": true
"has_history_reports": true
"year": 2014
"month": 4
"vin": "wddhf0cb3ea952710"
"brand": {2 keys}
"model": {2 keys}
"engine_volume": 2143
"seats": 5
"body_type": {2 keys}
"transmission": {2 keys}
"transmission_steps": 6
"fuel": {2 keys}
"color": {2 keys}
"power_hp": 170
"market_origin": {2 keys}
"badge": "E220 CDI Avantgarde"
"option_ids": [53 items]
"listings": [1 item]
"hash": "093563801f92d9cfa23a07346b26b69db32df8da05d7c5ee60fa5fd876a7fe0b"
}
]
"links": {4 keys}
"meta": {7 keys}
}

Отримайте доступ до API

Підключіть ключ, щоб виконувати будь-який запит із цих сторінок на своїх даних. Ключа ще немає? Попросіть у нас демо-ключ: той самий JSON, що й у платних планах.

У мене є ключ