Acesso à API de Dados
O acesso à API de Dados é público, não é necessário criar uma conta tampouco autenticar.
Estrutura das Requisições
URL
É necessário fazer uma chamada HTTP, método GET, para a URL https://www.mercadobitcoin.net/api/
<coin>
/<method>
/Parâmetros de URL
Dois parâmetros são obrigatórios e presentes em todas as requisições:
coin
: Acrônimo da moeda digitalTipo: String
Domínio de dados:ACORDO01 : None
ASRFT : Fan Token ASR
ATMFT : Fan Token ATM
BCH : Bitcoin Cash
BTC : Bitcoin
CAIFT : Fan Token CAI
CHZ : Chiliz
ETH : Ethereum
GALFT : Fan Token GAL
IMOB01 : None
JUVFT : Fan Token JUV
LINK : CHAINLINK
LTC : Litecoin
MBCONS01 : Cota de Consórcio 01
MBCONS02 : Cota de Consórcio 02
MBFP01 : None
MBFP02 : None
MBPRK01 : Precatório MB SP01
MBPRK02 : Precatório MB SP02
MBPRK03 : Precatório MB BR03
MBPRK04 : Precatório MB RJ04
MBVASCO01 : MBVASCO01
MCO2 : MCO2
PAXG : PAX Gold
PSGFT : Fan Token PSG
USDC : USD Coin
WBX : WiBX
XRP : XRP
method
: Método da API de Dados requisitadoTipo: String
Domínio de dados:ticker : resumo de operações executadas
orderbook : livro de negociações, ordens abertas de compra e venda
trades : histórico de operações executadasRespostas
As Respostas são retornadas no formato JSON.
Exemplo de URL
https://www.mercadobitcoin.net/api/BTC/ticker/
Métodos da API
ticker
Descrição
Retorna informações com o resumo das últimas 24 horas de negociações.
Resultado
high
: Maior preço unitário de negociação das últimas 24 horas.Tipo: Decimallow
: Menor preço unitário de negociação das últimas 24 horas.Tipo: Decimalvol
: Quantidade negociada nas últimas 24 horas.Tipo: Decimallast
: Preço unitário da última negociação.Tipo: Decimalbuy
: Maior preço de oferta de compra das últimas 24 horas.Tipo: Decimalsell
: Menor preço de oferta de venda das últimas 24 horas.Tipo: Decimaldate
: Data e hora da informação em Era UnixTipo: InteiroExemplo de chamada:
https://www.mercadobitcoin.net/api/BTC/ticker/Exemplo de Retorno:
{ 'ticker': { 'high': 14481.47000000, 'low': 13706.00002000, 'vol': 443.73564488, 'last': 14447.01000000, 'buy': 14447.00100000, 'sell': 14447.01000000, 'date': 1502977646 } }
orderbook
Descrição
Livro de ofertas é composto por duas listas: (1) uma lista com as ofertas de compras ordenadas pelo maior valor; (2) uma lista com as ofertas de venda ordenadas pelo menor valor. O livro mostra até 1000 ofertas de compra e até 1000 ofertas de venda.
Uma oferta é constituída por uma ou mais ordens, sendo assim, a quantidade da oferta é o resultado da soma das quantidades das ordens de mesmo preço unitário. Caso uma oferta represente mais de uma ordem, a prioridade de execução se dá com base na data de criação da ordem, da mais antiga para a mais nova.
Resultado
bids
: Lista de ofertas de compras, ordenadas do maior para o menor preço.Tipo: Array[0]
: Preço unitário da oferta de compra.Tipo: Decimal[1]
: Quantidade da oferta de compra.Tipo: Decimalasks
: Lista de ofertas de venda, ordenadas do menor para o maior preço.Tipo: Array[0]
: Preço unitário da oferta de venda.Tipo: Decimal[1]
: Quantidade da oferta de venda.Tipo: DecimalExemplo de chamada:
https://www.mercadobitcoin.net/api/BTC/orderbook/Exemplo de Retorno
{ "asks": [ [10410.00006000, 2.09190016], [10420.00000000, 0.00997000], [10488.99999000, 0.46634897] ], "bids": [ [10405.38258000, 0.00181000], [10393.84180000, 0.08387000] ] }
trades
Descrição
Histórico de negociações realizadas.
Resultado
[]
: Lista de negociações realizadas.date
: Data e hora da negociação em Era UnixTipo: Decimalprice
: Preço unitário da negociação.Tipo: Decimalamount
: Quantidade da negociação.Tipo: Decimaltid
: Identificador da negociação.Tipo: Inteirotype
: Indica a ponta executora da negociaçãoTipo: String
Domínio de dados:buy : indica ordem de compra executora
sell : indica ordem de venda executoraExemplo de chamada:
https://www.mercadobitcoin.net/api/BTC/trades/Parâmetros adicionais
A chamada tradicional do histórico irá retornar as últimas 1000 negociações. Para obter dados anteriores, é necessário utilizar outros parâmetros conforme descrito e exemplificado abaixo:
tid
ousince
: Retorna até 1000 negociações a partir do identificador da negociação informado.Chamadas:
https://www.mercadobitcoin.net/api/coin
/trades/?tid=<tid>
https://www.mercadobitcoin.net/api/coin
/trades/?since=<since>
Exemplo:https://www.mercadobitcoin.net/api/BTC/trades/?tid=5700 https://www.mercadobitcoin.net/api/BTC/trades/?since=5700
from
: Retorna até 1000 negociações a partir da data informada.Formato: Era Unix
Chamada: https://www.mercadobitcoin.net/api/coin
/trades/<from>
/
Exemplo:https://www.mercadobitcoin.net/api/BTC/trades/1501871369/
from
-to
: Retorna até 1000 negociações entre o intervalo de timestamp informado.Formato: Era Unix
Chamada: https://www.mercadobitcoin.net/api/coin
/trades/<from>
/<to>
/
Exemplo:https://www.mercadobitcoin.net/api/BTC/trades/1501871369/1501891200/
Exemplo de Retorno
[ { 'date': 1502993741, 'price': 14086.00000000, 'amount': 0.03840000, 'tid': 797861, 'type': 'sell' }, { 'date': 1502993741, 'price': 14086.00101000, 'amount': 0.08519000, 'tid': 797860, 'type': 'sell' }, { 'date': 1502993907, 'price': 14200.00000000, 'amount': 0.01370282, 'tid': 797871, 'type': 'buy' }, { 'date': 1502993898, 'price': 14200.00000000, 'amount': 0.00697183, 'tid': 797870, 'type': 'buy' }, { 'date': 1502982896, 'price': 14320.00101000, 'amount': 0.02089000, 'tid': 796876, 'type': 'sell' } ]
day-summary
Descrição
Retorna resumo diário de negociações realizadas.
Resultado
date
: Data do resumo diárioTipo: String
Formato: AAAA-MM-DD, exemplo: 2013-06-20opening
: Preço unitário de abertura de negociação no dia.Tipo: Decimalclosing
: Preço unitário de fechamento de negociação no dia.Tipo: Decimallowest
: Menor preço unitário de negociação no dia.Tipo: Decimalhighest
: Maior preço unitário de negociação no dia.Tipo: Decimalvolume
: Volume de Reais (BRL) negociados no dia.Tipo: Decimalquantity
: Quantidade da moeda digital negociada no dia.Tipo: Decimalamount
: Número de negociações realizadas no dia.Tipo: Inteiroavg_price
: Preço unitário médio das negociações no dia.Tipo: DecimalParâmetros adicionais
year
,month
,day
: Respectivamente ano, mês e dia referente ao dia do ano requisitado.Chamadas:
https://www.mercadobitcoin.net/api/coin
/day-summary/<year>
/<month>
/<day>
/
Exemplo:https://www.mercadobitcoin.net/api/BTC/day-summary/2013/6/20/
Exemplo de Retorno
{ 'date': '2013-06-20', 'opening': 262.99999, 'closing': 269.0, 'lowest': 260.00002, 'highest': 269.0, 'volume': 7253.1336356785, 'quantity': 27.11390588, 'amount': 28, 'avg_price': 267.5060416518087 }
Glossário
API - Conjunto de rotinas e padrões para acesso a um aplicativo ou plataforma, leia mais em: https://en.wikipedia.org/wiki/Application_programming_interface.
CORS (Cross-Origin Resource Sharing) - Em termos práticos, é um recurso de segurança dos navegadores que impede um domínio de fazer requisições Ajax de um outro domínio, a não ser que seja explicitamente pelo domínio de origem da informação, leia mais em: https://en.wikipedia.org/wiki/Cross-origin_resource_sharing
Domínio de dados - Conjunto de valores possíveis para um determinado campo, leia mais em: https://en.wikipedia.org/wiki/Data_domain.
Era Unix - Sistema de calendário utilizado pelo sistema operacional UNIX representado por um número inteiro de até 32 bits. É útil para comunicação e cálculos em sistemas devido a sua simplicidade. Seus valores representam a quantidade de segundos a partir do dia 1 de janeiro de 1970. É um horário sem variações de fuso horário ou horário de verão, assim utiliza apenas UTC/GMT, leia mais em: https://pt.wikipedia.org/wiki/Era_Unix. Veja exemplos de código em diversas linguagens em: http://www.epochconverter.com.
JSON - Formato leve para intercâmbio de dados computacionais, leia mais em: https://pt.wikipedia.org/wiki/JSON.
String - Tipo de dado texto, cadeia de caracteres, leia mais em: https://en.wikipedia.org/wiki/String_(computer_science).