Cotação de Moedas
Endpoints para consulta de Moedas Fiduciárias.
Atualmente, focado na listagem das moedas disponíveis para conversão ou consulta de taxas de câmbio.
Buscar Cotação de Pares de Moedas Fiduciárias
Obtenha cotações atualizadas para um ou mais pares de moedas fiduciárias (ex: USD-BRL, EUR-USD).
Funcionalidades:
- Cotação Múltipla: Consulte vários pares de moedas em uma única requisição usando o parâmetro
currency
. - Dados Retornados: Inclui nome do par, preços de compra (bid) e venda (ask), variação, máximas e mínimas, e timestamp da atualização.
Parâmetros:
currency
(Obrigatório): Uma lista de pares de moedas separados por vírgula, no formatoMOEDA_ORIGEM-MOEDA_DESTINO
(ex:USD-BRL
,EUR-USD
). Consulte os pares disponíveis em/api/v2/currency/available
.token
(Obrigatório): Seu token de autenticação.
Autenticação:
Requer token de autenticação válido via token
(query) ou Authorization
(header).
Authorization
Authorization
RequiredBearer <token>Autenticação via header HTTP Authorization
. Use o formato Authorization: Bearer SEU_TOKEN
. Obtenha seu token.
In: header
Query Parameters
currency
RequiredstringObrigatório. Uma lista de um ou mais pares de moedas a serem consultados, separados por vírgula (,
).
- Formato:
MOEDA_ORIGEM-MOEDA_DESTINO
(ex:USD-BRL
). - Disponibilidade: Consulte os pares válidos usando o endpoint
/api/v2/currency/available
. - Exemplo:
USD-BRL,EUR-BRL,BTC-BRL
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
Estrutura da resposta principal do endpoint GET /api/v2/currency
.
TypeScript Definitions
Use the response body type in TypeScript.
currency
Requiredarray<object>Array contendo os objetos CurrencyQuote
, um para cada par de moeda válido solicitado no parâmetro currency
.
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.
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.
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.
curl -X GET "https://brapi.dev/api/v2/currency?currency=USD-BRL%2CEUR-USD" \
-H "Authorization: Bearer <token>"
fetch("https://brapi.dev/api/v2/currency?currency=USD-BRL%2CEUR-USD", {
headers: {
"Authorization": "Bearer <token>"
}
})
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://brapi.dev/api/v2/currency?currency=USD-BRL%2CEUR-USD"
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/currency?currency=USD-BRL%2CEUR-USD"
response = requests.request("GET", url, headers = {
"Authorization": "Bearer <token>"
})
print(response.text)
{
"currency": [
{
"fromCurrency": "USD",
"toCurrency": "BRL",
"name": "Dólar Americano/Real Brasileiro",
"high": "5.22",
"low": "5.162",
"bidVariation": "0.0454",
"percentageChange": "0.88",
"bidPrice": "5.2097",
"askPrice": "5.2127",
"updatedAtTimestamp": "1696601423",
"updatedAtDate": "2023-10-06 11:10:23"
}
]
}
{
"error": true,
"message": "Algo deu errado ao buscar essa moeda"
}
{
"error": true,
"message": "O seu token é inválido, por favor, verifique o seu token em brapi.dev/dashboard"
}
{
"error": true,
"message": "Não foi possível encontrar o parâmetro obrigatório: 'currency', exemplo: https://brapi.dev/api/v2/currency?currency=USD-BRL"
}