API del buscador geográfico
Información recurso
- URL
- https://b5m.gipuzkoa.eus/api/2.0/toposearch2
- Formatos respuesta
- JSON, XML
- Autentificación
- No
- Ratio limitado
- Sí
Mediante esta API puedes buscar la toponimia y las direcciones postales de Gipuzkoa. El buscador geográfico del B5m utiliza esta API en buscadores y directorios geográficos.
Parámetros de la petición
| Parámetro | Descripción | Por defecto | Requerido |
|---|---|---|---|
| q | Nombre geográfico (toponímico) o de la dirección postal a buscar. Se admiten nombres de municipios, nombres de calles, nombres toponímicos (montes, arroyos, ríos, lugares...), etc. | - | No |
| lang | Idioma. Se aceptan tres: eu, es y en. Por defecto, eu. | eu | No |
| start | Número de respuestas a saltar. | 0 | No |
| rows | Número de respuestas de la búsqueda, después del parámetro start. | 1000000 | No |
| city | Nombre o código del municipio. | - | No |
| street | Nombre o código de la calle (hay que poner también el parámetro city). | - | No |
| riverbasin | Nombre de la cuenca hidrográfica. Buscará los elementos hidrográficos de la cuenca. | - | No |
| road | Nombre de la carretera. Buscará la carretera. | - | No |
| addr | Solo direcciones postales (addr=1). Es equivalente a type=dirección_postal. | 0 | No |
| viewbox | Para delimitar la búsqueda en una ventana geográfica. Formato de los parámetros: [longitud_mínima,latitud_máxima,longitud_máxima,latitud_mínima], en el sistema de coordenadas EPSG:4326. | - | No |
| pt | Si utilizamos la ventana geográfica, tenemos la posibilidad de partir la búsqueda por un punto central. De esta forma, el resultado se ordenará por distancia a ese centro. Formato de los parámetros: [latitud,longitud], en el sistema de coordenadas EPSG:4326. | - | No |
| dist | Distancia de búsqueda en kilómetros desde el punto del parámetro pt. | 80 | No |
| b5m_id | Búsqueda por el código b5m. | - | No |
| sort | En la búsqueda libre (parámetro q) orden de resultados por nombre por similitud de búsqueda. Opciones: [asc|desc]. | asc | No |
| nor | Clasificación normalizada del resultado, en porcentaje. Opciones: [0|1]. | 0 | No |
| numfound | Solo el número de resultados de la búsqueda. Opciones: [0|1]. | 0 | No |
| types | Solo la lista de los tipos de elementos a buscar. Opciones: [0|1]. | 0 | No |
| type | La búsqueda se hará sobre el tipo de elemento especificado. Ese tipo debe de ser uno de los contenidos en la lista del parámetro types. | 0 | No |
| format | Indica el formato de la respuesta. Debe de ser: json, xml o php. | json | No |
Ejemplos
- 1. Búsqueda simple
-
https://b5m.gipuzkoa.eus/api/2.0/toposearch2?q=txindoki
- 2. Búsqueda simple pero dentro de una ventana geográfica (viewbox) y a partir de un punto geográfico (pt)
-
https://b5m.gipuzkoa.eus/api/2.0/toposearch2?q=txindoki&viewbox=-2.02 43.40 -1.07 43.24&pt=43.30,-2.02
- 3. Búsqueda simple, dentro de una ventana geográfica (viewbox), a partir de un punto geográfico (pt) y especificando la distancia de búsqueda (dist)
-
https://b5m.gipuzkoa.eus/api/2.0/toposearch2?q=txindoki&viewbox=-2.02 43.40 -1.07 43.24&pt=43.30,-2.02&dist=10
- 4. Búsqueda de una dirección postal
-
https://b5m.gipuzkoa.eus/api/2.0/toposearch2?q=claudio anton luzuriaga 3
- 5. Búsqueda de una carretera
-
https://b5m.gipuzkoa.eus/api/2.0/toposearch2?q=gi-2131
- 6. Búsqueda del punto kilométrico de una carretera
-
https://b5m.gipuzkoa.eus/api/2.0/toposearch2?q=gi-2131 2
Respuesta
| Campo | Descripción |
|---|---|
| boundingbox | Cuadro de delimitación mínimo (Minimum Bounding Box) para un conjunto geográfico. |
| postcode | Codigo postal (si es una dirección postal). |
| door_number | Número de portal (si es una dirección postal). |
| distance | Distancia del elemento al cento de la búsqueda (parámetro pt). |
| importance | Importancia del elemento en el resultado de la búsqueda. Es un número, y cuanto mayor sea, mayor importancia tendrá el elemento. |
| b5m_id | Código b5m del elemento geográficoa. |
| GFA_code1 | Código 1 DFG del elemento geográfico. |
| GFA_code2 | Código 2 DFG del elemento geográfico. |
| GFA_id | Identificador DFG del elemento geográfico. |
| GFA_idcarre | Identificador DFG del elemento geográfico (si es una carretera). |
| display_name | Nombre del elemento geográfico en el idioma en el que se ha realizado la petición (lang). |
| type | Tipo de elemento geográfico. |
| road | Nombre de la carretera si es un Punto Kilométrico (PK). |
| KP | PK de la carretera. |
| way | Sentido del PK dentro de la carretera. |
| description | Descripción del elemento geográfico (si es una carretera). |
| city | Nombre del municipio. |
| street | Nombre de la calle. |
| lon | Longitud del centro del elemento geográfico. |
| lat | Latitud del centro del elemento geográfico. |
| map_link | URL para ver el elemento geográfico en el mapa b5m. |