Documentação API Bitinka

O que é a API Bitinka ?

É a Interface de Programação de Aplicação (API) que ofrece a BitInka para ter um conjunto de métodos pelas quais as aplicações externas podem ser integradas à nossa plataforma.

O que posso fazer com a API Bitinka?

Com a API Bitinka pode consultar o volume da oferta e demanda de vários mercados de criptomoedas, consultar o saldo, conferir o histórico das ordens (Trade History), criar ou cancelar ordens de compra/venda em todos os mercados e mais.

A API tem métodos públicos e privados, que recebem dados em formato JSON e por default dão respostas em formato XML na sua versão 1.0, com codificação utf-8 ou JSON

Como começo?

Cadastrar-se e criar as chaves que servem como credencias para o uso da API.

Para criá-las, ir a "Carteira" > "Chaves API". Deve proporcionar um identificador para cada chave, com ele, vai gerar uma key com seu código secreto único, que vai lhe permitir ter acesso a um conjunto de funções privadas.

Exemplo:
Key: ZUMAXOZR-R78S017Q-CAS8H8TW-T52RMFSL-58HIJK4F
Secret: 26n28utk4lsmumjnrlfe070bmwiprgjun7xv1q1nf424s3ldw9j52ktsgipmvrt3

FUNÇÕES PÚBLICOS DE DADOS

MARKETS

Permite visualizar os mercados disponíveis para o exchange.

Solicitar
GET https://www.bitinka.com/api/apinka/markets
Volta para os mercados disponíveis em formato XML.
GET https://www.bitinka.com/api/apinka/markets?format=json
Volta para os mercados disponíveis em formato JSON
Resposta (JSON)
pair Os pares disponíveis do mercado
Exemplo:BTC_ARS, BTC_BOB, BTC_BRL, BTC_CLP, BTC_CNY, BTC_COP, BTC_EUR, BTC_PEN, LTC_BTC, XRP_BTC, DASH_BTC, ACT_BTC, VEX_BTC, NEO_BTC, GAS_BTC, SSP_BTC, SSC_BTC, BTG_BTC, BCH_BTC, NANO_BTC, ETH_BTC, ETH_ARS, ETH_BOB, ETH_BRL, ETH_CLP, ETH_CNY, ETH_COP, ETH_EUR, ETH_PEN, LTC_ETH, DASH_ETH, ACT_ETH, VEX_ETH, NEO_ETH, GAS_ETH, SSP_ETH, SSC_ETH, BTG_ETH, BCH_ETH, NANO_ETH, XRP_ETH, BTC_USD, ETH_USD, DASH_USD, LTC_USD, XRP_USD, ACT_USD, VEX_USD, NEO_USD, GAS_USD, SSP_USD, SSC_USD, BTG_USD, BCH_USD, NANO_USD.

TICKER

Volta para os valores do mercado nas últimas horas, o volume 24H de cada mercado, a última oferta e a última demanda.

Solicitar
GET https://www.bitinka.com/api/apinka/ticker
Volta para os valores de todos os mercados em formato XML
GET https://www.bitinka.com/api/apinka/ticker?format=json
Volta para os valores de todos os mercados em formato JSON.
Resposta (JSON)
volumen24hour Volume por mercado nas últimas 24 horas
Ask Ordem de venda mais baixa.
Bid Ordem de compra mais alta.
lastPrice Último preço de cada mercado.

TICKER BROKER

Volta para os valores do mercado nas últimas horas, o volume 24H de cada mercado, a última oferta e a última demanda.

GET https://www.bitinka.com/api/apinka/ticker/broker
Volta para os valores de todos os mercados em formato XML.
GET https://www.bitinka.com/api/apinka/ticker/broker?format=json
Volta para os valores de todos os mercados em formato JSON.
Resposta (JSON)
volumen24hour Volume por mercado nas últimas 24 horas
Ask Ordem de venda mais baixa.
Bid Ordem de compra mais alta.
lastPrice Último preço de cada mercado.

TICKER POR PAR

Volta para os valores de um par específico nas últimas horas, o volume 24H do mercado, a última oferta e a última demanda.

Solicitar
GET https://www.bitinka.com/api/apinka/ticker/{currency_pair}
Volta para os valores de todos os mercados em formato XML.
GET https://www.bitinka.com/api/apinka/ticker/{currency_pair}?format=json
Volta para os valores do mercado escolhido em formato JSON.
Valores suportados para currency_pair:Exemplo: BTC_ARS, BTC_BOB, BTC_BRL, BTC_CLP, BTC_CNY, BTC_COP, BTC_EUR, BTC_PEN, LTC_BTC, XRP_BTC, DASH_BTC, ACT_BTC, VEX_BTC, NEO_BTC, GAS_BTC, SSP_BTC, SSC_BTC, BTG_BTC, BCH_BTC, NANO_BTC, ETH_BTC, ETH_ARS, ETH_BOB, ETH_BRL, ETH_CLP, ETH_CNY, ETH_COP, ETH_EUR, ETH_PEN, LTC_ETH, DASH_ETH, ACT_ETH, VEX_ETH, NEO_ETH, GAS_ETH, SSP_ETH, SSC_ETH, BTG_ETH, BCH_ETH, NANO_ETH, XRP_ETH, BTC_USD, ETH_USD, DASH_USD, LTC_USD, XRP_USD, ACT_USD, VEX_USD, NEO_USD, GAS_USD, SSP_USD, SSC_USD, BTG_USD, BCH_USD, NANO_USD.
Resposta (JSON)
volumen24hour Volume por mercado nas últimas 24 horas
Ask Ordem de venda mais baixa.
Bid Ordem de compra mais alta.
lastPrice Último preço de cada mercado.

TICKER POR PAR DE BROKER

Volta para os valores de um par específico nas últimas horas, o volume 24H do mercado, a última oferta e a última demanda.

Solicitar
GET https://www.bitinka.com/api/apinka/ticker/broker/{pair}
Volta para os valores de todos os mercados em formato XML.
GET https://www.bitinka.com/api/apinka/ticker/broker/{pair}/?format=json
Volta para os valores do mercado escolhido em formato JSON.
Resposta (JSON)
volumen24hour Volume por mercado nas últimas 24 horas
Ask Ordem de venda mais baixa.
Bid Ordem de compra mais alta.
lastPrice Último preço de cada mercado.
Valores suportados para pair: BTC_ARS, BTC_BOB, BTC_BRL, BTC_CLP, BTC_CNY, BTC_COP,BTC_EUR, BTC_PEN, LTC_BTC, XRP_BTC, DASH_BTC, ACT_BTC, VEX_BTC, NEO_BTC, GAS_BTC, SSP_BTC, SSC_BTC, BTG_BTC, BCH_BTC, NANO_BTC, ETH_BTC, ETH_ARS, ETH_BOB, ETH_BRL, ETH_CLP, ETH_CNY, ETH_COP, ETH_EUR, ETH_PEN, LTC_ETH, DASH_ETH, ACT_ETH, VEX_ETH, NEO_ETH, GAS_ETH, _ETH, SSC_ETH, BTG_ETH, BCH_ETH, NANO_ETH, XRP_ETH, BTC_USD, ETH_USD, DASH_USD, LTC_USD, XRP_USD, ACT_USD, VEX_USD, NEO_USD, GAS_USD, SSP_USD, SSC_USD, BTG_USD, BCH_USD, NANO_USD.

LIVRO DA ORDEM

Obter todas as ofertas de compra e venda ativas do mercado.

Solicitar
GET https://www.bitinka.com/api/apinka/order_book/{currency_pair}
Volta para as ordens de compra e venda do mercado escolhido em formato XML.
GET https://www.bitinka.com/api/apinka/order_book/{currency_pair}?format=json
Volta para as ordens de compra e venda do mercado escolhido em formato JSON.
Valores suportados para currency_pair: : BTC_ARS, BTC_BOB, BTC_BRL, BTC_CLP, BTC_CNY, BTC_COP, BTC_EUR, BTC_PEN, LTC_BTC, XRP_BTC, DASH_BTC, ACT_BTC, VEX_BTC, NEO_BTC, GAS_BTC, SSP_BTC, SSC_BTC, BTG_BTC, BCH_BTC, NANO_BTC, ETH_BTC, ETH_ARS, ETH_BOB, ETH_BRL, ETH_CLP, ETH_CNY, ETH_COP, ETH_EUR, ETH_PEN, LTC_ETH, DASH_ETH, ACT_ETH, VEX_ETH, NEO_ETH, GAS_ETH, SSP_ETH, SSC_ETH, BTG_ETH, BCH_ETH, NANO_ETH, XRP_ETH, BTC_USD, ETH_USD, DASH_USD, LTC_USD, XRP_USD, ACT_USD, VEX_USD, NEO_USD, GAS_USD, SSP_USD, SSC_USD, BTG_USD, BCH_USD, NANO_USD.
Resposta (JSON)
Volta para o dicionário JSON com ’’ofertas’’ e ’’pedidos’’. Cada uma é uma lista de ordens abertas e cada ordem é representada como uma lista que tem o preço e a quantidade.

FUNÇÕES PRIVADAS

OBTÊR O SALDO DO COMÉRCIO

Obter o saldo de comércio de todas as moedas do usuário.

Solicitar
POST https://www.bitinka.com/api/apinka/get_balance
Volta para o saldo disponível para comerciar em cada moeda em formato XML
POST https://www.bitinka.com/api/apinka/get_balance/format/json
Volta para o saldo disponível para comerciar em cada moeda em formato JSON
Solicitar os parâmetros
Key API Key.
secret Secreto.
Example {
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x

}
Resposta (JSON)
coin Moeda
balance Saldo disponível na trade wallet

OBTER O SALDO

Obter o saldo da wallet de todas as moedas do usuário.

Solicitar
POST https://www.bitinka.com/api/apinka/get_wallet_balance
Volta para o saldo disponível de cada moeda em formato XML.
POST https://www.bitinka.com/api/apinka/get_wallet_balance/format/json
Volta para o saldo disponível de cada moeda em formato JSON.
Solicitar os parâmetros
Key API Key.
secret Secreto.
Example {
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x

}
Resposta (JSON)
coin Moeda
balance Saldo disponível na funds wallet

CRIAR ORDEM

Criar uma oferta de compra ou venda num mercado específico.

Solicitar
POST https://www.bitinka.com/api/apinka/create_order
Criar uma oferta de compra ou venda segundo o tipo de trade, resposta em formato XML
POST https://www.bitinka.com/api/apinka/create_order/format/json
Criar uma oferta de compra ou venda segundo o tipo de trade, resposta em formato XML
Solicitar os parâmetros
Key API Key.
secret Secreto.
typeOrder “Comprar” ou “Vender”
price Preço
investement Quantidade
firstCurrency Primeira moeda do par
secondCurrency Segunda moeda do par
trade Tipo de trade no qual deseja criar a ordem.
Os tipos de trade são (1) Limit, (2) Market, (5) Fill or kill
Example {
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
new :
{
"typeOrder" : "sell",
"price" : "7000",
"investement" : "0.00670987",
"firstCurrency" : "BTC",
"secondCurrency" : "USD",
"trade" : 1
}

}
Resposta (JSON)
amount Quantidade
balanceUser Saldo disponível do usuário para fazer trading
date Data
error True ou False, para erros
firstCurrency Primeira moeda do par
idOrder ID da ordem
method Método de criação
price Preço
priceMarket Preço do mercado atual
secondCurrency Segunda moeda do par
status Status da ordem
total Quantidade total = Price* Amount
typeOrder Tipo de ordem COMPRAR ou VENDER
typeTrading Tipo de trade
username Username do usuário no sistema.

CREATE ORDER STOP

Criar uma oferta de compra ou venda num mercado específico.

Solicitar
POST https://www.bitinka.com/api/apinka/create_order/stop
Criar uma oferta de compra ou venda segundo o tipo de trade, resposta em formato XML
POST https://www.bitinka.com/api/apinka/create_order/stop/format/json
Criar uma oferta de compra ou venda segundo o tipo de trade, resposta em formato XML
Solicitar os parâmetros
Key API Key.
secret Secreto.
typeOrder “Comprar” ou “Vender”
priceLimit Precio en el que se creará la orden
priceStop Precio en el que se dispara la orden
investement Quantidade
firstCurrency Primeira moeda do par
secondCurrency Segunda moeda do par
trade Tipo de trade no qual deseja criar a ordem.
percentage Porcentaje
Tipo de trade (3) Stop Unitario, (4) Stop Porcentual (%)
Example {
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
new :
{
"typeOrder" : "sell",
"priceLimit" : "6500",
"priceStop" : "6400",
"investement" : "0.00670987",
"firstCurrency" : "BTC",
"secondCurrency" : "USD",
"trade" : 4,
"percentage" : 10
}

}
Resposta (JSON)
amount Quantidade
balanceUser Saldo disponível do usuário para fazer trading
date Data
error True ou False, para erros
firstCurrency Primeira moeda do par
idOrder ID da ordem
method Método de criação
price Preço
priceMarket Preço do mercado atual
secondCurrency Segunda moeda do par
status Status da ordem
total Quantidade total = Price* Amount
typeOrder Tipo de ordem COMPRAR ou VENDER
typeTrading Tipo de trade
username Username do usuário no sistema.

ADICIONAR A ORDEM BROKER

Fazer uma compra ou venda num mercado específico, de jeito instantâneo.

Solicitar
POST https://www.bitinka.com/api/apinka/addOrderbroker
Fazer uma compra ou venda instantânea, resposta em formato XML
POST https://www.bitinka.com/api/apinka/addOrderbroker/format/json
Fazer uma compra ou venda instantânea, resposta em formato JSON
Solicitar os parâmetros
Key API Key.
secret Secreto.
firstCurrency Primeira moeda do par
secondCurrency Segunda moeda do par
amount Quantidade
type “Comprar” ou “Vender”
Example {
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
new :
{
"firstCurrency" : "BTC",
"secondCurrency" : "USD",
"amount" : "0.00670987",
"type" : "sell"
}

}
Resposta (JSON)
return Resposta da petição
status Status da ordem
order_id ID da ordem
price Preço

CANCEL ORDER

Cancelar uma ordem de compra ou venda num mercado específico ou pelo ID.

Solicitar
POST https://www.bitinka.com/api/apinka/cancel_order
Cancelar uma ou mais ordens, e voltar para o saldo, resposta em formato XML
POST https://www.bitinka.com/api/apinka/cancel_order/format/json
Cancelar uma ou mais ordens, e voltar para o saldo, resposta em formato JSON
Solicitar os parâmetros
Key API Key.
secret Secreto.
pair Cancelar todas as ordens do pair.
Solicitar os parâmetros v2
Key API Key.
secret Secreto.
id Cancelar todas as ordens segundo o ID
Example {
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
pair: BTC_USD

}


o

{
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
id: 35678

}
Resposta (JSON)
balance Saldo atualizado do usuário
cancellationDate Data do cancelamento
coin Moeda
creationDate Data de criação
error True ou False, para erros
idOrder ID da ordem
investement Quantidade
status Estatus
typeOrder Tipo de ordem COMPRAR ou VENDER
username Username del usuario

ORDENS DO USUÁRIO

Histórico das ordens ativas de compra e venda do usuário por tipo de trade.

Solicitar
POST https://www.bitinka.com/api/apinka/orders_user
Volta para o histórico de ordens ativas do usuário, resposta em formato XML
POST https://www.bitinka.com/api/apinka/orders_user/format/json
Volta para o histórico de ordens ativas do usuário, resposta em formato JSON
Solicitar os parâmetros
Key API Key.
secret Secreto.
firstCurrency Primeira moeda do par
secondCurrency Segunda moeda do par
trade Tipo de trade
Os tipos de trade são (1) Limit,(3) Stop Unitario, (4) Stop Porcentual (%)
Example {
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
firstCurrency : "BTC",
secondCurrency : "USD",
trade: "1"

}
Resposta (JSON)
order_id ID da ordem
fromCurrency Primeira moeda do par
toCurrency Segunda moeda do par
Type Tipo de ordem COMPRAR ou VENDER
Price Preço
Amount Quantidade
Total Quantidade total = Price* Amount
datetime Data de criação
status Status da ordem

TRADE HISTORY

Histórico das transações completadas do usuário. Pode visualizar as ordens atuais e as anteriores.

Solicitar
POST https://www.bitinka.com/api/apinka/trade_history
Volta para o histórico de ordens completadas do usuário, resposta em formato XML
POST https://www.bitinka.com/api/apinka/trade_history/format/json
Volta para o histórico de ordens completadas do usuário, resposta em formato JSON
Solicitar os parâmetros
Key API Key.
secret Secreto.
firstCurrency Primeira moeda do par
secondCurrency Segunda moeda do par
Example {
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
firstCurrency: "BTC",
secondCurrency: "USD"

}
Resposta (JSON)
trade_id ID da ordem
fromCurrency Primeira moeda do par
toCurrency Segunda moeda do par
Amount Quantidade
Price Preço
Type Tipo de ordem COMPRAR ou VENDER
Fee Quantidade da taxa
Total Quantidade total = Price* Amount
datetime Data e hora de criação
status Status da ordem

ORDENS CANCELADAS

Histórico das transações completadas do usuário. Pode visualizar as ordens atuais e as anteriores.

Solicitar
POST https://www.bitinka.com/api/apinka/orders_cancelled
Volta para o histórico de ordens canceladas do usuário, resposta em formato XML
POST https://www.bitinka.com/api/apinka/orders_cancelled/format/json
Volta para o histórico de ordens canceladas do usuário, resposta em formato JSON
Solicitar os parâmetros
Key API Key.
secret Secreto.
trade Tipo de trade
Example {
Key: JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
Secret: 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
trade: "1"
}
Resposta (JSON)
order_id ID da ordem
fromCurrency Primeira moeda do par
toCurrency Segunda moeda do par
Type Tipo de ordem COMPRAR ou VENDER
Price Preço
Amount Quantidade
Total Quantidade total = Price* Amount
status Status da ordem