CarStat.dev
Connect key
Objects

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.

externalobjectalways in response
3 child attributes
idstringalways in response

Source listing ID; distinct from the internal car ID.

domainobjectalways in response
2 child attributes
idintegeralways in response
namestringnullablealways in response
urlstringalways in response
archivedbooleanalways in response
titlemap | []

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.

odometernumbernullable
locationobject | []

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
isostringnullable
postal_codestringnullable
countryinteger | string
location_admin_1integer | string
location_admin_2integer | string
location_idinteger | string
location_admin_3integer | string

Source administrative value; not a guaranteed location dictionary ID.

positionobject
2 child attributes
latnumber
lonnumber
location_detailsobjectalways in response

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
countryobjectnullablealways in response
3 child attributes
idintegernullablealways in response

Internal country ID, resolved through /countries.

namestringnullablealways in response

Localized country name.

isostringnullablealways in response

Uppercase country ISO code, or null when unavailable.

regionobjectnullablealways in response
2 child attributes
idintegernullablealways in response

Original location ID, or null for a source-owned textual label.

namestringnullablealways in response

Localized name, or null when unresolved.

districtobjectnullablealways in response
2 child attributes
idintegernullablealways in response

Original location ID, or null for a source-owned textual label.

namestringnullablealways in response

Localized name, or null when unresolved.

placeobjectnullablealways in response
2 child attributes
idintegernullablealways in response

Original location ID, or null for a source-owned textual label.

namestringnullablealways in response

Localized name, or null when unresolved.

imagesarray of objectalways in response

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
downloadedstring

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.

previewstring

Preview image URL supplied by the listing source. Passed through unchanged; usually suitable for thumbnails. Dimensions are not guaranteed.

originalstring

Original image URL supplied by the listing source. Passed through unchanged; it points to the source image rather than our downloaded copy.

videoarray of stringnullable

Video URLs. Returns an array (including []), or null when unavailable; never a single URL string.

created_atstringnullable
last_seen_atstringnullable
updated_atstringnullable
auction_atstringnullable
priceobject
4 child attributes
pricenumbernullable
currencyobjectnullable
2 child attributes
idintegeralways in response
namestringnullablealways in response
negotiablebooleannullable
historyarray of objectnullable
3 child attributes
pricenumbernullable
currency_idintegernullable
created_atstringnullable
seller_typeobjectnullable
2 child attributes
idintegeralways in response
namestringnullablealways in response
availabilityobjectnullable
2 child attributes
idintegeralways in response
namestringnullablealways in response
conditionobjectnullable
2 child attributes
idintegeralways in response
namestringnullablealways in response
damageobjectnullable
2 child attributes
idintegeralways in response
namestringnullablealways in response
second_damageobjectnullable
2 child attributes
idintegeralways in response
namestringnullablealways in response
airbag_stateobjectnullable
2 child attributes
idintegeralways in response
namestringnullablealways in response
document_idobjectnullable
2 child attributes
idintegeralways in response
namestringnullablealways in response
option_idsarray of integeralways in response
is_auctionbooleannullable
current_bidnumbernullable
keys_availablebooleannullable
is_manufacturer_certifiedbooleannullable
has_history_reportsbooleanalways in response

Always included, as true or false: whether this listing has at least one public vehicle history report.

is_leasingboolean

Listing leasing flag; omitted when the source has no boolean value. The is_leasing=false query filter includes missing and null source values.

source_datamap | array of object

Nonempty source-owned object or array, passed through without normalization. Omitted when unavailable or empty; preserve unknown fields.

has_registrationboolean
descriptionstring
Listing · every field filledExample
{30 keys
"external": {3 keys
"id": "example-listing-1"
"domain": {2 keys
"id": 101
"name": "cars.example.com"
}
"url": "https://cars.example.com/listing/example-listing-1"
}
"archived": false
"title": {2 keys
"en": "Example SUV 2.0 Hybrid AWD Premium"
"pl": "Example SUV 2.0 Hybrid 4x4 Premium"
}
"odometer": 98700
"location": {6 keys
"iso": "PL"
"country": 177
"location_admin_1": 858787
"location_admin_2": 6695624
"location_id": 756135
"position": {2 keys
"lat": 52.22977
"lon": 21.01178
}
}
"location_details": {4 keys
"country": {3 keys
"id": 177
"name": "Poland"
"iso": "PL"
}
"region": {2 keys
"id": 858787
"name": "Masovian Voivodeship"
}
"district": {2 keys
"id": 6695624
"name": "Warszawa"
}
"place": {2 keys
"id": 756135
"name": "Warsaw"
}
}
"images": [2 items]
"video": [1 item
0: "https://cars.example.com/video/walkaround.mp4"
]
"created_at": "2026-08-01T09:00:00Z"
"last_seen_at": "2026-09-28T06:00:00Z"
"updated_at": "2026-09-20T12:00:00Z"
"auction_at": "2026-10-02T14:00:00Z"
"price": {4 keys
"price": 104900
"currency": {2 keys
"id": 119
"name": "pln"
}
"negotiable": true
"history": [3 items]
}
"seller_type": {2 keys
"id": 2
"name": "dealer"
}
"availability": {2 keys
"id": 1
"name": "in_stock"
}
"condition": {2 keys
"id": 1
"name": "used"
}
"damage": {2 keys
"id": 22
"name": "minor_dents_scratches"
}
"second_damage": {2 keys
"id": 18
"name": "rear"
}
"airbag_state": {2 keys
"id": 1
"name": "intact"
}
"document_id": {2 keys
"id": 1
"name": "certificate_of_title"
}
"option_ids": [5 items]
"is_auction": true
"current_bid": 91000
"keys_available": true
"is_manufacturer_certified": false
"has_history_reports": true
"is_leasing": false
"source_data": {2 keys}
"has_registration": true
"description": "Example description written by the seller. Shown as plain text."
}

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.