Підключити ключ
GET/carsЕкспорт

Експорт автомобілів через курсор

Отримуйте потоком усі активні автомобілі ваших джерел із повними звітами через серверний курсор. Призначено для синхронізації локальної копії.

  • vehicle_type=automobile / 1 — типово; motorcycle / 2 вибирає мотоцикли в /search, /search/count і /cars. У довідниках використовуйте той самий тип.
  • Повна вкладеність: brands[] → models[] → generations[] → variants[] / trims[]. У кожного об’єкта бренду, моделі й покоління обов’язковий id. Між сусідами та значеннями variants/trims — АБО; між умовами однієї гілки — І. Відсутній або порожній дочірній список означає будь-яких нащадків. До 100 елементів у масиві. Невідомі або несумісні ID дають порожній результат; неправильний формат — 422.
  • У /cars тип і вся ієрархія фіксуються на час прокрутки. Дотримуйтеся next_url без змін або передавайте лише scroll_id. Порядок еквівалентних фільтрів можна змінити; нові умови або явні фільтри без збереженого стану дають 422. Почніть нову прокрутку. Старі курсори без нових параметрів зберігають попередній запит.
  • is_auction приймає true/false/1/0. False включає false, null і відсутній прапорець; без параметра фільтр вимкнено. Має збігатися з is_leasing в одному активному оголошенні доступного домену; інші оголошення можуть залишитися в listings[].
  • Задайте is_auction у першому запиті: next_url і scroll_id зберігають значення, включно з false. Зміна фільтра або явне значення без збереженого стану повертає 422.
  • Почніть без scroll_id, потім запитуйте кожен next_url без змін, доки scroll_id не стане null. Див. посібник із синхронізації.
  • limit — від 1 до 500 (за замовчуванням 500). scroll_time — від 1 до 15 хвилин (за замовчуванням 10).
  • Не змінюйте domains[] і is_leasing протягом усього проходу. Їх зміна повертає 422.
  • total може бути null, якщо його запис у кеші втрачено.

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

16
limitinteger1–500 · default 500

Кількість елементів у пакеті. За замовчуванням 500; максимум 500. Для робочого експорту потрібні додатні значення.

scroll_timeinteger1–15 · default 10

Термін дії курсора в хвилинах. За замовчуванням 10, максимум 15.

scroll_idstring

Непрозорий курсор із попередньої відповіді. Краще переходити за next_url.

domains[]integer[]≥ 1

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

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.

vehicle_typestringdefault automobile

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

interior_colors[]integer[]≤ 100 items

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

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

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

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.

langstring

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

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

Завантажте /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 із next_url, scroll_id і total. Остання сторінка має scroll_id: null, порожній data і message: "No more data".
GET/cars
curl -g "https://api.auctionsapi.com/cars?limit=5&api_key=$CARS_API_KEY" \
  -H "Accept: application/json"
ПрикладиЗаписано
{4 keys
"data": [1 item
0: {20 keys
"id": "290nw54Bkl-iPxZqEe_N"
"has_inspections": false
"has_history_reports": false
"year": 2007
"vin": "kmhdu46d27u158653"
"brand": {2 keys}
"model": {2 keys}
"engine_volume": 2000
"cylinders": 4
"body_type": {2 keys}
"fuel": {2 keys}
"color": {2 keys}
"power_hp": 138
"market_origin": {2 keys}
"drive_wheels": {2 keys}
"option_ids": []
"listings": [1 item]
"inspections": []
"vehicle_history_reports": []
"hash": "473326c69c007f50506c0cffdf30b08cf28e978d9ff2d5e7dca0dc75a54a3f6c"
}
]
"next_url": "https://api.carstat.dev/cars?scroll_id=FGluY2x1ZGVfY29udGV4dF91…&lang=en&api_key=YOUR_API_KEY&limit=2"
"scroll_id": "FGluY2x1ZGVfY29udGV4dF91…"
"total": 3217391
}

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

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

У мене є ключ