Ръководство

Синтаксис на филтрите за търсене

Филтрите са параметри на заявката във формата с квадратни скоби на PHP. Едни и същи филтри работят в /search и /search/count; /cars приема domains[] и is_leasing.

ВидСинтаксис
Списък от IDfuels[]=2&fuels[]=3 — повтаряйте ключа; запетаите не се разделят
Марка + моделиbrands[0][id]=88&brands[0][models][]=573
Няколко маркиbrands[0][id]=88&brands[1][id]=13
Диапазонyear_from=2018&year_to=2022 — двата края са включени
Флагhas_inspections=1 — изпращайте 1 или 0; true връща 422
Лизингis_leasing=0 — съвпада и с обяви без флаг
Ценаprice_from=10000&currency=eur — филтрира в тази валута
Местоположениеcountries[0][id]=208&countries[0][regions][]=1841610
  • Категорийните филтри приемат числови ID. Всички ID ще намерите в Стойности на изброявания.
  • currency влияе само на филтрирането и сортирането по цена. Цените в обявите винаги се връщат в оригиналната им валута.
  • За точен VIN използвайте /cars/vin/{vin}. Филтърът vin в /search търси частично съвпадение.
  • Пропускайте филтрите, които не използвате. Празните стойности се валидират и може да върнат 422.

is_auction приема true, false, 1 или 0 за /search, /search/count и /cars. False включва false, null и липсващи полета. Пропуснете параметъра за търсене без филтър; празни или невалидни стойности връщат 422. is_auction и is_leasing трябва да съвпадат в една активна обява от достъпен/избран източник. Други обяви могат да останат в listings[]. За /cars задайте филтъра в първата заявка и следвайте next_url без промени. Добавяне или промяна по време на scroll, или явна стойност при липсващо състояние в кеша, връща 422. sort=auction_nearest изисква auction_at >= now; изпратете същия sort към /search/count.

Филтър по тип превозно средство и конфигурация

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.

vehicle_type=motorcycle&brands[0][id]=101&brands[0][models][0][id]=201&brands[0][models][0][generations][0][id]=301&brands[0][models][0][generations][0][variants][]=501&brands[0][models][0][generations][0][trims][]=401

ID са измислени: заменете ги със стойности от речниците. За конкретни двойки variant/trim използвайте отделни клонове на поколения.

Отговорите съдържат vehicle_type, generation_id, variant_id и trim_id; липсващите незадължителни ID са null. Полетата участват в hash. Търсят се само запазени ID на автомобила: без нормализиран ID няма съвпадение.

В /cars типът и цялата йерархия са фиксирани за курсора. Следвайте next_url без промени или подавайте само scroll_id. Редът на еквивалентни филтри може да се промени; нови условия или изрични филтри без кеширано състояние дават 422. Започнете нов курсор. Старите курсори без нови параметри запазват заявката си.

Допълнителни полета на обяви

Заредете /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

Допълнителни полета на обяви

Свържете ключ, за да видите полетата за достъпните домейни.

Търсене с филтри
curl -g "https://api.auctionsapi.com/search?brands[0][id]=88&brands[0][models][]=573&year_from=2018&fuels[]=1&fuels[]=3&price_to=30000&currency=eur&has_inspections=1&sort=newest&perPage=20&api_key=$CARS_API_KEY" \
  -H "Accept: application/json"

Вземете достъп до API

Свържете ключа си, за да изпълнявате всяка заявка от тези страници с вашите данни. Още нямате ключ? Поискайте ни демо ключ: същият JSON като в платените планове.

Имам ключ