A API JSON para extração e consulta de indicadores do Instituto Nacional de Estatística (INE) permite o acesso à Base de Dados do INE, onde estão todos os indicadores publicamente acessíveis e sem custos. Esta API permite a extração automática de dados, utilizando filtros baseado no código do indicador e nas suas respectivas dimensões. As dimensões dos indicadores podem variar, sendo essencial consultar previamente a metainformação de cada indicador e as suas dimensões, garantindo um uso eficiente e preciso da API.
A metainformação dos indicadores está disponível em: http://smi.ine.pt/.
Este serviço gera um ficheiro JSON para ser utilizado por aplicações informáticas para a difusão de dados estatísticos ou para a produção de datasets personalizados. É ideal para integtrar em aplicações móveis, produzir gráficos ou outras soluções que requeiram dados estatísticos de forma eficiente e automatizada.
O endpoint da API segue a seguinte estrutura:
{host_url}/ine/json_indicador/pindica.jsp?op=2&varcd={varcd_cod}&Dim1={dim1_cod}&Dim2={dim2_cod}&Dim??={dim??_cod}&lang={lang}Onde:
| Parâmetro | Descrição | Exemplo |
|---|---|---|
| host_url | Endereço host do website do INE. | https://www.ine.pt |
| varcd_cod | Código do indicador. | 0008074 |
| dim1_cod | Código da dimensão temporal. | S7A2015 (2015) |
| dim2_cod | Código da dimensão geográfica. | 11 (Nuts2 Norte) |
| dim??_cod | Qualquer outra dimensão disponível no indicador escolhido. | 3 (exemplo: Furto de veículo) |
| lang | Língua pretendida para o resultado da extração. | PT (Português) ou EN (Inglês) |
https://www.ine.pt/ine/json_indicador/pindica.jsp?op=2&varcd=0008074&Dim1=S7A2015&Dim2=11&Dim3=3&lang=PTPara explorar as dimensões e códigos de um indicador, siga estes passos:
Para mais detalhes sobre a metainformação dos indicadores, consulte: http://smi.ine.pt/Indicador.
Assista a um exemplo prático em vídeo: Como consultar as dimensões/códigos de um indicador.
Aqui está um exemplo de utilização da API "este feed pode resultar num ficheiro Json ou ser consumido via cliente":
https://www.ine.pt/ine/json_indicador/pindica.jsp?op=2&varcd=0008074&Dim1=S7A2015&Dim2=200&Dim3=3&lang=PTOnde:
Foram introduzidos novos parâmetros na API BDD – Conjunto de Valores, que permitem uma maior flexibilidade e escalabilidade na consulta de dados. Estas atualizações incluem:
| Funcionalidade | Descrição | Endpoint |
|---|---|---|
| Listagem de Todos os Períodos Disponíveis | Para obter todos os períodos de referência disponíveis para um indicador. Igualar a Dim1=T |
https://www.ine.pt/ine/json_indicador/pindica.jsp?op=2&varcd=0008074&Dim1=T&Dim2=200&Dim3=3&lang=PT |
| Listagem de Períodos Específicos | Para consultar apenas períodos específicos, especificando os valores desejados na dimensão Dim1=S7A2019,S7A2020 |
https://www.ine.pt/ine/json_indicador/pindica.jsp?op=2&varcd=0008074&Dim1=S7A2019,S7A2020&Dim2=200&Dim3=3&lang=PT |
| Análise por Outra Dimensão | Para incluir múltiplos valores em diferentes dimensões, como Dim1=S7A2019,S7A2020,S7A2021 e Dim2=200,300 |
https://www.ine.pt/ine/json_indicador/pindica.jsp?op=2&varcd=0008074&Dim1=S7A2019,S7A2020,S7A2021&Dim2=200,300&Dim3=3&lang=PT |
| Listagem de Todas as Ocorrências de um Nível Específico | Para obter todas as ocorrências de um determinado nível na dimensão Dim2=lvl@5Seleção de último período de referencia todos os municípios (nível 5 da dimensão geográfica), homens, mulheres |
https://www.ine.pt/ine/json_indicador/pindicaNoLevel.jsp?op=2&varcd=0012917&DIM2=lvl@5&DIM4=T&lang=PT |
| Classificação Específica | Para listar todas as ocorrências a partir de uma determinada classificação na dimensão Dim2=<*>200Seleção de último período de referencia para a NUT III - Madeira e todos os municípios da mesma, homens, mulheres e total |
https://www.ine.pt/ine/json_indicador/pindicaNoLevel.jsp?op=2&varcd=0012917&DIM2=<*>200&DIM4=T&lang=PT |
Compatibilidade com Funcionalidades Existentes
Além destas novas funcionalidades, todas as operações anteriormente disponíveis, conforme descrito no manual de utilização da API, permanecem asseguradas. As novas funcionalidades são totalmente compatíveis e podem ser utilizadas em conjunto com as operações já existentes, permitindo uma maior personalização das consultas.
Utilização de Dados .Json da API do INE
Com o ficheiro de dados .Json obtido através da API do INE, é possível processar e analisar os dados de forma mais eficiente. Poderá utilizar o Excel diretamente sobre o feed da API que pretende consumir ou sobre o ficheiro que extraiu. Neste exemplo, poderá observar como é possível manipular os seus dados de forma simples e intuitiva no Excel.
