Listar indicadores

GET

/macroeconomics/indicators

Consulte o catálogo de indicadores macroeconômicos disponíveis na Partnr API, incluindo os países atendidos e as unidades ou frequências suportadas para cada série.

Este endpoint deve ser utilizado como a primeira etapa de uma integração com os dados macroeconômicos da Partnr. Ele permite descobrir os valores aceitos nos parâmetros id, country e unit antes de consultar uma série temporal.

A resposta funciona como um catálogo programático da API. Em vez de manter manualmente uma lista de indicadores, países e frequências na sua aplicação, você pode utilizar esta rota para identificar quais combinações estão disponíveis.

GET /macroeconomics/indicators
Authorization: Bearer SUA_API_KEY

Para que serve este endpoint?

Uma série macroeconômica pode estar disponível para diferentes países e em diferentes frequências.

Um indicador de inflação, por exemplo, pode possuir dados mensais e anuais para determinado país. Já uma taxa de juros pode estar disponível em frequência diária, mensal ou anual.

Antes de solicitar os valores da série, sua aplicação precisa saber:

• Qual é o identificador do indicador
• Para quais países o indicador está disponível
• Quais unidades ou frequências podem ser utilizadas
• Qual combinação deve ser enviada na consulta da série temporal

O endpoint de listagem reúne essas informações em uma única resposta.

Use este endpoint para descobrir os valores aceitos em id, country e unit. Depois, utilize esses valores em Consultar indicador.

Fluxo recomendado de integração

O processo de consulta de dados macroeconômicos pode ser dividido em cinco etapas.

1. Liste os indicadores disponíveis

Faça uma requisição para:

GET /macroeconomics/indicators

A resposta apresentará todos os indicadores disponíveis para a sua integração.

2. Escolha o id do indicador

Cada indicador possui um identificador utilizado nas demais rotas da API.

Exemplos de identificadores apresentados na documentação incluem:

• INTEREST_RATE
• INFLATION_RATE

O id deve ser enviado na URL ao consultar a série temporal:

GET /macroeconomics/indicators/INFLATION_RATE

Não tente converter nomes em português diretamente para o identificador. Utilize sempre o valor retornado pelo endpoint de listagem.

3. Verifique os países disponíveis

Dentro de cada indicador, o campo countries informa para quais países aquela série está disponível.

Os países são identificados pelo padrão ISO 3166-1 alpha-3.

Exemplo:

• BRA

Nesse caso, BRA representa o Brasil.

O mesmo indicador pode possuir coberturas diferentes de acordo com o país. Por isso, sempre confirme se a combinação entre indicador e país aparece no catálogo.

4. Escolha uma unidade ou frequência

Cada país possui um campo units com as opções disponíveis para o indicador.

Exemplos comuns:

• DAILY: dados diários
• MONTHLY: dados mensais
• ANNUAL: dados anuais

As unidades disponíveis podem variar de acordo com o indicador e o país. Um indicador não necessariamente terá todas as frequências.

5. Consulte a série temporal

Depois de identificar id, country e unit, utilize o endpoint de consulta:

GET /macroeconomics/indicators/[id]

Exemplo:

GET /macroeconomics/indicators/INFLATION_RATE?country=BRA&unit=MONTHLY

A resposta da consulta contém os valores históricos da série, organizados por data.

Veja todos os parâmetros da consulta de indicadores.

Parâmetros de requisição

Sem parâmetros.

Resposta

Código	Descrição
200	Retorna a lista de indicadores.
401	Não autorizado.

Formato da resposta

A resposta é uma lista de objetos com os campos abaixo:

Campo	Tipo	Descrição
id	string	ID do indicador macroeconômico (usado em /macroeconomics/indicators/[id]).
countries	array	Lista de países disponíveis para o indicador e suas unidades/frequências suportadas.

Estrutura de countries[]

Campo	Tipo	Descrição
id	string	País no padrão ISO 3166-1 alpha-3 (ex.: BRA).
units	array de string	Unidades/frequências disponíveis para o indicador no país (ex.: ANNUAL, MONTHLY, DAILY).

Exemplo

[
  {
    "id": "INTEREST_RATE",
    "countries": [
      { "id": "BRA", "units": ["ANNUAL", "MONTHLY", "DAILY"] }
    ]
  },
  {
    "id": "INFLATION_RATE",
    "countries": [
      { "id": "BRA", "units": ["MONTHLY", "ANNUAL"] }
    ]
  }
]

Boas práticas de integração

• Consulte o catálogo antes de implementar combinações fixas de parâmetros.
• Utilize exatamente o id retornado pela API.
• Não presuma que todos os indicadores estão disponíveis para todos os países.
• Não presuma que todas as frequências existem para todos os indicadores.
• Valide country e unit dentro do objeto correspondente ao indicador.
• Trate o código 401 quando a credencial não estiver autorizada.
• Utilize o catálogo para manter dropdowns e filtros consistentes com a cobertura da API.
• Consulte novamente a rota quando precisar identificar novos indicadores ou alterações de cobertura.