API - Base de Dados de Difusão


Atento às necessidades dos seus utilizadores e em linha com as novas tendências tecnológicas, o INE disponibiliza uma API para a criação/extracção de um catálogo de indicadores da base de dados de difusão e para a extracção dos respectivos indicadores e metainformação de forma automatizada.
Este serviço é caracterizado por:
 
  • Atualização em Tempo Real;
  • Disponível em Português e Inglês;
  • Acesso livre e gratuito.
  

API - Catálogo de Indicadores do INE na Base de Dados de Difusão

Manual de Utilização

O Catálogo de Indicadores permite aos utilizadores, de uma forma simples e automática, recolher e catalogar a informação do INE relativa aos Indicadores publicados na Base de Dados de Difusão (BDD).
Descrição das Tags:
  • extraction_date -> Data de extração do catálogo
  • source -> Fonte "INE"
  • language -> Língua de extração do catálogo "PT/EN"
  • theme -> Tema do Indicador, igual à classificação usada no Portal do INE
  • subtheme -> Subtema do Indicador, igual à classificação usada no Portal do INE
  • keywords -> Palavras chave
  • title -> Titulo do indicador
  • varcd -> Código do indicador
  • description -> Descrição do indicador
  • geo_lastlevel -> Máxima desagregação geográfica para o indicador em referência
  • last_period_available -> Último período disponível
  • last_update -> Data da última atualização
  • periodicity -> Periodicidade do indicador
  • update_type -> Tipo de atualização
    Pode conter:
       D = Disponível (todos que não são “Novo” ou “Atualizado”
      A = Atualizado (os dados do indicador foram atualizados nos últimos 20 dias relativamente à data de extração do catálogo)
       N = Novo (novo indicador disponibilizado nos últimos 20 dias relativamente à data de extração do catálogo)
  • bdd_url -> Link para o indicador no Portal do INE
  • metainfo_url -> Link para a Metainformação no Portal INE
  • json_dataset -> Link para a API que "retorna" o Dataset relativa ao Indicador "com todas as dimensões" em formato Json
  • json_metainfo -> Link para a API que "retorna" a MetaInformação relativa ao Indicador em formato Json
Exemplo de um ficheiro XML gerado do tipo "Catálogo" para um indicador, neste caso o indicador 0004167
 

 Exemplo:
  {host_url}/ine/xml_indic.jsp?opc1&varcd={varcd_cod}&lang={lang} 
                    https://www.ine.pt/ine/xml_indic.jsp?opc=1&varcd=0004167&lang=PT

Argumentos de Input:
  

host_url -> Endereço host do website Portal INE, (https://www.ine.pt)
varcd_cod -> Código do indicador a extrair  
lang
->  Língua “PT ou EN”

Formato de Output "XML"

<catalog>

  <extraction_date>Thursday, 15 March 2018, 02:35:14.499 PM</extraction_date>

  <source>INE - Instituto Nacional de Estatistica</source>

  <language>PT</language>

  <indicator id="0004167">

   <theme>População</theme>

   <subtheme>Estimativas de população</subtheme>

   <keywords>INE,População,(N.º),residente,População,Estimativas de população</keywords>

   <title>População residente (N.º)</title>

   <varcd>0004167</varcd>

   <description>População residente (N.º) por Local de residência, Sexo e Grupo etário (Por ciclos de vida); Anual - INE, Estimativas anuais da população residente</description>

   <geo_lastlevel>Distrito</geo_lastlevel>

   <dates>

     <last_period_available>S7A2016</last_period_available>

     <last_update>15-06-2017</last_update>

    </dates>

   <periodicity>Anual</periodicity>

   <update_type>D</update_type>

   <html>

    <bdd_url>https://www.ine.pt/xurl/indx/0004167/PT</bdd_url>

    <metainfo_url>https://www.ine.pt/xurl/metax/0004167/PT</metainfo_url>

   </html>

   <json>

    <json_dataset>https://www.ine.pt/ine/json_indicador/pindica.jsp?op=2&varcd=0004167&lang=PT</json_dataset>

    <json_metainfo>https://www.ine.pt/ine/json_indicador/pindicaMeta.jsp?varcd=0004167&lang=PT</json_metainfo>

   </json>

  </indicator>

</catalog>

  Extração automática para geração do Catálogo,  opções disponíveis:
 
 a) Um a Um (opc=1) : código do indicador + língua
 Exemplo: https://www.ine.pt/ine/xml_indic.jsp?opc=1&varcd=0004167&lang=PT

 
 b) Grupo dos Principais Indicadores (opc=3) (+- 260 Indicadores), pode demorar algum tempo a gerar o ficheiro (de preferência correr em horas de pouco  tráfego):
 Exemplo: https://www.ine.pt/ine/xml_indic.jsp?opc=3&lang=PT

 



API - JSON - Dados de Indicadores – Base de Dados

Manual de Utilização

A API JSON para extração e consulta de indicadores (tipo Serviço Rest Request) acede à Base de Dados de Difusão do INE que contém todos os indicadores divulgados pelo INE, de acesso público e gratuito.
Esta API permite extrair os dados de forma automática e através do uso de filtros, recorrendo para isso ao código do indicador e às respetivas dimensões. As dimensões variam conforme o indicador, pelo que deve ser consultada previamente a metainformação associada a cada indicador, assim como as dimensões que lhe estão associadas.
A metainformação associada ao indicador está disponível em http://smi.ine.pt/
O Serviço produz um ficheiro Json passível ser usado por aplicações informáticas para difusão de dados estatísticos ou para a produção de datasets personalizados, para aplicações móveis, para a produção de gráficos, etc..
 
Acesso à API e extração:
 
{host_url}/ine/json_indicador/pindica.jsp?op=2&varcd={varcd_cod}&Dim1={dim1_cod}&Dim2={dim2_cod}&Dim??={dim??_cod}&lang={língua}
  • host_url -> Endereço host do website Portal INE, (https://www.ine.pt)
  • varcd_cod -> Código do indicador
  • lang -> Língua pretendida para o resultado da extração (PT/EN)
  • dim1_cod -> Código da dimensão temporal, (exemplo: S7A2015)
  • dim2_cod -> Código da dimensão geográfica, (exemplo: 11)
  • dim??_cod -> Qualquer outra dimensão desde que faça parte do indicador escolhido
  • lang -> língua pretendida para o resultado da extração (PT/EN)

Como explorar as Dimensões/Códigos de um indicador para poder ser usado na API?
Aceder ao Portal do INE https://www.ine.pt –> Base de Dados –> Alterar Condições de Seleção - Alterar Opção de Arvore para a obtenção de Códigos.

De forma a complementar a API, existe a opção de acesso e extração via API da metainformação de cada um dos indicadores disponíveis na Base de dados do Portal do INE.
Para mais detalhes relativos à metainformação associada aos indicadores, deve ser consultada esta página do Sistema de metainformação do INE:  http://smi.ine.pt/Indicador.
 Vídeo: Exemplo prático para consulta das Dimensões/Códigos - (https://www.ine.pt/scripts/bdd_indicador_.mp4)

Exemplo: https://www.ine.pt/ine/json_indicador/pindica.jsp?op=2&varcd=0008074&Dim1=S7A2015&Dim2=200&Dim3=3&lang=PT

  • varcd: -> 0008074 (Taxa de criminalidade ((‰) por Localização geográfica (NUTS - 2013) e Categoria de crime; Anual - Direcção-Geral da Política de Justiça)
  • Dim1 -> S7A2015 (Ano 2015)
  • Dim2 -> 200 (Região Autónoma dos Açores)
  • Dim3 -> 3 (Furto de veículo e em veículo motorizado)
  • lang -> PT (Portuguesa)

De forma a complementar a API existe a opção de acesso e extração via API da metainformação de cada um dos indicadores disponíveis na bbase de dados de difusão.
 
Acesso à extração da metainformação:
 
{host_url}/ine/json_indicador/pindicaMeta.jsp?varcd={varcd_cod}&lang={língua}
  • host_url: -> endereço host do website Portal INE, https://www.ine.pt
  • varcd_cod -> código do indicador a extrair
  • lang: -> língua pretendida para o resultado da extração (PT/EN)
     

Para mais detalhes relativos à metainformação associada aos indicadores, deve ser consultado o endereço seguinte: http://smi.ine.pt/Indicador
 
                     Acessibilidade       Em conformidade com o nível 'AA' das WCAG 1.0 do W3C Em conformidade com o nível AA das WCAG 1.0 do W3C
CSE AELA SICAE SEE - Sistema Estatico Europeu ESS Vision 2020   UE - Fundo Europeu de Desenvolvimento Regional POCI Compete 2020 Portugal 2020