Distancia entre municipios

Información recurso

URL
https://b5m.gipuzkoa.eus/api/2.0/distancemuni
Formatos respuesta
JSON
Autentificación
No
Ratio limitado
Sí

El objetivo de esta API es consultar las distancias y trayectos entre municipios. Estos itinerarios son las rutas más rápidas que se pueden realizar por carretera entre los ayuntamientos de cada municipio. Para el cálculo de las distancias entre municipios se han considerado tres tipos de situaciones:

1. Gipuzkoa - Gipuzkoa

Desde cualquier municipio de Gipuzkoa, hasta cualquier otro municipio de Gipuzkoa.

2. Gipuzkoa - Territorio colindante

Partiendo de cualquier municipio de Gipuzkoa, y llegando a cualquier municipio de un territorio colindante con Gipuzkoa.

3. Territorio colindante - Gipuzkoa

Partiendo de cualquier municipio de un territorio colindante con Gipuzkoa, y llegando a cualquier municipio de Gipuzkoa.

Nota: Los cuatro territorios administrativos colindantes de Gipuzkoa son los territorios colindantes, es decir, Álava, Bizkaia, Navarra y Pirineos Atlánticos.

Existen tres tipos de solicitudes para la ejecución del API: territorio, municipio y ruta. Este tipo de solicitud se indicará mediante el parámetro type.

1. Territorio

En este tipo de solicitud se mostrará la relación de territorios. El territorio que no sea Gipuzkoa tendrá la consideración de territorio colindante.

Parámetros de la petición

Parámetro Descripción Por defecto Requerido
type Tipo de petición. En este caso: territorio - Sí
lang Idioma. Se aceptan tres: eu, es y en. Por defecto, eu. eu No
region Nombre o código del territorio (GFA_codregion). - No
sort Orden de respuesta: territorio (por defecto) o código territorio No
format Indica el formato de la respuesta. Debe de ser: json, xml o php. json No

Ejemplos

1.1. Listado de territorios admitidos
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=territorio&lang=es
1.2. Selección de un territorio (Gipuzkoa) por nombre y código
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=territorio&region=gipuzkoa&lang=es
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=territorio&region=001&lang=es

Respuesta

Campo Descripción
GFA_codregion Código del territorio.
region Nombre del territorio.

2. Municipio

Esta petición se utiliza para obtener los nombres y códigos de los municipios.

Parámetros de la petición

Parámetro Descripción Por defecto Requerido
type Tipo de petición. En este caso: municipio - Sí
lang Idioma. Se aceptan tres: eu, es y en. Por defecto, eu. eu No
municipality Nombre o código del municipio. - No
region Nombre o código del territorio (para obtener el código ver apartado 1). - No
sort Orden de la respuesta: municipio (ordenado por municipios) o territorio (ordenado por territorios). territorio No
format Indica el formato de la respuesta. Debe de ser: json, xml o php. json No

Ejemplos

2.1. Listado de todos los municipios, ordenados por territorio
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=municipio&sort=territorio&lang=es
2.2. Listado de los municipios de Gipuzkoa
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=municipio&region=gipuzkoa&lang=es
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=municipio&region=001&lang=es
2.3. Listado de municipios que comienzan con el texto ¿irun¿, ordenados por municipio
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=municipio&municipality=irun&sort=municipio&lang=es

Respuesta

Campo Descripción
GFA_codmunicipality Código del municipio.
municipality Nombre del municipio.
GFA_codregion Código del territorio.
region Nombre del territorio.

3. Ruta

Solicitud de la ruta y la distancia entre municipios.

Parámetros de la petición

Parámetro Descripción Por defecto Requerido
type Tipo de petición. En este caso: ruta - Sí
lang Idioma. Se aceptan tres: eu, es y en. Por defecto, eu. eu No
municipality1 Nombre o código del municipio de origen del recorrido (ver apartado 2 para obtener el código). - Sí
municipality2 Nombre o código del municipio de destino del recorrido (ver apartado 2 para obtener el código). - No
region1 Nombre o código del territorio del origen del recorrido (ver apartado 1 para obtener el código). - No
region2 Nombre o código del territorio del destino del recorrido (ver apartado 1 para obtener el código). - No
sort Orden de la respuesta: se admite la combinación de los cuatro primeros campos separados por coma. Por ejemplo: municipality1, region1 (para ordenar por municipios y territorios de origen). - No
format Indica el formato de la respuesta. Debe de ser: json, xml o php. json No

Nota: para obtener una respuesta más precisa, recomendamos utilizar el código en los siguientes parámetros: municipality1, municipality2, region1 y region2.

Ejemplos

3.1. Distancia y recorrido entre dos municipios, utilizando los códigos de municipios
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=ruta&municipality1=0069&municipality2=2028&lang=es
3.2. A partir de un municipio de Gipuzkoa, lista de las distancias y recorridos al resto de los municipios de Gipuzkoa
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=ruta&municipality1=eibar&region2=gipuzkoa&lang=es
3.3. A partir de un municipio de Gipuzkoa, lista de las distancias y recorridos a los municipios de Bizkaia (usando nombres)
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=ruta&municipality1=aduna&region2=bizkaia&lang=es
3.4. A partir de un municipio de un territorio colindante, lista de las distancias y los recorridos a los municipios de Gipuzkoa (usando nombres)
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=ruta&municipality1=bayonne&region2=gipuzkoa&lang=es
3.5. A partir de todos los municipios del territorio colindante de Álava, lista de las distancias y los recorridos a los municipios de Gipuzkoa (usando nombres)
https://b5m.gipuzkoa.eus/api/2.0/distancemuni?type=ruta&region1=álava&region2=gipuzkoa&lang=es

Respuesta

Campo Descripción
b5mcode Código b5m de la ruta.
map_link Enlace para ver el mapa de la ruta.
GFA_codmunicipality1 Código del municipio de salida.
municipality1 Nombre del municipio de salida.
GFA_codregion1 Código del territorio de salida.
region1 Nombre del territorio de salida.
GFA_codmunicipality2 Código del municipio de llegada.
municipality2 Nombre del municipio de llegada.
GFA_codregion2 Código del territorio de llegada.
region2 Nombre del territorio de llegada.
distance Distancia de la ruta (en kilómetros).
date Fecha del cálculo de la ruta (AAAA-MM-DD).

Cálculo de la ruta

Los cálculos de los recorridos se han realizado con la máquina analítica del proyecto OSRM, que utiliza los datos de la iniciativa colaborativa OpenStreetMap.

Atención: La Diputación Foral de Gipuzkoa no garantiza la ausencia de errores en estos cálculos.