Inflação
Endpoints para acessar dados históricos de Índices de Inflação.
Permite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis.
Buscar Dados Históricos de Inflação por País
Obtenha dados históricos sobre índices de inflação para um país específico.
Funcionalidades:
- Seleção de País: Especifique o país desejado com o parâmetro
country(padrão:brazil). - Filtragem por Período: Defina um intervalo de datas com
starteend(formato DD/MM/YYYY). - Inclusão de Histórico: O parâmetro
historical(booleano) parece controlar a inclusão de dados históricos (verificar comportamento exato, pode ser redundante comstart/end). - Ordenação: Ordene os resultados por data (
date) ou valor (value) usandosortByesortOrder.
Autenticação:
Requer token de autenticação via token (query) ou Authorization (header).
Exemplo de Requisição:
Buscar dados de inflação do Brasil para o ano de 2022, ordenados por valor ascendente:
curl -X GET "https://brapi.dev/api/v2/inflation?country=brazil&start=01/01/2022&end=31/12/2022&sortBy=value&sortOrder=asc&token=SEU_TOKEN"Buscar os dados mais recentes de inflação (sem período definido, ordenação padrão):
curl -X GET "https://brapi.dev/api/v2/inflation?country=brazil&token=SEU_TOKEN"Resposta:
A resposta contém um array inflation, onde cada objeto representa um ponto de dado de inflação com sua date (DD/MM/YYYY), value (o índice de inflação como string) e epochDate (timestamp UNIX).
Autenticação via header HTTP Authorization. Use o formato Authorization: Bearer SEU_TOKEN. Obtenha seu token.
In: header
Query Parameters
Opcional. Nome do país para o qual buscar os dados de inflação. Use nomes em minúsculas. O padrão é brazil. Consulte /api/v2/inflation/available para a lista de países suportados.
"brazil"Opcional. Booleano (true ou false). Define se dados históricos devem ser incluídos. O comportamento exato em conjunto com start/end deve ser verificado. Padrão: false.
falseOpcional. Data de início do período desejado para os dados históricos, no formato DD/MM/YYYY. Requerido se end for especificado.
^\d{2}/\d{2}/\d{4}$dateOpcional. Data final do período desejado para os dados históricos, no formato DD/MM/YYYY. Requerido se start for especificado.
^\d{2}/\d{2}/\d{4}$dateOpcional. Campo pelo qual os resultados da inflação serão ordenados.
"date""date" | "value"Opcional. Direção da ordenação: asc (ascendente) ou desc (descendente). Padrão: desc. Requer que sortBy seja especificado.
"desc""asc" | "desc"Obrigatório caso não esteja adicionado como header "Authorization". Seu token de autenticação pessoal da API Brapi.
Formas de Envio:
- Query Parameter: Adicione
?token=SEU_TOKENao final da URL. - HTTP Header: Inclua o header
Authorization: Bearer SEU_TOKENna sua requisição.
Ambos os métodos são aceitos, mas pelo menos um deles deve ser utilizado. Obtenha seu token em brapi.dev/dashboard.
Response Body
curl -X GET "https://brapi.dev/api/v2/inflation?country=brazil&start=2019-08-24&end=2019-08-24&sortBy=date&sortOrder=asc&token=string"{
"inflation": [
{
"date": "01/01/2023",
"value": "4.56",
"epochDate": 1672531199
}
]
}{
"error": true,
"message": "Something went wrong while fetching the data"
}{
"error": true,
"message": "O seu token é inválido, por favor, verifique o seu token em brapi.dev/dashboard"
}{
"error": true,
"message": "this query value is not available, please use one of the following: asc,desc"
}