API para la consulta de los Censos de Población y Viviendas 2021

El servicio permite la consulta de datos del Sistema de Difusión de los Censos de Población y Viviendas 2021 (SDC21).

Únicamente se considera el método POST para recuperar la información.

Este servicio se invoca con la estructura de parámetros documentada a continuación.

Ficheros Excel

Para confeccionar las consultas el usuario dispone de una serie de ficheros Excel de la operación censal con los que dar valor a los parámetros de la url:

• lista de tablas disponibles.
• lista de las variables disponibles para cada tabla.
• lista de las unidades de medida (métricas) disponibles para cada tabla.
• lista de idiomas en los que se puede mostrar el resultado de la consulta.

Petición por url

La petición devuelve los datos que corresponden a una selección de un mínimo de 1 variable y hasta un máximo de 4 variables por tabla.

Las salidas resultantes de los datos se configuran como cruces de categorías de las variables. Los identificadores de las tablas, las variables, las unidades de medida y el idioma empleado en la petición son los que figuran en los ficheros Excel. La no utilización de esos identificadores no generará resultados en la respuesta. Los cruces se expresan mediante parámetros que se incluyen en la expresión URL que define la petición.

Ejemplo: Petición de datos del número de personas por sexo y comunidad autónoma del dominio per.ppal en inglés:

https://www.ine.es/Censo2021/api

Cabeceras de la petición

• POST /
• Accept : application/json
• Content-Type: application/json
• Content-Length: [0-9]* (valor numérico, por seguridad y limitaciones técnicas, es opcional)

Cuerpo de la petición

• {
•       “idioma”: “EN”,
•       “metrica”:[”SPERSONAS”],
•       “tabla”:”per.ppal”,
•       “variables”: [
•             “ID_RESIDENCIA_N1”,
•             “ID_SEXO”
•       ]
• }

En el cuerpo de la petición, las variables obligatorias son: metrica, tabla, variables.

De no enviarse recibirá un Status 404 con el mensaje “Data not found”.

Respuesta Json:

• {
• "Metadata": [
•       {
•             "Column": "ID_RESIDENCIA_N1"
•       },
•       {
•             "Column": "ID_SEXO"
•       },
•       {
•             "Column": "SPERSONAS"
•       }
• ],
• "Data": [
•       {
•             "ID_RESIDENCIA_N1": "Andalucia",
•             "ID_SEXO ": "Hombre",
•             "SPERSONAS": 4182618
•       },
•       {
•             "ID_RESIDENCIA_N1": "Andalucia",
•             "ID_SEXO ": "Mujer",
•             "SPERSONAS": 4302183
•       },
•       {
•             "ID_RESIDENCIA_N1": "Aragón",
•             "ID_SEXO": "Hombre",
•             "SPERSONAS": 658263
•       },
•       {
•             "ID_RESIDENCIA_N1": "Aragón",
•             "ID_SEXO": "Mujer",
•             "SPERSONAS": 673677
•       },
•       ...
•       ]
• }

Limitaciones de servicio

El uso de la API se rige por las mismas condiciones que el SDC21. Además, se limita inicialmente a 2 el número de peticiones concurrentes que pueden estar activas a través de la API.

Aquellas consultas que se consideren significativamente grandes para la ejecución y respuesta en vivo no serán procesadas, en este caso el objeto de respuesta será:

• {
•       "Debido al tamaño de la consulta ésta no puede ser procesada por el sistema"
• }

Errores en las respuestas

Para los errores controlados de la aplicación, el objeto de respuesta será:

• {
•       “error”:”texto descriptivo del problema”
• }