Подключить ключ
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, что и в платных тарифах.

У меня есть ключ