Szybki start
W tym przewodniku utworzysz konto, wygenerujesz klucz API i wykonasz pierwsze zapytanie do endpointu /api/v1/evaluate. Cały proces zajmuje mniej niż 5 minut.
1. Utwórz konto
Zarejestruj się w Portalu LokalScore. Po rejestracji otrzymasz dostęp do panelu zarządzania kluczami API, planów subskrypcyjnych i statystyk użycia.
Wskazówka: Możesz zacząć od darmowego planu, który pozwala przetestować API bez zobowiązań.
2. Wygeneruj klucz API
- Zaloguj się do Portalu.
- Przejdź do sekcji Klucze API.
- Kliknij Wygeneruj nowy klucz.
- Skopiuj klucz — jest on pokazywany tylko raz. Klucze mają prefiks
ls_.
Klucz API jest używany jako token Bearer w nagłówku Authorization. Przechowuj go bezpiecznie — nigdy nie umieszczaj go w kodzie frontendu ani w repozytorium.
3. Pierwsze zapytanie
Endpoint /api/v1/evaluate oblicza wielowymiarowy wskaźnik jakości lokalizacji (LokalScore) w skali 0–100 dla 5 filarów scoringu.
Możesz przekazać lokalizację na trzy sposoby:
- Współrzędne —
latitude+longitude(EPSG:4326), - Adres tekstowy —
address(np.ul. Legnicka 12, Wrocław), - Działka katastralna —
parcel_id(np.026401_1.0022.AR_11.54/2).
curl -X 'POST' \
'https://api.lokalscore.pl/api/v1/evaluate' \
-H 'accept: application/json' \
-H 'Authorization: Bearer ls_TWOJ_KLUCZ_API' \
-H 'Content-Type: application/json' \
-d '{
"latitude": 51.1093,
"longitude": 17.0289,
"radius_meters": 1000
}'4. Interpretacja odpowiedzi
Odpowiedź zawiera:
| Pole | Opis |
|---|---|
location | Rozwiązane współrzędne, indeks H3, podział administracyjny, dane działki |
global_score | Ogólny wskaźnik LokalScore w skali 0–100 |
categories | Wyniki cząstkowe dla 5 filarów (transport, wygoda, środowisko, rodzina, rekreacja) |
market_valuation_avm | Szacunkowa wycena i statystyki cen transakcyjnych (RCN) |
insights | Podsumowanie zalet i wad lokalizacji |
airports_nearby | Lotniska w promieniu 5 km |
5. Co dalej?
- Uwierzytelnianie — szczegóły kluczy Bearer, limity i obsługa błędów.
- Dokumentacja API — interaktywna konsola Swagger do testowania wszystkich endpointów.
- SDK Python — kompletny klient Python z obsługą błędów.
- SDK Node.js — kompletny klient Node.js.
- Integracja GIS — H3, GeoJSON i mapowanie wyników.
- Model scoringu — 5 filarów i algorytm Distance Decay.