Buscar Inflação de um País por um Período Determinado

Nesta seção, você encontrará informações detalhadas sobre como buscar a inflação de um país por meio da API da brapi. Este endpoint é a porta de entrada para obter informações atualizadas sobre a inflação de um país por um período determinado. Saiba como usar os parâmetros de consulta, como country para escolher o país desejado e historical para mostrar dados históricos.

Endpoint

O endpoint que você deve utilizar para buscar a inflação de um país por um período determinado é o seguinte:

GET /api/v2/inflation

Parâmetros da Solicitação

Para utilizar este endpoint, você precisa fornecer os seguintes parâmetros na solicitação:

country (opcional)

O parâmetro "county" é opcional e especifica o país do qual você deseja obter informações. Por padrão, o país é definido como brazil. Você pode consultar a lista de países disponíveis aqui (opens in a new tab).

Exemplo de uso: ?country=brazil

Isso facilita a busca por informações específicas de um país.

historical (opcional)

O parâmetro "historical" é um boolean (true ou false) opcional e especifica se você deseja obter informações históricas ou não. Por padrão, o histórico é false e você receberá apenas as informações mais recentes.

Exemplo de uso: ?historical=true

Isso permite que você obtenha informações de períodos anteriores.

start (opcional)

O parâmetro "start" é uma data opcional e especifica a data inicial do período desejado. O formato da data deve ser DD/MM/YYYY.

Exemplo de uso: ?start=01/01/2020

Isso permite que você obtenha informações de períodos anteriores.

end (opcional)

O parâmetro "end" é uma data opcional e especifica a data final do período desejado. O formato da data deve ser DD/MM/YYYY. Por padrão, o valor é a data atual.

Exemplo de uso: ?end=01/01/2022

Isso permite que você obtenha informações de períodos anteriores.

sortBy (opcional)

Este parâmetro permite que você ordene os resultados por um campo específico. Tem como padrão o valor date. Os valores aceitáveis são:

• date - Data da informação
• value - Valor da inflação

Exemplo de uso: ?sortBy=date

sortOrder (opcional)

Este parâmetro determina se os filtro de sortBy será ordenado em ordem crescente ou decrescente. Tem como padrão o valor desc. Os valores aceitáveis são:

• desc - Ordem decrescente
• asc - Ordem crescente

Exemplo de uso: ?sortOrder=desc

token (obrigatório)

O token de autenticação é obrigatório e exclusivo para cada usuário. Você pode obtê-lo em https://brapi.dev/dashboard (opens in a new tab). A autenticação é necessária para acessar os recursos da API e garantir a segurança das suas solicitações.

Esse token pode ser passado como parâmetro de query ou como header Authorization: Bearer {token}.

Esta flexibilidade na definição de parâmetros permite que você ajuste suas solicitações para atender a uma variedade de necessidades, desde dados históricos até informações detalhadas sobre a inflação de um país.

Exemplo de Solicitação

Para uma solicitação que busca os dados de inflação do Brasil desde o início de 2020 até o início de 2021, ordenado pela data de forma decrescente, a solicitação ficaria assim:

curl -X GET \
"https://brapi.dev/api/v2/inflation?country=brazil&start=01/01/2020&end=01/01/2021&sortBy=date&sortOrder=desc&token=eJGEyu8vVHctULdVdHYzQd"

Resposta da Solicitação

200 OK

A solicitação foi bem-sucedida.

{
  "inflation": [
    {
      "date": "01/01/2021",
      "value": "4.56",
      "epochDate": 1609459200000
    },
    {
      "date": "01/12/2020",
      "value": "4.52",
      "epochDate": 1606780800000
    },
    {
      "date": "01/11/2020",
      "value": "4.31",
      "epochDate": 1604188800000
    },
    {
      "date": "01/10/2020",
      "value": "3.92",
      "epochDate": 1601510400000
    },
    {
      "date": "01/09/2020",
      "value": "3.14",
      "epochDate": 1598918400000
    },
    {
      "date": "01/08/2020",
      "value": "2.44",
      "epochDate": 1596240000000
    },
    {
      "date": "01/07/2020",
      "value": "2.31",
      "epochDate": 1593561600000
    },
    {
      "date": "01/06/2020",
      "value": "2.13",
      "epochDate": 1590969600000
    },
    {
      "date": "01/05/2020",
      "value": "1.88",
      "epochDate": 1588291200000
    },
    {
      "date": "01/04/2020",
      "value": "2.40",
      "epochDate": 1585699200000
    },
    {
      "date": "01/03/2020",
      "value": "3.30",
      "epochDate": 1583020800000
    },
    {
      "date": "01/02/2020",
      "value": "4.01",
      "epochDate": 1580515200000
    },
    {
      "date": "01/01/2020",
      "value": "4.19",
      "epochDate": 1577836800000
    }
  ]
}

400 Bad Request

A solicitação foi malformada, inválida ou não foi possível entender o que foi solicitado.

{
  "error": true,
  "message": "Something went wrong while fetching the data"
}

417 Expectation Failed

Não entendemos algum dos parametros passados.

{
  "error": true,
  "message": "this query value is not available, please use one of the following: asc,desc"
}

401 Unauthorized

O token de autenticação não foi informado ou é inválido.

{
  "error": true,
  "message": "O seu token é inválido, por favor, verifique o seu token em brapi.dev/dashboard"
}