Docs
Criptomoedas
/api/v2/crypto

Buscar Cotação de Uma ou Mais Criptomoedas (BTC, ETH, etc)

Nesta seção, você encontrará informações detalhadas sobre como buscar cotações de criptomoedas por meio da API da brapi. Este endpoint é a porta de entrada para obter informações atualizadas sobre várias criptomoedas, permitindo que você acompanhe os preços, variações, volume de negociação e muito mais.

Endpoint

O endpoint que você deve utilizar para buscar cotações de criptomoedas é o seguinte:

GET /api/v2/crypto

Parâmetros da Solicitação

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

coin (obrigatório)

O parâmetro "coin" é obrigatório e permite que você adicione uma ou mais criptomoedas separadas por vírgula. Você pode consultar a lista de criptomoedas disponíveis aqui (opens in a new tab).

Exemplo de uso: ?coin=BTC,ETH

Isso facilita a busca por informações específicas de criptomoedas de seu interesse.

currency (opcional)

O parâmetro "currency" é opcional e especifica a moeda na qual as informações serão retornadas. Por padrão, a moeda é definida como BRL, mas você pode escolher entre várias moedas disponíveis. Consulte a lista de moedas aqui (opens in a new tab).

Exemplo de uso: ?currency=BRL

Isso permite que você obtenha informações de cotação em diferentes moedas, dependendo de suas necessidades.

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 a obtenção de cotações simples até a busca de informações fundamentais e dados detalhados sobre criptomoedas.

Exemplo de Solicitação

Para uma solicitação que busca as cotações de BTC e ETH em relação ao BRL, a solicitação ficaria da seguinte forma:

curl -X GET \
"https://brapi.dev/api/v2/crypto?coin=BTC,ETC&currency=BRL&token=eJGEyu8vVHctULdVdHYzQd"
ParâmetroValor
coinBTC,ETC
currencyBRL
tokeneJGEyu8vVHctULdVdHYzQd

Resposta da Solicitação

200 OK

A solicitação foi bem-sucedida.

{
  "coins": [
    {
      "currency": "BRL",
      "currencyRateFromUSD": 5.1355,
      "coinName": "Bitcoin USD",
      "coin": "BTC",
      "regularMarketChange": -1570.9113445900002,
      "regularMarketPrice": 142013.9997515,
      "regularMarketChangePercent": -1.0940657,
      "regularMarketDayLow": 141363.00322950003,
      "regularMarketDayHigh": 142229.63939650002,
      "regularMarketDayRange": "141363.00322950003 - 142229.63939650002",
      "regularMarketVolume": 61914332113.408005,
      "marketCap": 2770574921580.5444,
      "regularMarketTime": 1696907700,
      "coinImageUrl": "https://s2.coinmarketcap.com/static/img/coins/64x64/1.png"
    },
    {
      "currency": "BRL",
      "currencyRateFromUSD": 5.1355,
      "coinName": "Ethereum Classic USD",
      "coin": "ETC",
      "regularMarketChange": -1.9971802353700003,
      "regularMarketPrice": 77.496348631,
      "regularMarketChangePercent": -2.5123825,
      "regularMarketDayLow": 77.03953563500001,
      "regularMarketDayHigh": 77.54323574600001,
      "regularMarketDayRange": "77.03953563500001 - 77.54323574600001",
      "regularMarketVolume": 434294814.51600003,
      "marketCap": 11115092801.024,
      "regularMarketTime": 1696907700,
      "coinImageUrl": "https://s2.coinmarketcap.com/static/img/coins/64x64/1321.png"
    }
  ]
}

400 Bad Request

A solicitação foi malformada, inválida ou a moeda não existe.

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

417 Expectation Failed

Não encontramos a moeda que você está procurando.

{
  "error": true,
  "message": "Missing required parameter: `coin`"
}

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