El API es un mecanismo que permite consultar la base de datos semántica de datos.gob.es. Proporciona acceso a la información del Catálogo de datos y las URIs definidas en los anexos IV y V de la Norma Técnica de Interoperabilidad de Reutilización de recursos de la información.
Estas consultas se realizan en base a unos criterios que puede elegir el usuario y utilizando identificadores uniformes de recursos (URI).
Formatos de respuesta
La información disponible a través del API puede obtenerse en diferentes formatos. Los formatos disponibles son: json, xml, rdf, ttl y csv.
JSON es el formato de la respuesta por defecto; por ejemplo: si se accede a al siguiente recurso de API a través del navegador http://datos.gob.es/apidata/catalog/dataset, se verá el resultado en formato JSON.
Hay dos opciones para indicar el formato de respuesta que se desea:
- Mediante el parámetro
'Accept'en las cabeceras de la petición. Por ejemplo:Accept:application/rdf+xml - Indicando el formato mediante su extensión en la petición. Por ejemplo:
http://datos.gob.es/apidata/catalog/dataset.xml
| Formato | 1. Header 'Accept' | 2. Extensión de formato |
|---|---|---|
| JSON | application/json | .json |
| XML | application/xml | .xml |
| RDF | application/rdf+xml | .rdf |
| Turtle | application/x-turtle | .turtle |
| CSV | text/csv | .csv |
Parámetros API
La API ofrece una serie de parámetrosque permiten personalizar las respuestas:
| Parámetro | Descripción | Ejemplos |
|---|---|---|
_sort | Con este parámetro se pueden ordenar los resultados en función de uno o varios campos de la respuesta. Se debe indicar el nombre del campo por el que se desean ordenar los resultados. Para invertir el orden hay que añadir el símbolo menos '-' delante del nombre del campo. Se pueden combinar varios campos usando la coma ',' como separador entre ellos. | Por ejemplo, para obtener todos los dataset ordenados por fecha descendente y título:http://datos.gob.es/apidata/catalog/dataset.json?_sort=-issued,title |
_pageSize | Este parámetro se utiliza para fijar el número de resultados por página. El valor máximo es 50. | Por ejemplo, para obtener los resultados de uno en uno:http://datos.gob.es/apidata/catalog/dataset.xml?_pageSize=1 |
_page | Este parámetro se utiliza para indicar el número de página en el que nos encontramos. La página inicial es 0. | Por ejemplo, para estar en la tercera página de los resultados: http://datos.gob.es/apidata/catalog/dataset.xml?_pageSize=1&_page=2 |
Llamadas disponibles
Catálogo de datos
Conjunto de llamadas que permiten consultar el Catálogo de datos de datos.gob.es.
| Operación | Descripción | Ejemplos |
|---|---|---|
| Obtener todos los conjuntos de datos | http://datos.gob.es/apidata/catalog/dataset | |
| Obtener un conjunto de datos por su identificador URI | http://datos.gob.es/apidata/catalog/dataset/{id}Se debe especificar el valor de {id}. | Por ejemplo, si el {id} tiene el valor 'a16003011-empresas-y-personas-empleadas-en-la-c-a-de-euskadi-supervivientes-en-2015-altas-en-los-cinco-anos-anteriores-por-territorio-y-comarca-de-sede-social', la llamada será:http://datos.gob.es/apidata/catalog/dataset/a16003011-empresas-y-personas-empleadas-en-la-c-a-de-euskadi-supervivientes-en-2015-altas-en-los-cinco-anos-anteriores-por-territorio-y-comarca-de-sede-social |
| Obtener conjuntos de datos con un determinado título | http://datos.gob.es/apidata/catalog/dataset/title/{title}Se debe especificar el valor de {title}. Puede ser parte del título. | Por ejemplo, si {title} tiene el valor: 'empleo', la llamada será:http://datos.gob.es/apidata/catalog/dataset/title/empleo |
| Obtener los conjunto de datos de un determinado publicador a través de su identificador | http://datos.gob.es/apidata/catalog/dataset/publisher/{id}Se debe especificar el valor de {id}. | Por ejemplo, si {id} tiene el valor: 'A16003011', la llamada será: http://datos.gob.es/apidata/catalog/dataset/publisher/A16003011 |
| Obtener los conjuntos de datos de una determinada categoría o temática a través de su identificador | http://datos.gob.es/apidata/catalog/dataset/theme/{id}Se debe especificar el valor de {id}. | Por ejemplo, si {id} tiene el valor: 'hacienda', la llamada será: http://datos.gob.es/apidata/catalog/dataset/theme/hacienda |
| Obtener los conjuntos de datos que tiene distribuciones en undeterminado formato | http://datos.gob.es/apidata/catalog/dataset/format/{format} | Por ejemplo, si {format} tiene el valor: 'csv', la llamada será: http://datos.gob.es/apidata/catalog/dataset/format/csv |
| Obtener los conjuntos de datos que contienen una determinada etiqueta | http://datos.gob.es/apidata/catalog/dataset/keyword/{keyword} | Si {keyword} tiene el valor: 'gastos', la llamada será:http://datos.gob.es/apidata/catalog/dataset/keyword/gastos |
| Obtener los conjuntos de datos que pertenecen un determinado ámbito geográfico | http://datos.gob.es/apidata/catalog/dataset/spatial/{spatialWord1}/{spatialWord2}En esta llamada se utilizan dos parámetros: {spatialWord1} y {spatialWord2}. | Si {spatialWord1} tiene el valor: 'Autonomia' y {spatialWord2} tiene el valor: 'Pais-Vasco' la llamada será: http://datos.gob.es/apidata/catalog/dataset/spatial/Autonomia/Pais-Vasco |
| Obtener los conjuntos de datos que han sido actualizados entre dos fechas | http://datos.gob.es/apidata/catalog/dataset/modified/begin/{beginDate}/end/{endDate}En esta llamada se utilizan dos parámetros: {beginDate} y {endDate}, cuyo formato debe ser AAAA-MM-DDTHH:mmZ. | Si {beginDate} tiene el valor: 2016-04-18T00:00Z y {endDate} tiene el valor: 2016-06-30T00:00Z la llamada será: http://datos.gob.es/apidata/catalog/dataset/modified/begin/2016-04-18T00:00Z/end/2016-06-30T00:00Z?_sort=title&_pageSize=10&_page=0 |
| Operación | Descripción | Ejemplos |
|---|---|---|
| Obtener todas las distribuciones | http://datos.gob.es/apidata/catalog/distribution | |
| Obtener las distribuciones de un conjunto de datos identificado por su identificador URI | http://datos.gob.es/apidata/catalog/distribution/dataset/{id}Se debe especificar el valor de {id}. | Si {id} tiene el valor 'a16003011-empresas-y-personas-empleadas-en-la-c-a-de-euskadi-supervivientes-en-2015-altas-en-los-cinco-anos-anteriores-por-territorio-y-comarca-de-sede-social', la llamada será:http://datos.gob.es/apidata/catalog/distribution/dataset/a16003011-empresas-y-personas-empleadas-en-la-c-a-de-euskadi-supervivientes-en-2015-altas-en-los-cinco-anos-anteriores-por-territorio-y-comarca-de-sede-social |
| Obtener las distribuciones que están en un determinado formato | http://datos.gob.es/apidata/catalog/distribution/format/{format} | Si {format} tiene el valor: 'csv', la llamada será:http://datos.gob.es/apidata/catalog/distribution/format/csv |
| Operación | Descripción | Ejemplos |
|---|---|---|
| Obtener todos los publicadores | http://datos.gob.es/apidata/catalog/publisher |
| Operación | Descripción | Ejemplos |
|---|---|---|
| Obtener todas opciones de cobertura geográfica con conjuntos de datos en elcatálogo | http://datos.gob.es/apidata/catalog/spatial |
| Operación | Descripción | Ejemplos |
|---|---|---|
| Obtener todas las categorías o temáticas con conjuntos de datos en el catálogo | http://datos.gob.es/apidata/catalog/theme |
Norma técnica de interoperabilidad
Conjunto de llamadas que permiten consultar el contenido de la taxonomía de sectores primarios y la identificación de cobertura geográfica definidas en los Anexos IV y V de la Norma Técnica de Interoperabilidad de Reutilización de recursos de la información (NTI).
| Operación | Descripción | Ejemplos |
|---|---|---|
| Obtener todos los sectores primarios | http://datos.gob.es/apidata/nti/public-sector | |
| Obtener un determinado sector por su identificador URI | http://datos.gob.es/apidata/nti/public-sector/{id}Se debe especificar el valor de {id}. | Por ejemplo, si el {id} tiene el valor 'comercio', la llamada será: http://datos.gob.es/apidata/nti/public-sector/comercio |
| Operación | Descripción | Ejemplos |
|---|---|---|
| Obtener todas las provincias | http://datos.gob.es/apidata/nti/territory/Province | |
| Obtener una determinada provincia identificada por su identificadorURI | http://datos.gob.es/apidata/nti/territory/Province/{id}Se debe especificar el valor de {id} | Por ejemplo, si el {id} tiene el valor 'Madrid', la llamada será: http://datos.gob.es/apidata/nti/territory/Province/Madrid. |
| Obtener todas las Comunidades autónomas | http://datos.gob.es/apidata/nti/territory/Autonomous-region | |
| Obtener una determinada comunidad autonomía identificada por su identificador URI | http://datos.gob.es/apidata/nti/territory/Autonomous-region/{id}Se debe especificar el valor de {id}. | Por ejemplo, si el {id} tiene el valor 'Comunidad-Madrid', la llamada será: http://datos.gob.es/apidata/nti/territory/Autonomous-region/Comunidad-Madrid |
| Obtener el país | http://datos.gob.es/apidata/nti/territory/Country/España |