Documentação API
Acesso Rápido:
Api do Simulador
Como funciona:
*NOVIDADE* - Agora temos a API do simulador, para você testar seus robôs antes de ir para a plataforma real, no simulador todos os valores da bitPreço exchange são simulados e você pode testar o quanto quiser com dinheiro ficticio. Para usar é só trocar o endereço para: api-simulator.bitpreco.com e usar todos os endpoints abaixo trocando apenas a URL.
Api de dados
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 bitPreço possui 3 endpoints para acesso:
Ticker
https://api.bitpreco.com/btc-brl/ticker |
---|
Retornará um JSON com os campos |
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.bitpreco.com/btc-brl/orderbook |
---|
Retornará um JSON com os campos |
([{volume disponível}, {preço unitário em Reais}, {id da ordem}]) .
([{volume disponível}, {preço unitário em Reais}, {id da ordem}]) .
Exemplo de retorno:
{
|
Trades
https://api.bitpreco.com/btc-brl/trades |
---|
Retornará um JSON com os campos |
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}]
|
Api de negociações
Como funciona:
A API de Negociações da bitPreço permite que você automatize seus processos de compra e venda
de criptomoedas, e ainda aproveite dos descontos existentes na plataforma para aumentar a
rentabilidade de suas negociações ou arbitragens.
- A API permite no máximo 30 acessos por minuto, somando acessos da API de negociações e
pública.
O endpoint de acesso a API RESTFull é
https://api.bitpreco.com/trading/
Este endpoint, assim como todos os dados que trafegam no mesmo, é criptografado por SSL
Toda requisição deve ser feita pelo método POST e deve incluir o valor de ‘auth_token’, que
nada mais é que sua chave de acesso, composta pela concatenação das strings que representam
sua “assinatura” e “chave da api”. Você deve solicitar estas chaves dentro da própria
plataforma.
Veja exemplo
Você receberá por email:
"ABg3MTIxOTYzOQtrDtKNGae9YG3NjNHK0ZFVkY1UWVCaCtRQXYvWkIxRlAvSlRSV"
“ApVdlRUCddOd3p0RSt6VExvN3NqZlhIcUcxZWJpclRpSEpWSQ”
E seu token de acesso será:
auth_token = signature+api_key; (strings concatenadas)
Veja abaixo os métodos existentes na API de negociações:
BALANCE
Descrição: Devolve o balanço atual de sua conta |
---|
Propriedades da requisição:
Exemplo cURL:
curl --request POST \
--url https://api.bitpreco.com/trading/ \
--header 'Content-Type: application/json' \
--data '{ \
"cmd":"balance", \
"auth_token": "ABg3M………….SEpWSQ" \
}'
Exemplos de respostas:
{"success":true,"BTC":3.51633389,"BTC_locked":2.2983727,"BRL":180177.23,"BRL_locked":0}
Obs: "BTC" e "BRL" retornam a quantidade disponível para uso (available) e não a quantidade total em sua conta. O total é a soma destes valores com os valores bloqueados (locked)
Propriedades da requisição:
Exemplo cURL:
curl --request POST \
--url https://api.bitpreco.com/trading/ \
--header 'Content-Type: application/json' \
--data '{ \
"cmd":"open_orders", \
"market":"BTC-BRL",
"auth_token": "ABg3M………….SEpWSQ" \
}'
Exemplos de respostas:
{"id":"ZQVmZQNmZGNjZN","market":"BTC-BRL","type":"SELL","status":"EMPTY","amount":2.16,"price":25500,"exec_amount":0,"cost":0,"limited":"1"},
{"id":"AmNkAwDjZGNjZN","market":"BTC-BRL","type":"SELL","status":"PARTIAL","amount":0.2,"price":25600,"exec_amount":0.0616273,"cost":1577.66,"limited":"1"}
Propriedades da requisição:
Exemplo cURL:
curl --request POST \
--url https://api.bitpreco.com/trading/ \
--header 'Content-Type: application/json' \
--data '{ \
"cmd":"executed_orders", \
"market":"BTC-BRL",
"auth_token": "ABg3M………….SEpWSQ" \
}'
Exemplos de respostas:
{"id":"ZQVmZQNmZGNjZN","market":"BTC-BRL","type":"SELL","status":"FILLED","amount":0.16,"price":25500,"exec_amount":0.16,"cost":4080,"limited":"1"},
{"id":"AmNkAwDjZGNjZN","market":"BTC-BRL","type":"SELL","status":"PARTIAL","amount":0.2,"price":25600,"exec_amount":0.0616273,"cost":1577.66,"limited":"1"}
Propriedades da requisição:
Exemplo cURL:
curl --request POST \
--url https://api.bitpreco.com/trading/ \
--header 'Content-Type: application/json' \
--data '{ \
"cmd":"buy", \
"market":"BTC-BRL", \
"price": 25350.00, \
"amount": 1.00001234, \
"auth_token": "ABg3M………….SEpWSQ" \
}'
Exemplos de respostas:
{"success":true,"order_id":"AQt0BGRkZmNjZN","message_cod":"ORDER_CREATED"}
obs: O mercado BTC-BRL não permite precisão de centavos na API e o preço será aredondado.
Propriedades da requisição:
Exemplo cURL:
curl --request POST \
--url https://api.bitpreco.com/trading/ \
--header 'Content-Type: application/json' \
--data '{ \
"cmd":"sell", \
"market":"BTC-BRL", \
"price": 25350.00, \
"amount": 1.00001234, \
"auth_token": "ABg3M………….SEpWSQ" \
}'
Exemplos de respostas:
{"success":true,"order_id":"AQ1eBGRkZmNjZN","message_cod":"ORDER_CREATED"}
obs: O mercado BTC-BRL não permite precisão de centavos na API e o preço será aredondado.
Propriedades da requisição:
Exemplo cURL:
curl --request POST \
--url https://api.bitpreco.com/trading/ \
--header 'Content-Type: application/json' \
--data '{ \
"cmd":"order_cancel", \
"order_id":"AlDaJizAZTT", \
"auth_token": "ABg3M………….SEpWSQ" \
}'
Exemplos de respostas:
{"success":true,"message_cod":"ORDER_CANCELED"}
Propriedades da requisição:
Exemplo cURL:
curl --request POST \
--url https://api.bitpreco.com/trading/ \
--header 'Content-Type: application/json' \
--data '{ \
"cmd":"all_orders_cancel", \
"auth_token": "ABg3M………….SEpWSQ" \
}'
Exemplos de respostas:
{"success":true,"orders_canceled":3}
ORDER STATUS
Descrição: Mostra o status das ordens. |
---|
Propriedades da requisição:
Exemplo cURL:
curl --request POST \
--url https://api.bitpreco.com/trading/ \
--header 'Content-Type: application/json' \
--data '{ \
"cmd":"order_status", \
"order_id":"ZGNjAwVmZmRjZN", \
"auth_token": "ABg3M………….SEpWSQ" \
}'
Exemplos de respostas:
{"success":true,"order":{"id":"ZGNjAwVmZmRjZN","market":"BTC-BRL","type":"BUY","status":"EMPTY","amount":0.12,"price":14684.00,"exec_amount":0,"cost":0,"limited":"1","canceled":"0","time_stamp":"2019-01-09 05:36:17"}}
Existem essas possibilidades: EMPTY, PARTIAL, FILLED.