O API é un mecanismo que permite consultar a base de datos semántica de datos.gob.es. Proporciona acceso á información do Catálogo de datos e as URIs definidas nos anexos IV e V de la Norma Técnica de Interoperabilidade de Reutilización de recursos da información.
Estas consultas realízanse baseándose nuns criterios que pode elixir o usuario e utilizando identificadores uniformes de recursos (URI).
Formatos de resposta
A información dispoñible a través do API pódese obter en diferentes formatos. Os formatos dispoñibles son: json, xml, rdf, ttl e csv.
JSON é o formato da resposta por defecto; por exemplo: se se accede ao seguinte recurso de API a través do navegador http://datos.gob.es/apidata/catalog/dataset, verase o resultado en formato JSON.
Hai dúas opcións para indicar o formato de resposta que se desexa:
- Mediante o parámetro
'Accept'nas cabeceiras da petición. Por exemplo:Accept:application/rdf+xml - Indicando o formato mediante a súa extensión na petición. Por exemplo:
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
A API ofrece unha serie de parámetros que permiten personalizar as respostas:
| Parámetro | Descrición | Exemplos |
|---|---|---|
_sort | Con este parámetro pódense ordenar os resultados en función de un ou varios campos da resposta. Débese indicar o nome do campo polo que se desexan ordenar os resultados. Para inverter a orde hai que engadir o símbolo menos '-' diante do nome do campo. Pódense combinar varios campos usando a coma ',' como separador entre eles. | Por exemplo, se queremos obter todos os datasets ordenados por data descendente e título:http://datos.gob.es/apidata/catalog/dataset.json?_sort=-issued,title |
_pageSize | Este parámetro utilízase para fixar o número de resultados por páxina. O valor máximo é 50. | Por exemplo, para obter os resultados un por un:http://datos.gob.es/apidata/catalog/dataset.xml?_pageSize=1 |
_page | Este parámetro utilízase para indicar o número de páxina no que nos encontramos. A páxina inicial é 0. | Por exemplo, para estar na terceira páxina dos resultados: http://datos.gob.es/apidata/catalog/dataset.xml?_pageSize=1&_page=2 |
Chamadas dispoñibles
Catálogo de datos
Conxunto de chamadas que permiten consultar o Catálogo de datos de datos.gob.es.
| Operación | Descrición | Exemplos |
|---|---|---|
| Obter todos os conxuntos de datos | http://datos.gob.es/apidata/catalog/dataset | |
| Obter un conxunto de datos polo seu identificador URI | http://datos.gob.es/apidata/catalog/dataset/{id}Débese especificar o valor de {id}. | Por exemplo, se o {id} ten o 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', a chamada 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 |
| Obter conxuntos de datos cun determinado título | http://datos.gob.es/apidata/catalog/dataset/title/{title}Débese especificar o valor de {title}. Pode ser parte do título. | Por exemplo, se {title} ten o valor: 'emprego', a chamada será: http://datos.gob.es/apidata/catalog/dataset/title/emprego |
| Obter os conxuntox de datos dun determinado publicador a través do seu identificador | http://datos.gob.es/apidata/catalog/dataset/publisher/{id}Débese especificar o valor de {id}. | Por exemplo, se {id} ten o valor: 'A16003011', a chamada será: http://datos.gob.es/apidata/catalog/dataset/publisher/A16003011 |
| Obter os conxuntos de datos dunha determinada categoría ou temática a través do seu identificador | http://datos.gob.es/apidata/catalog/dataset/theme/{id}Débese especificar o valor de {id}. | Por exemplo, se {id} ten o valor: 'hacienda', a chamada será: http://datos.gob.es/apidata/catalog/dataset/theme/hacienda |
| Obter os conxuntos de datos que ten distribucións nun determinado formato | http://datos.gob.es/apidata/catalog/dataset/format/{format} | Por exemplo, se {format} ten o valor: 'csv', a chamada será: http://datos.gob.es/apidata/catalog/dataset/format/csv |
| Obter os conxuntos de datos que conteñen unha determinada etiqueta | http://datos.gob.es/apidata/catalog/dataset/keyword/{keyword} | Se {keyword} ten o valor: 'gastos', a chamada será: http://datos.gob.es/apidata/catalog/dataset/keyword/gastos |
| Obter os conxuntos de datos que pertencen a un determinado ámbito xeográfico | http://datos.gob.es/apidata/catalog/dataset/spatial/{spatialWord1}/{spatialWord2}Nesta chamada utilízanse dous parámetros: {spatialWord1} e {spatialWord2}. | Se {spatialWord1} ten o valor: 'Autonomia' e {spatialWord2} ten o valor: 'Pais-Vasco' a chamada será: http://datos.gob.es/apidata/catalog/dataset/spatial/Autonomia/Pais-Vasco |
| Obter os conxuntos de datos que foron actualizados entre dúas datas | http://datos.gob.es/apidata/catalog/dataset/modified/begin/{beginDate}/end/{endDate}Nesta chamada utilízanse dous parámetros: {beginDate} e {endDate}, cuxo formato debe ser AAAA-MM-DDTHH:mmZ. | Se {beginDate} ten o valor: 2016-04-18T00:00Z e {endDate} ten o valor: 2016-06-30T00:00Z a chamada 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 | Descrición | Exemplos |
|---|---|---|
| Obter todas as distribucións | http://datos.gob.es/apidata/catalog/distribution | |
| Obter as distribucións dun conxunto de datos identificado polo seu identificador URI | http://datos.gob.es/apidata/catalog/distribution/dataset/{id}Débese especificar o valor de {id}. | Se {id} ten o 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', a chamada 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 |
| Obter as distribucións que están nun determinado formato | http://datos.gob.es/apidata/catalog/distribution/format/{format} | Se {format} ten o valor: 'csv', a chamada será: http://datos.gob.es/apidata/catalog/distribution/format/csv |
| Operación | Descrición | Exemplos |
|---|---|---|
| Obter todos os publicadores | http://datos.gob.es/apidata/catalog/publisher |
| Operación | Descrición | Exemplos |
|---|---|---|
| Obter todas opcións de cobertura xeográfica con conxuntos de datos no catálogo | http://datos.gob.es/apidata/catalog/spatial |
| Operación | Descrición | Exemplos |
|---|---|---|
| Obter todas as categorías ou temáticas con conxuntos de datos no catálogo | http://datos.gob.es/apidata/catalog/theme |
Norma técnica de interoperabilidade
Conxunto de chamadas que permiten consultar o contido da taxonomía de sectores primarios e a identificación de cobertura xeográfica definidas nos Anexos IV e V da Norma Técnica de Interoperabilidade de Reutilización de recursos da información (NTI).
| Operación | Descrición | Exemplos |
|---|---|---|
| Obter todos os sectores primarios | http://datos.gob.es/apidata/nti/public-sector | |
| Obter un determinado sector polo seu identificador URI | http://datos.gob.es/apidata/nti/public-sector/{id}Débese especificar o valor de {id}. | Por exemplo, se o {id} ten o valor: 'comercio', a chamada será: http://datos.gob.es/apidata/nti/public-sector/comercio |
| Operación | Descrición | Exemplos |
|---|---|---|
| Obter todas as provincias | http://datos.gob.es/apidata/nti/territory/Province | |
| Obter unha determinada provincia identificada polo seu identificador URI | http://datos.gob.es/apidata/nti/territory/Province/{id}Débese especificar o valor de {id} | Por exemplo, se o {id} ten o valor: 'Madrid', a chamada será: http://datos.gob.es/apidata/nti/territory/Province/Madrid. |
| Obter todas as Comunidades Autónomas | http://datos.gob.es/apidata/nti/territory/Autonomous-region | |
| Obter unha determinada comunidade autonomía identificada polo seu identificador URI | http://datos.gob.es/apidata/nti/territory/Autonomous-region/{id}Débese especificar o valor de {id}. | Por exemplo, se o {id} ten o valor: 'Comunidad-Madrid', a chamada será: http://datos.gob.es/apidata/nti/territory/Autonomous-region/Comunidad-Madrid |
| Obter o país | http://datos.gob.es/apidata/nti/territory/Country/España |