Portal do INE

API Metainformação

Para complementar a API, pode aceder e extrair, via API, a metainformação de cada indicador na Base de Dados do INE. A metainformação contém detalhes essenciais sobre a estrutura, dimensões e descrições dos indicadores, de forma a possibilitar aos utilizadores uma utilização dos dados precisa e correta.

Extracção da Metainformação

O endpoint para extração da metainformação segue a seguinte estrutura:

{host_url}/ine/json_indicador/pindicaMeta.jsp?varcd={varcd_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. Deve ser um valor numérico com 7 algarismos.	0001234
lang	Língua pretendida para o resultado da extração. Valores permitidos: "PT" (Português) ou "EN" (Inglês).	PT

Exemplo Prático

Aqui está um exemplo de utilização da API para extrair metainformação:

https://www.ine.pt/ine/json_indicador/pindicaMeta.jsp?varcd=0001234&lang=PT

Este exemplo retorna a metainformação do indicador com o código 0001234 em português.

Resposta da API

A resposta da API é um objeto JSON contendo os metadados do indicador. Aqui está um exemplo de resposta:


[
  {
    "IndicadorCod": "0001234",
    "IndicadorNome": "População empregada por conta de outrem (N.º) por Sexo e Atividade económica (CAE Rev. 2); Anual - MTSSS / Gabinete de Estratégia e Planeamento",
    "Periodic": "Anual",
    "PrimeiroPeriodo": "2000",
    "UltimoPeriodo": "2006",
    "UnidadeMedida": "Número (N.º)",
    "Potencia10": "3",
    "PrecisaoDecimal": "0",
    "Lingua": "PT",
    "DataUltimaAtualizacao": "2009-02-11",
    "DataExtracao": "2024-04-09T14:33:25.640+01:00",
    "Dimensoes": {
      "Descricao_Dim": [
        {
          "dim_num": "1",
          "abrv": "Período de referência dos dados",
          "versao": "XXXXX"
        }
      ],
      "Categoria_Dim": {
        "Dim_Num1_S7A2000": [
          {
            "dim_num": "1",
            "dim_cod": "S7A2000",
            "dim_dsg": "2000"
          }
        ]
      }
    }
  }
]

Para mais detalhes relativos à metainformação dos indicadores, consulte a página do Sistema de Metainformação do INE: http://smi.ine.pt/Indicador.