Skip to Content
Szybki start

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

  1. Zaloguj się do Portalu.
  2. Przejdź do sekcji Klucze API.
  3. Kliknij Wygeneruj nowy klucz.
  4. 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:

PoleOpis
locationRozwiązane współrzędne, indeks H3, podział administracyjny, dane działki
global_scoreOgólny wskaźnik LokalScore w skali 0–100
categoriesWyniki cząstkowe dla 5 filarów (transport, wygoda, środowisko, rodzina, rekreacja)
market_valuation_avmSzacunkowa wycena i statystyki cen transakcyjnych (RCN)
insightsPodsumowanie zalet i wad lokalizacji
airports_nearbyLotniska w promieniu 5 km

5. Co dalej?

LokalScore
System scoringu lokalizacji i wyceny nieruchomości w Polsce.
© 2026 LokalScore. Wszelkie prawa zastrzeżone.