ImportOS · Документація
Довідник API

GET /v1/catalog/search

Search the EU used-car catalogue (natural language and/or filters)

Search the EU used-car catalogue (natural language and/or filters)

Searches the continuously crawled catalogue of European listings (deduplicated across sites, prices in EUR, landed cost in Ukraine without delivery, deal score). Pass text (natural language) and/or structured filters; structured filters override what was parsed from text. Returns cards, the executed query, how text was understood and a link to the same search on the tenant public site catalogue. Requires scope read:listings.

  • Автентифікація: заголовок Authorization: Bearer rv_live_... (API-ключі та scopes)
  • Потрібний scope: read:listings
Опис операції, параметрів і полів походить зі специфікації OpenAPI (openapi.json) і подається англійською, як у самому API.

Параметри

ПолеДеТипОбов’язк.Опис
textquerystringніNatural-language query. Structured parameters below override what is parsed from text.
makequerystringніComma-separated make slugs, e.g. bmw,audi.
modelquerystringніComma-separated "<make>/<model>" slugs, e.g. bmw/x5,volkswagen/golf.
year_fromqueryintegerні
year_toqueryintegerні
price_from_eurqueryinteger | nullні
price_to_eurqueryinteger | nullні
mileage_from_kmqueryinteger | nullні
mileage_to_kmqueryinteger | nullні
power_from_kwqueryinteger | nullні
power_to_kwqueryinteger | nullні
fuelquerystringніComma-separated: petrol,diesel,hybrid,phev,ev,lpg,cng,hydrogen,other.
gearboxquerystringніComma-separated: manual,automatic,cvt,robot,other.
bodyquerystringніComma-separated: sedan,hatchback,wagon,suv,crossover,coupe,convertible,minivan,van,pickup,...
drivequerystringніComma-separated: fwd,rwd,awd,4wd.
colorquerystringніComma-separated: black,white,grey,silver,blue,red,green,brown,beige,yellow,orange,other.
countryquerystringніComma-separated lowercase ISO-3166 codes of EU catalogue markets, e.g. de,nl,be.
sellerquerystringніComma-separated: dealer,private.
vatquerystringніdeductible (VAT reclaimable, net price available) and/or included (margin scheme).
posted_within_daysqueryintegerні
sortquery"relevance" | "newest" | "price_asc" | "price_desc" | "mileage_asc" | "year_desc" | "landed_asc" | "deal_score"ні
localequery"uk" | "pl" | "en"ніLanguage of chip labels.
pagequeryintegerні
page_sizequeryintegerні

Відповіді

200

Catalogue search result.

application/json · Схема: CatalogSearchResponse

ПолеТипОбов’язк.Опис
queryobjectтакFilters that were actually executed.
query.qstringні
query.makestring[]ні
query.modelstring[]ні
query.yearFrominteger | nullні
query.yearTointeger | nullні
query.priceFrominteger | nullні
query.priceTointeger | nullні
query.mileageFrominteger | nullні
query.mileageTointeger | nullні
query.powerFrominteger | nullні
query.powerTointeger | nullні
query.fuel"petrol" | "diesel" | "hybrid" | "phev" | "ev" | "lpg" | "cng" | "hydrogen" | "other"[]ні
query.gearbox"manual" | "automatic" | "cvt" | "robot" | "other"[]ні
query.body"sedan" | "hatchback" | "wagon" | "suv" | "crossover" | "coupe" | "convertible" | "minivan" | "van" | "pickup" | "truck" | "motorcycle" | "other"[]ні
query.drive"fwd" | "rwd" | "awd" | "4wd"[]ні
query.colorstring[]ні
query.country"de" | "at" | "nl" | "be" | "lu" | "fr" | "dk" | "se" | "no" | "fi" | "ee" | "lv" | "lt" | "pl" | "cz" | "sk" | "it" | "es"[]ні
query.sourcestring[]ні
query.sellerType"dealer" | "private" | "unknown"[]ні
query.vat"deductible" | "included" | "unknown"[]ні
query.withPhotosboolean | nullні
query.postedWithinDaysinteger | nullні
query.features"tow_hitch" | "heat_pump" | "panorama_roof" | "apple_carplay" | "android_auto" | "camera" | "camera_360" | "heated_seats" | "heated_steering" | "ventilated_seats" | "head_up" | "adaptive_cruise" | "navigation" | "keyless" | "electric_tailgate" | "leather"[]ні
query.batteryFrominteger | nullні
query.batteryTointeger | nullні
query.sort"relevance" | "newest" | "price_asc" | "price_desc" | "mileage_asc" | "year_desc" | "landed_asc" | "deal_score"ні
parsedobjectтакHow text was understood (null when no text was sent).
parsed.queryobjectтакCatalog filters (contract catalog-search). Prices are EUR, mileage km, power kW.
parsed.chipsobject[]такWhat was understood, in reading order.
parsed.understoodbooleanтакAt least one filter (or a sort) was recognised.
parsed.method"rules" | "ai" | "ai_cache"такrules — deterministic parser; ai — Claude (merged with rules); ai_cache — cached model parse.
parsed.demobooleanтакtrue — no AI model is configured, the rule-based parser only (demo mode).
parsed.ai_skipped"not_configured" | "disabled" | "not_needed" | "rate_limited" | "budget_exhausted" | "timeout" | "error" | "invalid" | "refusal" | nullтакWhy the model was not used (null when it was).
parsed.ignoredstring[]такWords that could not be turned into a filter.
parsed.unsupported_marketsstring[]такMarkets outside the EU catalogue the query asked for (us, kr, cn ...): not searchable here.
parsed.price_originalobjectтакPrice as written in the query (before conversion to EUR at the ECB/NBU rate).
parsed.catalog_urlstring | nullтакPublic site catalogue page with these filters (null if not configured).
itemsobject[]так
items[].idstringні
items[].slugstringні
items[].titlestringні
items[].makestringні
items[].makeSlugstringні
items[].modelstringні
items[].modelSlugstringні
items[].trimstring | nullні
items[].yearinteger | nullні
items[].firstRegistrationstring | nullні
items[].mileageKminteger | nullні
items[].powerKwinteger | nullні
items[].engineCcinteger | nullні
items[].batteryKwhnumber | nullні
items[].fuel"petrol" | "diesel" | "hybrid" | "phev" | "ev" | "lpg" | "cng" | "hydrogen" | "other" | nullні
items[].gearbox"manual" | "automatic" | "cvt" | "robot" | "other" | nullні
items[].body"sedan" | "hatchback" | "wagon" | "suv" | "crossover" | "coupe" | "convertible" | "minivan" | "van" | "pickup" | "truck" | "motorcycle" | "other" | nullні
items[].drive"fwd" | "rwd" | "awd" | "4wd" | nullні
items[].colorstring | nullні
items[].priceEurinteger | nullні
items[].netPriceEurinteger | nullні
items[].vat"deductible" | "included" | "unknown"ні
items[].landedEurinteger | nullні
items[].dealScorenumber | nullні
items[].country"de" | "at" | "nl" | "be" | "lu" | "fr" | "dk" | "se" | "no" | "fi" | "ee" | "lv" | "lt" | "pl" | "cz" | "sk" | "it" | "es"ні
items[].citystring | nullні
items[].sellerType"dealer" | "private" | "unknown"ні
items[].photosstring (uri)[]ні
items[].photoCountintegerні
items[].publicationsCountintegerні
items[].sourceKeysstring[]ні
items[].firstSeenAtstringні
items[].lastSeenAtstringні
items[].listedAtstringні
items[].priceDropobjectні
items[].cloneCountintegerні
totalintegerтак
pageintegerтак
page_sizeintegerтак
catalog_urlstring | nullтакPublic site catalogue page with these filters.
freshnessobject[]так
freshness[].sourceKeystringні
freshness[].lastCrawlAtstring | nullні
freshness[].healthstringні
took_msintegerтак

400

Invalid request parameters or body (code validation_error).

application/problem+json · Схема: Problem

401

Missing, malformed, unknown, revoked or expired API key (code unauthorized).

application/problem+json · Схема: Problem

403

The API key lacks the scope required by this endpoint (code insufficient_scope).

application/problem+json · Схема: Problem

429

Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.

application/problem+json · Схема: Problem

503

The catalogue (search index) is not configured or unavailable.

application/problem+json · Схема: Problem

На цій сторінці