Szybka referencja
Skrócona tabela wszystkich publicznych endpointów API LokalScore. Base URL dla produkcji:
https://lokalscore.pl/api/v1Każdy endpoint opisany szczegółowo znajdziesz w interaktywnej dokumentacji API oraz w odpowiednich przewodnikach.
Endpointy chronione kluczem API
Wymagają nagłówka Authorization: Bearer ls_TWOJ_KLUCZ_API (patrz Autentykacja).
| Metoda | Ścieżka | Opis | Kluczowe parametry |
|---|---|---|---|
POST | /evaluate | Pełna ewaluacja i scoring lokalizacji (5 filarów, 0–100), wycena RCN | latitude, longitude / address / parcel_id, radius_meters |
POST | /evaluate/greenery | Wskaźnik zazielenienia terenu (analiza H3) | latitude, longitude, radius_meters |
POST | /evaluate/avm | Automatyczna wycena i benchmarking ceny (AVM) | property_type, area_m2, listing_price, lokalizacja |
POST | /evaluate/lim | Zaawansowany scoring i analiza ryzyk B2B (Location Intelligence Model) | lokalizacja, parametry modelu LIM |
POST | /avm/check | Sprawdzenie ceny nieruchomości (AVM) dla zalogowanego użytkownika B2B | property_type, area_m2, listing_price, lokalizacja |
Endpointy publiczne (bez klucza API)
Nie wymagają uwierzytelnienia, ale podlegają limitom per-IP na poziomie nginx.
| Metoda | Ścieżka | Opis | Parametry |
|---|---|---|---|
GET | /widget/score | Publiczny widget: punktowy LokalScore (0–100) i zagregowane oceny 5 filarów | lat+lon, address lub parcel_id |
GET | /prg/autocomplete | Autouzupełnianie adresów z koordynatami (PRG → TERYT fallback) | q (fraza) |
GET | /teryt/autocomplete | Autouzupełnianie adresów na podstawie bazy TERYT (miejscowość i ulica) | q (fraza) |
Endpoint pomocniczy (bez klucza API)
| Metoda | Ścieżka | Opis | Parametry |
|---|---|---|---|
GET | /pricing | Aktualne plany API i subskrypcje B2B pobierane na żywo z bazy | — |
Najważniejsze parametry
| Parametr | Typ | Opis |
|---|---|---|
latitude, longitude | number | Współrzędne geograficzne (EPSG:4326). Zakres: -90..90 / -180..180. |
address | string | Adres tekstowy, np. ul. Legnicka 12, Wrocław. |
parcel_id | string | Identyfikator działki katastralnej TERYT, np. 026401_1.0022.AR_11.54/2. |
radius_meters | number | Promień analizy sąsiedztwa w metrach (większy = dłuższy czas obliczeń). |
q | string | Fraza wyszukiwania dla autocomplete. |
Szybka nawigacja
- Plany i limity — limity rate limiting, miesięczne i overage.
- Autentykacja — nagłówek Bearer, limity, obsługa błędów.
- FAQ / Rozwiązywanie problemów — scenariusze
429,504,422, geokodowanie. - Changelog / Wersjonowanie — polityka wersji
v1i historia zmian.