CarStat.dev
Connect key
Objects

Dictionary objects

Small reference objects returned by the dictionary endpoints. Cache them; they change rarely.

Domain From /domains.

idintegeralways in response
namestringnullablealways in response
base_urlstringnullablealways in response

Source hostname, without protocol.

Brand From /brands.

idintegeralways in response

Brand ID. Internal catalogue documents without an ID are excluded.

namestringnullablealways in response
icon_urlstringnullable

Omitted on api.auctionsapi.com.

Model From /models/{brand_id}.

idintegernullablealways in response
namestringnullablealways in response
generationsarray of objectalways in response
3 child attributes
namestringnullable
fromintegernullable
tointegernullable

Generation Inside Model.generations.

namestringnullable
fromintegernullable
tointegernullable

Country From /countries.

idintegeralways in response

Internal country ID. Matches numeric listings[].location.country and Location.country_id; not a location/GeoNames ID.

namestringnullablealways in response

Display name selected using lang, with source-name fallback.

original_namestringnullablealways in response

Unlocalized stored name.

nativestringnullablealways in response
isostringnullablealways in response

Uppercase two-letter ISO code.

iso3stringnullablealways in response

Uppercase three-letter ISO code.

Location From /locations.

idintegeralways in response

Location dictionary ID. Use for numeric location_id, location_admin_1 and location_admin_2 values.

namestringnullablealways in response

Display name selected using lang. English uses the stored name. Other locales prefer nonhistoric alternative names in the requested language or without a language, ordered by is_preferred, then fall back to the stored name.

original_namestringnullablealways in response
ascii_namestringnullablealways in response
country_idintegernullablealways in response

Internal country ID, resolved through /countries.

admin1integernullablealways in response

First-level administrative location ID; may equal this record ID.

admin2integernullablealways in response

Second-level administrative location ID; may equal this record ID.

admin3stringnullablealways in response

Source administrative code, not a guaranteed location ID. Preserve as a string.

admin4stringnullablealways in response

Source administrative code, not a guaranteed location ID. Preserve as a string.

admin5stringnullablealways in response

Source administrative code, not a guaranteed location ID. Preserve as a string.

feature_classstringnullablealways in response

Uppercase source feature class. A = administrative area; P = populated place.

feature_codestringnullablealways in response

Uppercase source feature code. ADM1 = first-level region; ADM2 = second-level district.

latitudenumbernullablealways in response
longitudenumbernullablealways in response
populationintegernullablealways in response

OptionSection From /car-option-sections.

idintegeralways in response
namestringnullablealways in response
translationsobjectalways in response
1 child attributes
namemap | []

Language-to-text map. PHP serializes an empty map as [].

Option From /car-options.

idinteger
section_idintegernullable
parent_option_idintegernullable
namestringnullable
descriptionstringnullable
locationstringnullable
translationsobject
3 child attributes
namemap | []

Language-to-text map. PHP serializes an empty map as [].

descriptionmap | []

Language-to-text map. PHP serializes an empty map as [].

locationmap | []

Language-to-text map. PHP serializes an empty map as [].

sectionobjectnullable
3 child attributes
idintegernullablealways in response
namestringnullablealways in response
translationsobjectalways in response
1 child attributes
namemap | []always in response

Language-to-text map. PHP serializes an empty map as [].

parent_optionobjectnullable
3 child attributes
idintegernullablealways in response
namestringnullablealways in response
translationsobjectalways in response
1 child attributes
namemap | []always in response

Language-to-text map. PHP serializes an empty map as [].

/domains · first itemLive
{
  "id": 55679,
  "name": "SeekAuto.com",
  "base_url": "seekauto.com",
  "domain": "seekauto.com"
}
/models/88 · first itemLive
{
  "id": 1968,
  "name": "Flying Spur",
  "generations": [
    {
      "name": "III",
      "from": 2019,
      "to": null
    },
    {
      "name": "II",
      "from": 2013,
      "to": 2019
    }
  ]
}
/countries/1Live
{
  "data": {
    "id": 1,
    "name": "Afghanistan",
    "original_name": "Afghanistan",
    "native": "افغانستان",
    "iso": "AF",
    "iso3": "AFG"
  }
}