Listar Países disponíveis
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.
Listar Países com Dados de Inflação Disponíveis
Obtenha a lista completa de todos os países para os quais a API Brapi possui dados de inflação disponíveis para consulta no endpoint /api/v2/inflation
.
Funcionalidade:
- Retorna um array
countries
com os nomes dos países (em minúsculas). - Pode ser filtrado usando o parâmetro
search
.
Autenticação:
Requer token de autenticação via token
(query) ou Authorization
(header).
Exemplo de Requisição:
Listar todos os países com dados de inflação:
curl -X GET "https://brapi.dev/api/v2/inflation/available?token=SEU_TOKEN"
Buscar países cujo nome contenha 'arg':
curl -X GET "https://brapi.dev/api/v2/inflation/available?search=arg&token=SEU_TOKEN"
Resposta:
A resposta é um objeto JSON com a chave countries
, contendo um array de strings com os nomes dos países (ex: ["brazil", "argentina", "usa"]
).
Authorization
Authorization
RequiredBearer <token>Autenticação via header HTTP Authorization
. Use o formato Authorization: Bearer SEU_TOKEN
. Obtenha seu token.
In: header
Query Parameters
search
stringOpcional. Termo para filtrar a lista pelo nome do país (correspondência parcial, case-insensitive). Se omitido, retorna todos os países.
token
stringObrigató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 do endpoint que lista os países com dados de inflação disponíveis.
TypeScript Definitions
Use the response body type in TypeScript.
countries
array<string>Lista de nomes de países (em minúsculas) para os quais há dados de inflação disponíveis (ex: brazil
, usa
, argentina
).
Schema padrão para respostas de erro da API.
TypeScript Definitions
Use the response body type in TypeScript.
error
RequiredbooleanIndica se a requisição resultou em erro. Sempre true
para este schema.
message
RequiredstringMensagem descritiva do erro ocorrido.
Not Found. Nenhum país encontrado correspondendo ao critério de busca (search
) informado.
TypeScript Definitions
Use the response body type in TypeScript.
message
stringcurl -X GET "https://brapi.dev/api/v2/inflation/available?search=bra" \
-H "Authorization: Bearer <token>"
fetch("https://brapi.dev/api/v2/inflation/available?search=bra", {
headers: {
"Authorization": "Bearer <token>"
}
})
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://brapi.dev/api/v2/inflation/available?search=bra"
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/available?search=bra"
response = requests.request("GET", url, headers = {
"Authorization": "Bearer <token>"
})
print(response.text)
{
"countries": [
"brazil"
]
}
{
"error": true,
"message": "O seu token é inválido, por favor, verifique o seu token em brapi.dev/dashboard"
}
{
"message": "Country not found"
}