Listar Criptomoedas | Documentação brapi.dev

Endpoints focados na obtenção de dados sobre Criptomoedas.

Inclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API.

Listar Todas as Criptomoedas Disponíveis

Obtenha a lista completa de todas as siglas (tickers) de criptomoedas que a API Brapi suporta para consulta no endpoint /api/v2/crypto.

Funcionalidade:

Retorna um array coins com as siglas.
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 todas as criptomoedas disponíveis:

curl -X GET "https://brapi.dev/api/v2/crypto/available?token=SEU_TOKEN"

Buscar criptomoedas cujo ticker contenha 'DOGE':

curl -X GET "https://brapi.dev/api/v2/crypto/available?search=DOGE&token=SEU_TOKEN"

Resposta:

A resposta é um objeto JSON com a chave coins, contendo um array de strings com as siglas das criptomoedas (ex: ["BTC", "ETH", "LTC", "XRP"]).

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Query Parameters

searchstring

Opcional. Termo para filtrar a lista de siglas de criptomoedas (correspondência parcial, case-insensitive). Se omitido, retorna todas as siglas.

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 do endpoint que lista todas as criptomoedas disponíveis.

TypeScript Definitions

Use the response body type in TypeScript.

coinsarray<string>

Lista de siglas (tickers) das criptomoedas disponíveis (ex: BTC, ETH, LTC).

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.

Not Found. Nenhuma criptomoeda encontrada correspondendo ao critério de busca (search) informado.

TypeScript Definitions

Use the response body type in TypeScript.

messagestring

curl -X GET "https://brapi.dev/api/v2/crypto/available?search=BTC" \
  -H "Authorization: Bearer <token>"

fetch("https://brapi.dev/api/v2/crypto/available?search=BTC", {
  headers: {
    "Authorization": "Bearer <token>"
  }
})

package main

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

func main() {
  url := "https://brapi.dev/api/v2/crypto/available?search=BTC"

  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/crypto/available?search=BTC"

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

print(response.text)

{
  "coins": [
    "BTC",
    "ETH",
    "LTC"
  ]
}

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

{
  "message": "Coin not found"
}