The listing object
One ad on one source site. Price, mileage, photos, location and seller details live here. Prices are in the listing's own currency and are never converted.
Custom listing fields
Connect a key to see the fields available to your domains.
Published indexed values for this specific listing and its enabled domain bindings. Discover authorized keys/types/constraints through GET /listing-fields. Preserve zero, false and homogeneous arrays. Missing values are omitted. Stored-only fields stay in source_data; no historical backfill.
3 child attributes
Source listing ID; distinct from the internal car ID.
2 child attributes
Language-to-title map, returned without selecting a language from lang. Keys are locale codes (for example en or ko); use an available translation as a fallback. Returns null when missing, or [] for an empty stored PHP map.
Legacy location object, or [] when unavailable. Use location_details for a uniform ID/name format across all vehicle endpoints. /search and /listing normally expose stored IDs; /cars, /cars/{car_id} and /cars/vin/{vin} attempt to replace country, location_admin_1, location_admin_2 and location_id with localized names, so values can be strings or unresolved IDs. Resolve numeric country via /countries/{id}; resolve numeric location_id, location_admin_1 and location_admin_2 via /locations/{id}, or batch them with ids[]. Do not send already localized names as IDs. See the location dictionary endpoints.
8 child attributes
Source administrative value; not a guaranteed location dictionary ID.
2 child attributes
Always present on every listing in /search, /cars, car ID/VIN and listing lookups. Same additive shape everywhere; legacy location is preserved. country maps from country_id, region from location_admin_1, district from location_admin_2, place from location_id. Each missing component is null. A known positive ID remains present with name:null if unresolved; an existing textual source label has id:null. No city/parent inference or reverse geocoding is performed. place is the referenced geographic entry, not necessarily a city. Read names here for display; no extra client lookup is needed. Names follow lang and dictionary fallback rules. All unique country/location IDs are collected from visible listings across the response before bulk lookup, in batches of at most 1000 dictionary documents. Empty ID sets need no lookup; there are no per-car location requests. Regional self-references may produce duplicate IDs; deduplicate labels by ID within the location namespace.
4 child attributes
3 child attributes
Internal country ID, resolved through /countries.
Localized country name.
Uppercase country ISO code, or null when unavailable.
2 child attributes
Original location ID, or null for a source-owned textual label.
Localized name, or null when unresolved.
2 child attributes
Original location ID, or null for a source-owned textual label.
Localized name, or null when unresolved.
2 child attributes
Original location ID, or null for a source-owned textual label.
Localized name, or null when unresolved.
Available URLs for one listing image. Each field is optional and omitted when unavailable. Entries without any URL are excluded; the images array can be empty. No fixed dimensions or availability of all three variants are guaranteed.
3 child attributes
URL of the image copy downloaded to our image storage. Returned only when both the stored file path and image server are available; the URL uses the image host configured for the API domain.
Preview image URL supplied by the listing source. Passed through unchanged; usually suitable for thumbnails. Dimensions are not guaranteed.
Original image URL supplied by the listing source. Passed through unchanged; it points to the source image rather than our downloaded copy.
Video URLs. Returns an array (including []), or null when unavailable; never a single URL string.
4 child attributes
2 child attributes
3 child attributes
2 child attributes
2 child attributes
2 child attributes
2 child attributes
2 child attributes
2 child attributes
2 child attributes
Always included, as true or false: whether this listing has at least one public vehicle history report.
Listing leasing flag; omitted when the source has no boolean value. The is_leasing=false query filter includes missing and null source values.
Source-owned passthrough object or array; omitted when unavailable or empty. Registered stored-only fields are described by authenticated GET /listing-fields, including their types and storage paths; explicit null clears a typed stored value. Preserve unknown fields. Historical comparison estimates do not replace listing prices; never infer their currency.
{30 keys
"external": {3 keys
"domain": {2 keys
"title": {2 keys
"location": {6 keys
"position": {2 keys
"location_details": {4 keys
"country": {3 keys
"region": {2 keys
"district": {2 keys
"place": {2 keys
"images": [2 items
]"video": [1 item
"price": {4 keys
"currency": {2 keys
"history": [3 items
]"seller_type": {2 keys
"availability": {2 keys
"condition": {2 keys
"damage": {2 keys
"second_damage": {2 keys
"airbag_state": {2 keys
"document_id": {2 keys
"option_ids": [5 items
]"source_data": {2 keys
}Example values chosen to show every field. IDs for enums, currency and locations are real; names, VINs and URLs are made up. A field you don't see in a real response was not supplied by the source.
Get API access
Connect your key to run every request on these pages against your own data. No key yet? Ask us for a demo key: the same JSON as the paid plans.