Vantaan paikannus REST-API
http://gis.vantaa.fi/rest/paikannus/v2
Palvelun tietosisältönä on osoite- ja kiinteistörekisteristä tuotetut paikannustiedot pistemäisinä ETRS-GK25FIN (EPSG:3879) koordinaatteina esitettynä. Data palautetaan JSON-muodossa.
Palvelua voi käyttää sekä geokoodaukseen eli sijainnin hakemiseen osoitteelle tai kiinteistölle, että käänteiseen geokoodaukseen, eli lähimmän osoitteen tai kiinteistön hakemiseen sijainnin perusteella.
Geokoodaus
Geokoodausta käytetään osoitteen https://gis.vantaa.fi/rest/paikannus/v2/geokoodaus/<tyyppi>/<hakutila>/<hakusana>?max=<kohteiden max lkm>
kautta ja palvelulle määritellään kolme parametria.
- Tyyppi-parametrilla voidaan rajata haku koskemaan vain tietyn tyyppisiä sijainteja. Sallitut arvot:
osoite
haku kohdistetaan katuosoitteisiinkiinteisto
haku kohdistetaan pelkkiin kiinteistöihin, määräraloihin ja vuokra-alueisiin tunnuksen perusteella. Tunnukset syötetään ilman etunollia.katu
haussa sivuutetaan yksittäiset osoitenumerot
-
Hakutila-parametrilla määritellään haetaanko lista hakutekstiin täsmäävistä paikoista vai yksittäisen paikan sijainti koordinaatteineen. Sallitut arvot:
-
lista
palauttaa korkeintaan 50 hakutekstiin täsmäävää paikkaa. -
sijainti
palauttaa korkeintaan yhden hakutekstiin täsmäävän paikan sijaintitietoineen.
-
-
max
Määrittelee palautettavien kohteiden maksimilukumäärän. Default: 5, korkeintaan 50.
Palvelu palauttaa onnistuneen kyselyn jälkeen seuraavat tiedot:
lista
-
result
Haulla löytyneen kohteen osoite- tai tunnuskentän arvo.
sijainti: osoitteet ja katunimet
-
katunimi
Osoitteen katunimi. -
osoitenumero
Osoitteen numero tai numerovälin alku. -
osoitenumero_loppu
Osoitteen numerovälin loppu, jos määritelty. -
kirjain
Osoitteen kirjain, jos määritelty. -
x
Kohteen itäkoordinaatti. -
y
Kohteen pohjoiskoordinaatti.
sijainti: kiinteistöt
-
tunnus
Kohteen tunnus. -
x
Kohteen itäkoordinaatti. -
y
Kohteen pohjoiskoordinaatti.
Esimerkkikyselyt
Listaa sanalla avia alkavat osoitteet.
https://gis.vantaa.fi/rest/paikannus/v2/geokoodaus/osoite/lista/avia
Hae sijainti osoitteelle Aviapoliksen asema
https://gis.vantaa.fi/rest/paikannus/v2/geokoodaus/osoite/sijainti/Aviapoliksen%20asema
Hae sijainti kiinteistölle 92-61-133-3
https://gis.vantaa.fi/rest/paikannus/v2/geokoodaus/kiinteisto/sijainti/92-61-133-3
Käänteinen geokoodaus
Käänteistä geokoodausta käytetään osoitteen https://gis.vantaa.fi/rest/paikannus/v2/reverse/<tyyppi>?crds[x]=<x>&crds[y]=<y>&max=<kohteiden max lkm>
kautta ja palvelulle määritellään parametreina tyyppi ja koordinaatit(x,y). Käänteinen geokoodaus hakee kohteita enintään 200 m etäisyydeltä määritellystä pisteestä.
- Tyyppi määritellään samoin kuin geokoodauksessa (ks. yllä).
-
Koordinaatit määritellään parametrin crds attribuutteina x ja y. URI muodostetaan tällöin
/crds[x]=<x-koord>&crds[y]=<y-koord>
jossa x on itäkoordinaatti ja y on pohjoiskoordinaatti EPSG:3879 järjestelmässä. -
max
Määrittelee palautettavien kohteiden maksimilukumäärän. Default: 5, korkeintaan 50.
Palvelu palauttaa kohteille seuraavat tiedot:
-
teksti
osoite, kiinteistötunnus tai katunimi. -
etaisyys
Etäisyys metreinä haetusta koordinaatista. -
x
Kohteen itäkoordinaatti (ei palauteta katunimiä haettaessa). -
y
Kohteen pohjoiskoordinaatti (ei palauteta katunimiä haettaessa).
Esimerkkikyselyt
Hae lähimmät osoitteet koordinaateista 25502088, 6686871.
https://gis.vantaa.fi/rest/paikannus/v2/reverse/kiinteisto?crds[x]=25502088&crds[y]=6686871
Hae lähimmät katunimet koordinaateista 25502088, 6686871.
https://gis.vantaa.fi/rest/paikannus/v2/reverse/kiinteisto?crds[x]=25502088&crds[y]=6686871
Hae lähimmät kiinteistöt koordinaateista 25502088, 6686871.
https://gis.vantaa.fi/rest/paikannus/v2/reverse/kiinteisto?crds[x]=25502088&crds[y]=6686871