API Dokumentácia

Autentifikácia

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

API kľúče si môžete vytvoriť v nastaveniach dashboardu. 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 klientskeho kódu.

Rate Limiting

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

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

Keď prekročíte limit, API vráti odpoveď 429 Too Many Requests. Limit sa automaticky obnoví každú minútu.

API Endpointy

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 notifikácie o nových inzerátoch a zmenách cien.
GET /api/v1/reports — Generovanie a sťahovanie trhových reportov vo formáte PDF.

Webhooky

Webhooky umožňujú prijímať notifikácie v reálnom čase o udalostiach na platforme.

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

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

Príklady kódu

cURL

cURL: curl -H "X-API-Key: vas_kluc" https://api.reality-scan.com/api/v1/listings/search?locality=Bratislava

Python

Python: requests.get("https://api.reality-scan.com/api/v1/listings/search", headers={"X-API-Key": "vas_kluc"})

Node.js

Node.js: fetch("https://api.reality-scan.com/api/v1/listings/search", {headers: {"X-API-Key": "vas_kluc"}})