05 Endpoints

References: makes, models, markets

GET /v1/references/…

References help to build a correct request: how makes and models are spelled, which values fields take, how fresh the markets are. Free, no quota.

Example requests

Parameters

Market

market requiredquery · kr | cn | us
The market.

Request `GET`

GEThttps://api.apiauto.space/v1/references/brands?market=kr

cURL

curl -s "https://api.apiauto.space/v1/references/brands?market=kr" \
  -H "X-API-Key: $APIAUTO_KEY"

JavaScript

const response = await fetch(
  "https://api.apiauto.space/v1/references/brands?market=kr",
  { headers: { "X-API-Key": process.env.APIAUTO_KEY } },
);
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const data = await response.json();

Python

import os
import httpx

data = httpx.get(
    "https://api.apiauto.space/v1/references/brands?market=kr",
    headers={"X-API-Key": os.environ["APIAUTO_KEY"]},
    timeout=30,
).raise_for_status().json()

PHP

<?php
$ch = curl_init("https://api.apiauto.space/v1/references/brands?market=kr");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ["X-API-Key: " . getenv("APIAUTO_KEY")],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

Get a test key

The site sends no requests: copy the code and run it with your key.

Response

HTTP 200

[
  {
    "name": "Hyundai",
    "count": 34911
  },
  {
    "name": "Kia",
    "count": 33884
  },
  {
    "name": "BMW",
    "count": 12666
  },
  {
    "name": "Mercedes-Benz",
    "count": 12511
  },
  {
    "name": "Genesis",
    "count": 8141
  },
  {
    "name": "KGM (SsangYong)",
    "count": 6079
  },
  {
    "name": "Chevrolet",
    "count": 5634
  },
  {
    "name": "Renault Korea",
    "count": 4622
  }
]

Sample data: the cars are real, from the catalog when the site was built; photos are cut to two.

Notes

Endpoint	What it returns
`GET /v1/references/brands?market=`	A market's makes with car counts, most frequent first; the brand filter matches these spellings.
`GET /v1/references/models?market=&brand=`	A make's models with car counts.
`GET /v1/references/dictionaries`	The canonical values of fuel, transmission, body_type, drive, damage, title_doc and their synonyms.
`GET /v1/references/markets`	Every market: plan access, status, data_updated_at, data_age_seconds, stale, the number of cars.

In the models and markets samples some values are left out: the site's data has no models snapshot, and the markets show the fields of the data build.