Dokumentace API

Přístup k reálným údajům o spotřebě paliva pro 9 894 motorových variant přes naše RESTful API.

Navigace

Začínáme

Základní URL

https://realnaspotreba.cz/api/v1

Vyzkoušejte hned (Demo klíč)

Autentizace

Všechny API požadavky vyžadují API klíč předaný v headeru.

Header

X-API-Key: rsp_your_api_key_here

Ukázkový požadavek

curl -H "X-API-Key: rsp_your_key" \
  https://realnaspotreba.cz/api/v1/brands

Demo API klíče (pro testování)

  • demo_key_12345 - Free tier
  • rsp_basic_demo - Basic tier
  • rsp_pro_demo - Pro tier

Rate Limiting

TarifPožadavků/DenCena
Free1000 Kč
Basic1,000990 Kč/měsíc
Pro10,0002,990 Kč/měsíc
Enterprise100,000+Na míru

Response headery

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1706284800000

Endpointy

GET/v1/brands

Vrací seznam všech značek aut s počty modelů a motorů.

Ukázkový požadavek

curl -H "X-API-Key: demo_key_12345" \
  https://realnaspotreba.cz/api/v1/brands

Ukázková odpověď

{
  "data": [
    {
      "slug": "skoda",
      "name": "Škoda",
      "logo": "skoda.png",
      "modelCount": 42,
      "engineCount": 487
    },
    ...
  ],
  "meta": {
    "total": 57
  }
}
GET/v1/brands/{brand}

Vrací detailní informace o konkrétní značce včetně všech modelů a motorů.

Ukázkový požadavek

curl -H "X-API-Key: demo_key_12345" \
  https://realnaspotreba.cz/api/v1/brands/skoda
GET/v1/search?q={query}

Vyhledávání aut podle značky, modelu nebo typu motoru.

Parametry

  • q - Vyhledávací dotaz (povinný)
  • limit - Max. výsledků (výchozí: 10, max: 50)

Ukázkový požadavek

curl -H "X-API-Key: demo_key_12345" \
  "https://realnaspotreba.cz/api/v1/search?q=octavia+diesel&limit=5"
GET/v1/stats

Statistiky databáze včetně nejúspornějších/nejméně úsporných aut a analýzy odchylek.

Ukázkový požadavek

curl -H "X-API-Key: rsp_pro_demo" \
  https://realnaspotreba.cz/api/v1/stats

Chybové kódy

KódPopis
400Bad Request - Chybějící nebo neplatné parametry
401Unauthorized - Neplatný nebo chybějící API klíč
404Not Found - Zdroj neexistuje
429Too Many Requests - Překročen rate limit
500Internal Server Error - Vnitřní chyba serveru

Příklady kódu

JavaScript / TypeScript

const response = await fetch('https://realnaspotreba.cz/api/v1/brands', {
  headers: {
    'X-API-Key': 'rsp_your_key_here'
  }
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.get(
    'https://realnaspotreba.cz/api/v1/brands',
    headers={'X-API-Key': 'rsp_your_key_here'}
)

data = response.json()
print(data)

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://realnaspotreba.cz/api/v1/brands');
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'X-API-Key: rsp_your_key_here'
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data);