05 Методы

Справочники: марки, модели, рынки

GET /v1/references/…

Справочники помогают собрать правильный запрос: как пишутся марки и модели, какие значения у полей, насколько свежи рынки. Бесплатно, квоту не тратят.

Примеры запросов

Параметры

Рынок

market обязателенquery · kr | cn | us
Рынок.

Запрос `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);

Получить тестовый ключ

Сайт запросов не отправляет: скопируйте код и запустите со своим ключом.

Ответ

HTTP 200

[
  {
    "name": "Hyundai",
    "count": 34863
  },
  {
    "name": "Kia",
    "count": 33857
  },
  {
    "name": "BMW",
    "count": 12643
  },
  {
    "name": "Mercedes-Benz",
    "count": 12478
  },
  {
    "name": "Genesis",
    "count": 8116
  },
  {
    "name": "KGM (SsangYong)",
    "count": 6055
  },
  {
    "name": "Chevrolet",
    "count": 5590
  },
  {
    "name": "Renault Korea",
    "count": 4629
  }
]

Пример данных: машины настоящие, из каталога на момент сборки сайта; фото сокращены до двух.

Примечания

Метод	Что отдаёт
`GET /v1/references/brands?market=`	Марки рынка с числом машин, частые первыми; так их находит фильтр brand.
`GET /v1/references/models?market=&brand=`	Модели марки с числом машин.
`GET /v1/references/dictionaries`	Канонические значения fuel, transmission, body_type, drive, damage, title_doc и их синонимы.
`GET /v1/references/markets`	Каждый рынок: доступ по тарифу, статус, data_updated_at, data_age_seconds, stale, число машин.

В примерах моделей и рынков часть значений опущена: у моделей нет снимка в данных сайта, у рынков показаны поля из данных сборки.