Inflação | Documentação brapi.dev

Ver Markdown

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 start e end (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 com start/end).
Ordenação: Ordene os resultados por data (date) ou valor (value) usando sortBy e sortOrder.

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).

Authorization

AuthorizationRequiredBearer <token>

Autenticação via header HTTP Authorization. Use o formato Authorization: Bearer SEU_TOKEN. Obtenha seu token.

In: header

Query Parameters

countrystring

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.

Default: "brazil"

historicalboolean

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.

Default: false

startstring

Opcional. Data de início do período desejado para os dados históricos, no formato DD/MM/YYYY. Requerido se end for especificado.

Pattern: "^\\d{2}/\\d{2}/\\d{4}$"Format: "date"

endstring

Opcional. Data final do período desejado para os dados históricos, no formato DD/MM/YYYY. Requerido se start for especificado.

Pattern: "^\\d{2}/\\d{2}/\\d{4}$"Format: "date"

sortBystring

Opcional. Campo pelo qual os resultados da inflação serão ordenados.

Default: "date"Value in: "date" | "value"

sortOrderstring

Opcional. Direção da ordenação: asc (ascendente) ou desc (descendente). Padrão: desc. Requer que sortBy seja especificado.

Default: "desc"Value in: "asc" | "desc"

tokenstring

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_TOKEN ao final da URL.
HTTP Header: Inclua o header Authorization: Bearer SEU_TOKEN na 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

Resposta principal do endpoint /api/v2/inflation.

TypeScript Definitions

Use the response body type in TypeScript.

inflationarray<object>

Array contendo os registros históricos de inflação para o país e período solicitados.

Schema padrão para respostas de erro da API.

TypeScript Definitions

Use the response body type in TypeScript.

errorRequiredboolean

Indica se a requisição resultou em erro. Sempre true para este schema.

messageRequiredstring

Mensagem descritiva do erro ocorrido.

Schema padrão para respostas de erro da API.

TypeScript Definitions

Use the response body type in TypeScript.

errorRequiredboolean

Indica se a requisição resultou em erro. Sempre true para este schema.

messageRequiredstring

Mensagem descritiva do erro ocorrido.

Schema padrão para respostas de erro da API.

TypeScript Definitions

Use the response body type in TypeScript.

errorRequiredboolean

Indica se a requisição resultou em erro. Sempre true para este schema.

messageRequiredstring

Mensagem descritiva do erro ocorrido.

curl -X GET "https://brapi.dev/api/v2/inflation?country=brazil&historical=true&start=01%2F01%2F2020&end=31%2F12%2F2020&sortBy=value&sortOrder=asc" \
  -H "Authorization: Bearer <token>"

fetch("https://brapi.dev/api/v2/inflation?country=brazil&historical=true&start=01%2F01%2F2020&end=31%2F12%2F2020&sortBy=value&sortOrder=asc", {
  headers: {
    "Authorization": "Bearer <token>"
  }
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://brapi.dev/api/v2/inflation?country=brazil&historical=true&start=01%2F01%2F2020&end=31%2F12%2F2020&sortBy=value&sortOrder=asc"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://brapi.dev/api/v2/inflation?country=brazil&historical=true&start=01%2F01%2F2020&end=31%2F12%2F2020&sortBy=value&sortOrder=asc"

response = requests.request("GET", url, headers = {
  "Authorization": "Bearer <token>"
})

print(response.text)

{
  "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"
}