API

L'API és un mecanisme que permet consultar la base de dades semàntica de datos.gob.es. Proporciona accés a la informació del catàleg de dades i els URI definits als annexos IV i V de la Norma tècnica d'interoperabilitat de reutilització de recursos de la informació.

Aquestes consultes es fan partint d'uns criteris que pot triar l'usuari i utilitzant identificadors uniformes de recursos (URI).

Formats de resposta

La informació disponible a través de l'API es pot obtenir en diferents formats. Els formats disponibles són: json, xml, rdf, ttl i csv.

JSON és el format de resposta per defecte; per exemple, si s'accedeix al següent recurs d'API a través del navegador http://datos.gob.es/apidata/catalog/dataset, es veurà el resultat en format JSON.

Hi ha dues opcions per indicar el format de resposta desitjat:

  1. Mitjançant el paràmetre 'Accept' a les capçaleres de la petició. Per exemple: Accept:application/rdf+xml
  2. Indicant el format mitjançant l'extensió en la petició. Per exemple: http://datos.gob.es/apidata/catalog/dataset.xml
Format1. Header 'Accept'2. Extensió de format
JSONapplication/json.json
XMLapplication/xml.xml
RDFapplication/rdf+xml.rdf
Turtleapplication/x-turtle.turtle
CSVtext/csv.csv

Paràmetres API

L'API ofereix una sèrie de paràmetres que permeten personalitzar les respostes:

ParàmetreDescripcióExemple
_sortAmb aquest paràmetre es poden ordenar els resultats en funció d'un o diversos camps de resposta.

S'ha d'indicar el nom del camp pel qual es volen ordenar els resultats.

Per invertir l'ordre cal afegir el símbol menys '-' davant el nom del camp.

Es poden combinar diversos camps utilitzant la coma ',' com a separador.
Per exemple, si volem obtenir tots els conjunts de dades ordenats per data descendent i títol:

http://datos.gob.es/apidata/catalog/dataset.json?_sort=-issued,title
_pageSizeAquest paràmetre s'utilitza per fixar el nombre de resultats per pàgina.

El valor màxim és 50.
Per exemple, per obtenir els resultats d'un en un:

http://datos.gob.es/apidata/catalog/dataset.xml?_pageSize=1
_pageAquest paràmetre s'utilitza per indicar en quin número de pàgina ens trobem.

La pàgina inicial és 0.
Per exemple, per estar a la tercera pàgina dels resultats:

http://datos.gob.es/apidata/catalog/dataset.xml?_pageSize=1&_page=2

Crides disponibles

Catàleg de dades

Conjunt de crides que permeten consultar el catàleg de dades de datos.gob.es.

Conjunts de dades
OperacióDescripcióExemples
Obtenir tots els conjunts de dadeshttp://datos.gob.es/apidata/catalog/dataset
Obtenir un conjunt de dades per l'identificador URIhttp://datos.gob.es/apidata/catalog/dataset/{id}

Cal especificar el valor de {id}.
Per exemple, si {id} té 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 crida 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
Obtenir conjunts de dades amb un títol determinathttp://datos.gob.es/apidata/catalog/dataset/title/{title}

Cal especificar el valor de {title}. Pot ser part del títol.
Per exemple, si {title} té el valor: 'empleo', la crida serà:

http://datos.gob.es/apidata/catalog/dataset/title/empleo
Obtenir els conjunts de dades d'un publicador determinat a través de l'identificadorhttp://datos.gob.es/apidata/catalog/dataset/publisher/{id}

Cal especificar el valor de {id}.
Per exemple, si {id} té el valor: 'A16003011', la crida serà:

http://datos.gob.es/apidata/catalog/dataset/publisher/A16003011
Obtenir els conjunts de dades d'una categoria o temàtica determinada a través de l'identificadorhttp://datos.gob.es/apidata/catalog/dataset/theme/{id}

Cal especificar el valor de {id}.
Per exemple, si {id} té el valor: 'hacienda', la crida serà:

http://datos.gob.es/apidata/catalog/dataset/theme/hacienda
Obtenir els conjunts de dades que tenen distribucions en un format determinat http://datos.gob.es/apidata/catalog/dataset/format/{format}Per exemple, si {format} té el valor: 'csv', la crida serà:

http://datos.gob.es/apidata/catalog/dataset/format/csv
Obtenir els conjunts de dades que contenen una etiqueta determinadahttp://datos.gob.es/apidata/catalog/dataset/keyword/{keyword}Si {keyword} té el valor: 'gastos', la crida serà:

http://datos.gob.es/apidata/catalog/dataset/keyword/gastos
Obtenir els conjunts de dades que pertanyen a un àmbit geogràfic determinathttp://datos.gob.es/apidata/catalog/dataset/spatial/{spatialWord1}/{spatialWord2}

En aquesta crida s'utilitzen dos paràmetres: {spatialWord1} i {spatialWord2}.
Si {spatialWord1} té el valor: 'Autonomia' i {spatialWord2} té el valor: 'Pais-Vasco' la crida serà:

http://datos.gob.es/apidata/catalog/dataset/spatial/Autonomia/Pais-Vasco
Obtenir els conjunts de dades que han estat actualitzats entre dues dates:http://datos.gob.es/apidata/catalog/dataset/modified/begin/{beginDate}/end/{endDate}

En aquesta crida s'utilitzen dos paràmetres: {beginDate} i {endDate}, el format dels quals ha de ser AAAA-MM-DDTHH:mmZ.
Si {beginDate} té el valor: 2016-04-18T00:00Z i {endDate} té el valor: 2016-06-30T00:00Z la crida 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

Distribucions
Operació DescripcióExemples
Obtenir totes les distribucionshttp://datos.gob.es/apidata/catalog/distribution
Obtenir les distribucions d'un conjunt de dades identificat per l'identificador URIhttp://datos.gob.es/apidata/catalog/distribution/dataset/{id}

Cal 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 crida 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
Obtenir les distribucions que estan en un format determinathttp://datos.gob.es/apidata/catalog/distribution/format/{format}Si {format} té el valor: 'csv', la crida serà:

http://datos.gob.es/apidata/catalog/distribution/format/csv

Publicadors
Operació DescripcióExemples
Obtenir tots els publicadorshttp://datos.gob.es/apidata/catalog/publisher

Àmbits geogràfics
Operació DescripcióExemples
Obtenir totes les opcions de cobertura geogràfica amb conjunts de dades al catàleghttp://datos.gob.es/apidata/catalog/spatial

Categories / Temàtiques
Operació DescripcióExemples
Obtenir totes les categories o temàtiques amb conjunts de dades al catàleghttp://datos.gob.es/apidata/catalog/theme

Norma tècnica d'interoperabilitat

Conjunt de crides que permeten consultar el contingut de la taxonomia de sectors primaris i la identificació de cobertura geogràfica definides als annexos IV i V de la Norma tècnica d'interoperabilitat de reutilització de recursos de la informació (NTI).

Taxonomia de sectors primaris
Operació DescripcióExemples
Obtenir tots els sectors primarishttp://datos.gob.es/apidata/nti/public-sector
Obtenir un sector determinat per l'identificador URIhttp://datos.gob.es/apidata/nti/public-sector/{id}

Cal especificar el valor de {id}.
Per exemple, si {id} té el valor 'comercio', la crida serà:

http://datos.gob.es/apidata/nti/public-sector/comercio

Identificació de cobertura geogràfica
Operació DescripcióExemples
Obtenir totes les províncieshttp://datos.gob.es/apidata/nti/territory/Province
Obtenir una província determinada, identificada per l'identificador URIhttp://datos.gob.es/apidata/nti/territory/Province/{id}

Cal especificar el valor de {id}
Per exemple, si {id} tiene el valor 'Madrid', la crida serà:

http://datos.gob.es/apidata/nti/territory/Province/Madrid.
Obtenir totes les comunitats autònomeshttp://datos.gob.es/apidata/nti/territory/Autonomous-region
Obtenir una comunitat autònoma determinada, identificada per l'identificador URIhttp://datos.gob.es/apidata/nti/territory/Autonomous-region/{id}

Cal especificar el valor de {id}.
Per exemple, si {id} tiene el valor 'Comunidad-Madrid', la crida serà:

http://datos.gob.es/apidata/nti/territory/Autonomous-region/Comunidad-Madrid
Obtenir el paíshttp://datos.gob.es/apidata/nti/territory/Country/España