API Dokumentácia

Autentifikácia

API používa kľúčovú autentifikáciu. Každá požiadavka musí obsahovať hlavičku X-API-Key.

API kľúče si môžete vytvoriť v nastaveniach nástenky. Každý kľúč je viazaný na váš účet a úroveň predplatného.

Vždy uchovávajte svoj API kľúč v bezpečí. Nikdy ho nezdieľajte verejne ani nezahŕňajte do klientského kódu.

API používa token bucket algoritmus na obmedzenie rýchlosti požiadaviek.

Každý API kľúč má limit požiadaviek za minútu v závislosti od úrovne predplatného. Hunter — 60 req/min, Analyst — 300 req/min.

Pri prekročení limitu API vráti odpoveď 429 Too Many Requests. Limit sa automaticky resetuje každú minútu.

API poskytuje nasledujúce hlavné endpointy:

GET /api/v1/listings/search — Vyhľadávanie nehnuteľností s filtrami podľa lokality, ceny, typu a ďalších kritérií.
POST /api/v1/webhooks — Správa webhookov pre upozornenia na nové inzeráty a zmeny cien.
GET /api/v1/reports — Vytváranie a sťahovanie trhových reportov vo formáte PDF.

Webhooky umožňujú prijímať upozornenia v reálnom čase o udalostiach platformy.

Môžete sa prihlásiť na odber udalostí new_listing, price_change a conflict_detected. Každá udalosť obsahuje úplné dáta o inzeráte.

Webhooky podporujú automatické opakovanie pri zlyhaní a podpis na overenie pôvodu notifikácie.

cURL: curl -H "X-API-Key: váš_kľúč" https://api.reality-scan.com/api/v1/listings/search?locality=Bratislava

Python: requests.get("https://api.reality-scan.com/api/v1/listings/search", headers={"X-API-Key": "váš_kľúč"})

Node.js: fetch("https://api.reality-scan.com/api/v1/listings/search", {headers: {"X-API-Key": "váš_kľúč"}})