web

DOCUMENTAÇÃO API

Como funciona:

Nosso site fornece APIs que possibilitam os usuários conseguir informações atualizadas sobre os principais dados do Bitcoin em nossa plataforma. API é um endereço de internet onde você pode receber dados via requisição HTTP GET. O retorno é em formato JSON.

O Clube Bitcoin possui 3 APIs para acesso:

  • ticker: retorna o ticker de preço da criptomoeda.
  • orderbook: retorna as ofertas de compra e venda da criptomoeda.
  • trades: retorna as negociações ou operações realizadas da criptomoeda.

  • Ticker

    https://api.clubebitcoin.net/btc-brl/ticker
    Retornará um JSON com os campos
  • high: maior valor negociado nas últimas 24h.
  • low: menor valor negociado nas últimas 24h.
  • var: variação entre o menor e maior valor (em porcentagem).
  • vol: Volume negociado nas últimas 24h.
  • last: Último valor negociado.
  • timestamp: dia e horas que foram gerados estes valores.


  • Exemplo de retorno: { "last":26353.32, "high":26636.3, "low":26162.93, "vol":0.19396095, "var":-1.78, "timestamp":2018-09-11 22:17:26 }


    Orderbook

    https://api.clubebitcoin.net/btc-brl/orderbook
    Retornará um JSON com os campos
  • asks: lista das ofertas de venda disponíveis. As ofertas são listadas com os valores de volume disponível seguido do preço unitário em Reais e id da ordem. ([{volume disponível}, {preço unitário em Reais}, {id da ordem}]).
  • bids: lista das ofertas de compra disponíveis. As ofertas são listadas com os valores de volume disponível seguido do preço unitário em Reais e id da ordem.([{volume disponível}, {preço unitário em Reais}, {id da ordem}]).
  • timestamp: dia e horas que foram gerados estes valores.

  • Exemplo de retorno:
    {
    "bids":[{ "amount":0.00337633, "price":26697.09, "id":"AQV2BGNlZQNjZN" }],
    "asks":[{ "amount":0.10909091, "price":27194.93, "id":"ZwV2BGNlZQNjZN"}],
    "timestamp":"2018-09-13 01:44:27"
    }


    Trades

    https://api.clubebitcoin.net/btc-brl/trades
    Retornará um JSON com os campos
  • type: tipo de ordem executada, buy: compra e sell: venda.
  • amount: quantidade transacionada.
  • timestamp: dia e horas que foram gerados estes valores.
  • price: preço unitário em reais.

  • Exemplo de retorno:
    [{"type":"BUY", "amount":0.0018522, "timestamp":"2018-09-12 17:20:38", "price":26313.85},
    {"type":"SELL", "amount":0.01126283, "timestamp":"2018-09-11 22:18:18", "price":26636.3}]