Bilatzaile geografikoaren APIa

Baliabideari buruzko informazioa

URL
https://b5m.gipuzkoa.eus/api/2.0/toposearch2
Erantzun formatuak
JSON, XML
Autentifikazioa
Ez
Ratio mugatua
Bai

API honen bidez, Gipuzkoako toponimia eta posta helbideak bila ditzakezu. B5m-ko bilatzaile geografikoak API hau erabiltzen du bilatzaile eta direktorio geografikoetan.

Eskaeraren parametroak

Parametroa Deskribapena Lehenetsia Beharrezkoa
q Bilatu beharreko izen geografikoa (toponimikoa) edo posta helbidearen izena. Izen hauek onartzen dira, besteak beste: udalerrien izenak, kaleen izenak, izen toponimikoak (mendiak, errekak, ibaiak, lekuak...) eta abar. - Ez
lang Hizkuntza. Hiru onartu dira: eu, es eta en. Lehenetsia, eu. eu Ez
start Jauzi egin beharreko erantzunen kopurua. 0 Ez
rows Bilaketaren erantzunen kopurua, start parametroaren ondoren. 1000000 Ez
city Udalerriaren izena edo udalerriaren kodea. - Ez
street Kalearen izena edo kalearen kodea (city parametroa ere jarri behar da). - Ez
riverbasin Arro hidrografikoaren izena. Arro horren elementu hidrografikoak bilatuko ditu. - Ez
road Errepidearen izena. Errepidea bilatuko du. - Ez
addr Posta helbideak besterik ez (addr=1). Honen baliokidea da: type=posta_helbidea. 0 Ez
viewbox Bilaketa leiho geografiko batean mugatzeko. Parametroen formatua: [longitude_minimoa,latitude_minimoa,longitude_maximoa,latitude_maximoa], EPSG:4326 koordenatu sisteman. - Ez
pt Leiho geografikoa erabiliz gero, badugu aukera bilaketa erdigune puntu batetik abiatzeko. Horrela, emaitza erdigunearekiko distantziaren arabera ordenatuko da. Parametroaren formatua: [longitudea,latitudea], EPSG:4326 koordenatu sisteman. - Ez
dist Bilaketaren distantzia, kilometrotan, pt parametroaren puntutik abiatuta. 80 Ez
b5m_id Bilaketa b5m kodea erabilita. - Ez
sort Bilaketa librean (q parametroa), emaitzen ordena izenaren arabera, bilaketaren antzekotasuna aintzat hartuta. Aukerak: [asc|desc]. asc Ez
nor Emaitzaren sailkapen normalizatua, ehunekoan. Aukerak: [0|1]. 0 Ez
numfound Bilaketaren emaitza-kopurua besterik ez. Aukerak: [0|1]. 0 Ez
types Bilatu beharreko elementu-moten zerrenda bakarrik. Aukerak: [0|1]. 0 Ez
type Zehaztutako elementu-motaren gainean egingo da bilaketa. Mota horrek types parametroaren zerrendako edukietako bat izan behar du. 0 Ez
format Erantzunaren formatua adierazten du. Honela izan behar du: json, xml edo php. json Ez

Adibideak

1. Bilaketa arrunta
https://b5m.gipuzkoa.net/api/2.0/toposearch2?q=txindoki&lang=eu
2. Bilaketa arrunta, baina leiho geografiko baten barruan (viewbox) eta puntu geografiko batetik abiatuta (pt)
https://b5m.gipuzkoa.net/api/2.0/toposearch2?q=txindoki&viewbox=-2.02,43.30,-1.97,43.32&pt=-2.00,43.31&lang=eu
3. Bilaketa arrunta, leiho geografiko baten barruan (viewbox), puntu geografiko batetik abiatuta (pt) eta bilaketaren distantzia zehaztuta (dist)
https://b5m.gipuzkoa.net/api/2.0/toposearch2?q=txindoki&viewbox=-2.02,43.30,-1.97,43.32&pt=-2.00,43.31&dist=10&lang=eu
4. Posta helbide baten bilaketa
https://b5m.gipuzkoa.net/api/2.0/toposearch2?q=claudio anton luzuriaga 3&lang=eu
5. Errepide baten bilaketa
https://b5m.gipuzkoa.net/api/2.0/toposearch2?q=gi-2131&lang=eu
6. Errepide bateko kilometro-puntu baten bilaketa
https://b5m.gipuzkoa.net/api/2.0/toposearch2?q=gi-2131 2&lang=eu

Erantzuna

Eremua Deskribapena
boundingbox Multzo geografiko baterako gutxieneko mugaketaren koadroa (Minimum Bounding Box).
postcode Posta kodea (posta helbide bat bada).
door_number Atari zenbakia (posta helbide bat bada).
distance Elementuaren distantzia bilaketaren erdigunetik (pt parametroa).
importance Elementuaren garrantzia bilaketaren emaitzan. Zenbaki bat da, eta zenbat eta handiago izan, orduan eta garrantzi handiagokoa izango du elementuak.
b5m_id Elementu geografikoaren b5m kodea.
GFA_code1 Elementu geografikoaren GFA kode 1.
GFA_code2 Elementu geografikoaren GFA kode 2.
GFA_id Elementu geografikoaren GFA identifikatzailea.
GFA_idcarre Elementu geografikoaren GFA identifikatzailea (errepide bat bada).
display_name Elementu geografikoaren izena, eskaera egin den hizkuntzan (lang).
type Elementu geografikoaren mota.
road Errepidearen izena, Kilometro Puntu (KP) bat bada.
KP Errepidearen KPa.
way KPren norabidea errepidearen baitan.
description Elementu geografikoaren deskribapena (errepide bat bada).
city Udalerriaren izena.
street Kalearen izena.
lon Elementu geografikoaren zentroaren longitudea.
lat Elementu geografikoaren zentroaren latitudea.
map_link Elementu geografikoa b5m-ko mapan ikusteko URLa.