API de consultas geográficas
Información recurso
- URL
- https://b5m.gipuzkoa.eus/api/2.0/topoquery2
- Formatos respuesta
- JSON, XML
- Autentificación
- No
- Ratio limitado
- No
Por medio de esta API puedes consultar la toponimia y las direcciones postales de Gipuzkoa. Así, puedes acceder tanto a los datos alfanuméricos de los elementos geográficos (nombres, direcciones postales, datos de superficies, etc.), como a la información geográfica vectorial de puntos, líneas y polígonos (en formato GeoJSON). El visor 2.0 del b5m utiliza esta API para determinar las ubicaciones geográficas y explorar los elementos geográficos. Puedes utilizar la API de tres maneras:
1. Ver un código b5m en un mapa
Has conseguido un código b5m a través de la API del buscador geográfico y quieres situar ese lugar en un mapa. Para conseguirlo, tienes que hacer esto:
- Queremos ver la posición y la imagen vectorial del código D_A57413 del b5m (correspondiente a la dirección Julio Caro Baroja 2 de San Sebastián, oficina del b5m)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?b5mcode=D_A57413&lang=es
2. ¿Qué es esto?
Quieres saber qué es un punto de Gipuzkoa. Una vez recogido el par de coordenadas de ese punto, tienes que hacer esto:
- Hemos obtenido un par de coordenadas geográficas de Gipuzkoa (por ejemplo, pinchando en un mapa) y queremos saber qué es el punto clicado
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.008015,43.308970&z=16&lang=es
Tienes que tener en cuenta que los valores de los parámetros z (nivel de zoom del posible mapa) o scale (escala del posible mapa) influirán en el resultado (mira en la última tabla de este documento qué se está buscando en cada caso). Si quieres buscar entre todos los elementos de Gipuzkoa, no uses ninguno de estos dos parámetros (pero ten en cuenta que la búsqueda puede ser muy lenta, ya que se buscará entre todos los elementos georreferenciados de la base de datos geográfica de Gipuzkoa).
3. ¿Qué hay aquí? (poi_pointsofinterest)
Si quieres saber qué hay en una zona de Gipuzkoa (puntos de interés en la administración, sanidad, cultura y turismo), debes recoger las coordenadas del recuadro de esa zona, tienes que poner el elemento geográfico llamado poi_pointsofinterest en el parámetro featuretypenames y hacer lo siguiente:
- Hemos obtenido las coordenadas del bounding box de una recuadro en Gipuzkoa (por ejemplo, situándonos en un mapa) y queremos saber qué hay en esa zona (puntos de interés)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.0256,43.308573,-1.99501,43.31381&featuretypenames=poi_pointsofinterest&z=18&lang=es
Parámetros de la petición
| Parámetro | Descripción | Por defecto | Requerido |
|---|---|---|---|
| coors | Coordenadas del punto o del recuadro de consulta (si es un recuadro, hay que definirlo así). El área máxima del recuadro es de 100 km2, si es más grande se mostrará este mensaje. | - | Sí, si no se pone el parámetro b5mcode |
| offset | Radio de búsqueda (en metros), que sólo se tendrá en cuenta cuando se utilice el parámetro coors. | 1 | No |
| b5mcode | Código b5m, que se puede obtener con la API del buscador geográfico; si se pone, el parámetro coors y no se tendrá en cuenta. | - | No |
| srs | El sistema de referencia de coordenadas (SRS expresado en el código EPSG. Si no se da, el sistema lo adivinará. Los SRS compatibles son: EPSG:4326, EPSG:25830 y EPSG:3857. | No, el sistema lo puede adivinar | No |
| querytype | Tipo de consulta: regular o whatishere. En ese segundo caso la consulta se realizará por puntos de interés. | regular | No |
| z | Nivel de zoom del posible mapa. Se admitirán valores comprendidos entre 9 y 19. Este parámetro afecta a los objetos geográficos a buscar, tal y como se indica en la tabla inferior | - | No |
| scale | Escala del posible mapa. Se admitirán valores comprendidos entre 10000000 (escala 1:10.000.000) y 500 (escala 1:500). Este parámetro afecta a los objetos geográficos a buscar, tal y como se indica en la tabla inferior | - | No |
| featuretypenames | Relación de tipos de elementos a consultar (separados por comas); si no se pone, en la consulta se utilizarán todos los tipos de elementos. | todos | No |
| featuretypes | Muestra la lista de tipos de elementos si ponemos el valor «true»; es útil si queremos utilizar el parámetro featuretypenames. | false | No |
| downloadlist | Muestra la lista de tipos de descarga (cartografía, LIDAR, ortofotos, etc.) si ponemos el valor «true». | false | No |
| dwtypeid | Identificador del tipo de descarga. Es un número que se obtiene de la lista de downloadlist. | false | No |
| downloads | En una consulta a través de un punto geográfico (¿Qué es esto?, utilizando el parámetro coors), existe la posibilidad de proporcionar la información con las descargas vinculadas a ese punto (¡pero ojo, así la respuesta será más lenta!), dependiendo de estas condiciones: si downloads=0, la información se suministrará sin descargas vinculadas (opción predeterminada), si downloads=1 se dará con las descargas vinculadas y si downloads=2 sólo se dará información de las descargas (como el parámetro featuretypenames=dw_download). | 0 | No |
| geom | Si ponemos el valor «false» no muestra la geometría de los elementos. | true | No |
| lang | Idioma. Se aceptan tres: eu, es y en. | el que indica el navegador | No |
| format | Indica el formato de la respuesta. Debe de ser: json, xml o php. | json | No |
Más ejemplos
- 1. Consulta de una coordenada o punto (en el sistema de coordenadas EPSG:4326, indicando longitud y latitud)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.008015,43.308970&lang=es
- 2. Consulta del punto anterior, pero indicando el nivel de zoom (z=19, los resultados serán más precisos)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.008015,43.308970&z=19&lang=es
- 3. Consulta de una coordenada o punto (en el sistema de coordenadas EPSG:25830, con las coordenadas x e y)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=565019,4776036&lang=es
- 4. Consulta del punto anterior incluyendo las descargas vinculadas (más lento)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=565019,4776036&downloads=1&lang=es
- 5. Consulta de un código b5m, en el sistema de coordenadas EPSG:4326
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?b5mcode=M_010&srs=epsg:4326&lang=es
- 6. Listar los nombres de los elementos disponibles (featuretypes) (Nota: todavía no están disponibles todos los elementos de b5m)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?featuretypes=true&lang=es
- 7. Consulta de un punto indicando el elemento en el que hay que buscar (m_municipalities)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.397771,43.036122&featuretypenames=m_municipalities&lang=es
- 8. Consulta de un punto, pero solo las descargas correspondientes a ese punto (cartografía, ortofotos, datos LIDAR, etc.) (dw_download)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.397771,43.036122&featuretypenames=dw_download&lang=es
- 9. Consulta de una ventana geográfica, y, como en en el ejemplo anterior, solo las descargas correspondientes a esa ventana (cartografía, ortofotos, datos LIDAR, etc.) (dw_download)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-1.967,43.276,-1.939,43.287&featuretypenames=dw_download&lang=es
- 10. Mostrar la lista de tipos de descargas
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?downloadlist=true&lang=es
- 11. Consulta de una ventana geográfica, pero sólo un tipo de descarga en dicha ventana (dw_type_id=2, es decir, «Base topográfica») (parámetros dw_download y dwtypeid)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-1.967,43.276,-1.939,43.287&featuretypenames=dw_download&dwtypeid=2&lang=es
(más adelante pondremos más ejemplos)
Respuesta
| Campo | Descripción |
|---|---|
| info | Información sobre la API: licencias, metadatos, tiempo de respuesta, mensajes, etc. |
| coors | La solicitud de coordenada recibida. |
| offset | Información del radio de búsqueda. |
| z | Nivel de zoom empleado para hacer la búsqueda. |
| crs | El sistema de referencia espacial utilizado. |
| featuretypenames | Relación de elementos utilizados para la consulta. |
| numberMatched | Cantidad de elementos encontrados. |
| features | Coincidencias geográficas encontradas en un elemento determinado, en formato GeoJSON. Los datos proceden de una solicitud GetFeature de un servicio OGC WFS; más concretamente del servicio WFS gipuzkoa_wfs del b5m. |
| downloads | En el caso «¿Qué es esto?» (segundo caso), la lista de descargas encontradas en ese lugar (ortofotos, base cartográfica, datos BTA, datos lídar, etc.). |
| more_info | Igual que en el caso anterior, pero ahora indica si se han encontrado más elementos en la búsqueda por coordenadas (siempre referido al nivel de zoom indicado en la petición y si las coordenadas corresponden a un punto en el mapa). |
| external_links | Si la búsqueda ha sido a partir de un punto, la respuesta dará información de los enlaces externos. |