¿Qué es API Bitinka?
Es la Interfaz de Programación de Aplicaciones (API) que ofrece BitInka para brindar una suite de métodos por las cuales aplicaciones externas pueden integrarse a nuestra plataforma.
¿Qué puedo hacer con la API Bitinka?
Con la API Bitinka podrá consultar el volumen de la oferta y demanda de diferentes mercados de criptomonedas, consultar el balance, ver el historial de órdenes (Trade History), crear ó cancelar órdenes de compra y venta en todos los mercados y más.
La API cuenta con métodos públicos y privados, los cuales reciben datos en formato JSON y por defecto sirven respuestas en formato XML en su versión 1.0, con codificación utf-8 o JSON
¿Cómo empiezo?
Regístrate y crea las llaves que sirven como credenciales para el uso de la API.
Para crearlas, tiene que dirigirse a "Billetera" > "Claves API". Debe proporcionar un identificador para cada llave con el cual se le generará una key con su código secreto único; que le permitirá acceder a un conjunto de funciones privadas.
Ejemplo:
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x"
}
PUBLIC DATA FUNCTIONS
MERCADOS
Permite visualizar los mercados disponibles para el exchange.
Request |
GET |
https://www.bitinka.com/api/apinka/markets |
|
Retorna los mercados disponibles en formato XML |
GET |
https://www.bitinka.com/api/apinka/markets?format=json |
|
Retorna los mercados disponibles en formato JSON |
Response (JSON) |
pair |
Los pares disponibles del mercado |
|
Ejemplo: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
Retorna los valores del mercado en las últimas horas, el volumen 24H de cada mercado, la última oferta y la última demanda.
Request |
GET |
https://www.bitinka.com/api/apinka/ticker |
|
Retorna los valores de todos los mercados en formato XML |
GET |
https://www.bitinka.com/api/apinka/ticker?format=json |
|
Retorna los valores de todos los mercados en formato JSON |
Response (JSON) |
volumen24hour |
Volumen por mercado en las últimas 24 horas |
Ask |
Orden de venta más baja |
Bid |
Orden de compra más alta |
lastPrice |
Último precio de cada mercado |
TICKER BROKER
Retorna los valores del mercado en las últimas horas, el volumen 24H de cada mercado, la última oferta y la última demanda.
GET |
https://www.bitinka.com/api/apinka/ticker/broker |
|
Retorna los valores del mercado seleccionado en formato XML |
GET |
https://www.bitinka.com/api/apinka/ticker/broker?format=json |
|
Retorna los valores de todos los mercados en formato JSON |
Response (JSON) |
volumen24hour |
Volumen por mercado en las últimas 24 horas |
Ask |
Orden de venta más baja |
Bid |
Orden de compra más alta |
lastPrice |
Último precio de cada mercado |
TICKER POR PAR
Retorna los valores de un par en específico en las últimas horas, el volumen 24H del mercado, la última oferta y la última demanda.
Request |
GET |
https://www.bitinka.com/api/apinka/ticker/{currency_pair} |
|
Retorna los valores del mercado seleccionado en formato XML |
GET |
https://www.bitinka.com/api/apinka/ticker/{currency_pair}?format=json |
|
Retorna los valores del mercado seleccionado en formato JSON |
|
Valores soportados para currency_pair:Ejemplo: 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.
|
Response (JSON) |
volumen24hour |
Volumen por mercado en las últimas 24 horas |
Ask |
Orden de venta más baja |
Bid |
Orden de compra más alta |
lastPrice |
Último precio de cada mercado |
TICKER POR PAR DE BROKER
Retorna los valores de un par en específico en las últimas horas, el volumen 24H del mercado, la última oferta y la última demanda.
Request |
GET |
https://www.bitinka.com/api/apinka/ticker/broker/{pair} |
|
Retorna los valores del mercado seleccionado en formato XML |
GET |
https://www.bitinka.com/api/apinka/ticker/broker/{pair}/?format=json |
|
Retorna los valores del mercado seleccionado en formato JSON |
Response (JSON) |
volumen24hour |
Volumen por mercado en las últimas 24 horas |
Ask |
Orden de venta más baja |
Bid |
Orden de compra más alta |
lastPrice |
Último precio de cada mercado |
|
Valores soportados 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.
|
ORDER BOOK
Obtiene todas las ofertas de compra y venta activas del mercado.
Request |
GET |
https://www.bitinka.com/api/apinka/order_book/{currency_pair} |
|
Retorna los órdenes de compra y venta del mercado seleccionado en formato XML |
GET |
https://www.bitinka.com/api/apinka/order_book/{currency_pair}?format=json |
|
Retorna los órdenes de compra y venta del mercado seleccionado en formato JSON |
|
Valores soportados 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.
|
Response (JSON) |
Devuelve un diccionario JSON con ’’bids’’ y ’’asks’’. Cada uno es una lista de ordenes abiertos y cada orden se representa como una lista que contiene el precio y el monto. |
Historial de Ordenes
Historial de las transacciones completadas. Puede visualizar las órdenes actuales.
Request |
GET |
https://www.bitinka.com/api/apinka/order_history/{currency_pair} |
|
Retorna historial de ordenes completadas, respuesta en formato XML |
GET |
https://www.bitinka.com/api/apinka/order_history/{currency_pair}?format=json |
|
Retorna historial de ordenes completadas, respuesta en formato JSON |
|
Valores soportados 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.
|
Response (JSON) |
Amount |
Cantidad |
Price |
Precio |
Type |
Tipo de Orden BUY o SELL |
Fee |
Monto de Comisión |
Total |
Monto total = Price* Amount |
datetime |
Fecha y hora de creación |
PRIVATE FUNCTIONS
GET TRADE BALANCE
Obtiene el balance de la Bitinka Wallet en todas las monedas disponibles para el usuario.
Request |
POST |
https://www.bitinka.com/api/apinka/get_balance |
|
Retorna el balance disponible de la Bitinka Wallet en cada moneda en formato XML |
POST |
https://www.bitinka.com/api/apinka/get_balance/format/json |
|
Retorna el balance disponible de la Bitinka Wallet en cada moneda en formato JSON |
Request parameters |
Key |
API Key. |
secret |
Secret. |
Example |
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x"
}
|
Response (JSON) |
coin |
Moneda |
balance |
Balance disponible de la Bitinka Wallet |
GET BALANCE
Obtiene el balance de la TOP-UP Wallet en todas las monedas disponibles para el usuario.
Request |
POST |
https://www.bitinka.com/api/apinka/get_wallet_balance |
|
Retorna el balance disponible de la TOP-UP Wallet en cada moneda en formato XML |
POST |
https://www.bitinka.com/api/apinka/get_wallet_balance/format/json |
|
Retorna el balance disponible de la TOP-UP Wallet en cada moneda en formato JSON |
Request parameters |
Key |
API Key. |
secret |
Secret. |
Example |
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x"
}
|
Response (JSON) |
coin |
Moneda |
balance |
Balance disponible de la TOP-UP Wallet |
CREATE ORDER
Crear una oferta de compra o venta en un mercado específico.
Request |
POST |
https://www.bitinka.com/api/apinka/create_order |
|
Crear una orden compra o venta según el tipo de trade, respuesta en formato XML |
POST |
https://www.bitinka.com/api/apinka/create_order/format/json |
|
Crear una orden compra o venta según el tipo de trade, respuesta en formato JSON |
Request parameters |
Key |
API Key. |
secret |
Secret. |
typeOrder |
“Buy” o “Sell” |
price |
Precio |
investement |
Cantidad |
firstCurrency |
Primera moneda del par |
secondCurrency |
Segunda moneda del par |
trade |
Tipo de trade, en que desea crear la orden |
|
Los tipos de trade son: (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
}
}
|
Response (JSON) |
amount |
Cantidad |
balanceUser |
Balance disponible del usuario para realizar trading |
date |
Fecha |
error |
True o False, para errores |
firstCurrency |
Primera moneda del par |
idOrder |
Id de la orden |
method |
Método de creación |
price |
Precio |
priceMarket |
Precio del mercado actual |
secondCurrency |
Segunda moneda del par |
status |
Estatus de la orden |
total |
Monto total = Price* Amount |
typeOrder |
Tipo de Orden BUY o SELL |
typeTrading |
Tipo de trade |
username |
Username del usuario en el sistema |
CREATE ORDER STOP
Crear una oferta de compra o venta en un mercado específico.
Request |
POST |
https://www.bitinka.com/api/apinka/create_order/stop |
|
Crear una orden compra o venta según el tipo de trade, respuesta en formato XML |
POST |
https://www.bitinka.com/api/apinka/create_order/stop/format/json |
|
Crear una orden compra o venta según el tipo de trade, respuesta en formato XML |
Request parameters |
Key |
API Key. |
secret |
Secret. |
typeOrder |
“Buy” o “Sell” |
priceLimit |
Precio en el que se creará la orden |
priceStop |
Precio en el que se dispara la orden |
investement |
Cantidad |
firstCurrency |
Primera moneda del par |
secondCurrency |
Segunda moneda del par |
trade |
Tipo de trade, en que desea crear la orden |
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
}
}
|
Response (JSON) |
amount |
Cantidad |
balanceUser |
Balance disponible del usuario para realizar trading |
date |
Fecha |
error |
True o False, para errores |
firstCurrency |
Primera moneda del par |
idOrder |
Id de la orden |
method |
Método de creación |
price |
Precio |
priceMarket |
Precio del mercado actual |
secondCurrency |
Segunda moneda del par |
status |
Estatus de la orden |
total |
Monto total = Price* Amount |
typeOrder |
Tipo de Orden BUY o SELL |
typeTrading |
Tipo de trade |
username |
Username del usuario en el sistema |
ADD ORDER BROKER
Realizar una compra o venta en un mercado específico, de manera instantánea.
Request |
POST |
https://www.bitinka.com/api/apinka/addOrderbroker |
|
Realiza una compra o venta instantánea, respuesta en formato XML |
POST |
https://www.bitinka.com/api/apinka/addOrderbroker/format/json |
|
Realiza una compra o venta instantánea, respuesta en formato JSON |
Request parameters |
Key |
API Key. |
secret |
Secret. |
firstCurrency |
Primera moneda del par |
secondCurrency |
Segunda moneda del par |
amount |
Cantidad |
type |
“Buy” o “Sell” |
Example |
{
"key": JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
"secret": 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
new :
{
"firstCurrency" : "BTC",
"secondCurrency" : "USD",
"amount" : "0.00670987",
"type" : "sell"
}
}
|
Response (JSON) |
return |
Respuesta de la petición |
status |
Estatus de la orden |
order_id |
Id de la orden |
price |
Precio |
CANCELAR ORDEN
Cancelar una orden de compra o venta en un mercado específico o por ID.
Request |
POST |
https://www.bitinka.com/api/apinka/cancel_order |
|
Cancela una o más órdenes y retorna el balance, respuesta en formato XML |
POST |
https://www.bitinka.com/api/apinka/cancel_order/format/json |
|
Cancela una o más órdenes y retorna el balance, respuesta en formato JSON |
Request parameters |
Key |
API Key. |
secret |
Secret. |
pair |
Cancela todas las órdenes del pair |
Request parameters v2 |
Key |
API Key. |
secret |
Secret. |
id |
Cancela todas las órdenes según el id |
Example |
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x"
"pair": "BTC_USD"
}
o
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x",
"id": ["864459:1"]
}
|
Response (JSON) |
balance |
Balance actualizado del usuario |
cancellationDate |
Fecha de cancelación |
coin |
Moneda |
creationDate |
Fecha de creación |
error |
True o False, para errores |
idOrder |
Id de la orden |
investement |
Cantidad |
status |
Estatus |
typeOrder |
Tipo de Orden BUY o SELL |
username |
Username del usuario |
ORDERS USER
Historial de órdenes activas de compra o venta del usuario por tipo de trade.
Request |
POST |
https://www.bitinka.com/api/apinka/orders_user |
|
Retorna historial de ordenes activas del usuario, respuesta en formato XML |
POST |
https://www.bitinka.com/api/apinka/orders_user/format/json |
|
Retorna historial de ordenes activas del usuario, respuesta en formato JSON |
Request parameters |
Key |
API Key. |
secret |
Secret. |
firstCurrency |
Primera moneda del par |
secondCurrency |
Segunda moneda del par |
trade |
Tipo de trade |
|
Los tipos de trade son: (1) Limit,(3) Stop Unitario, (4) Stop Porcentual (%) |
Example |
{
"key": "KMHTBHNQ-DM2BZQ9O-8PZAXMD3-6VQLYGAI-3RBE8Y5L",
"secret": "l8xky697w8itvvw1rnnp3x86pkkyiqj4yhpxoy4k7nd2ia39xrz0p76errcaiweg",
"firstCurrency" : "BTC",
"secondCurrency" : "USD",
"trade": 1
}
|
Response (JSON) |
order_id |
Id de la orden |
fromCurrency |
Primera moneda del par |
toCurrency |
Segunda moneda del par |
Type |
Tipo de Orden BUY o SELL |
Price |
Precio |
Amount |
Cantidad |
Total |
Monto total = Price* Amount |
datetime |
Fecha de creación |
status |
Estatus de la orden |
HISTORIAL DE INTERCAMBIO
Historial de las transacciones completadas del usuario. Puede visualizar las órdenes actuales.
Request |
POST |
https://www.bitinka.com/api/apinka/trade_history |
|
Retorna historial de ordenes completadas del usuario, respuesta en formato XML |
POST |
https://www.bitinka.com/api/apinka/trade_history/format/json |
|
Retorna historial de ordenes completadas del usuario, respuesta en formato JSON |
Request parameters |
Key |
API Key. |
secret |
Secret. |
firstCurrency |
Primera moneda del par |
secondCurrency |
Segunda moneda del par |
Example |
{
"key": "KMHTBHNQ-DM2BZQ9O-8PZAXMD3-6VQLYGAI-3RBE8Y5L",
"secret": "l8xky697w8itvvw1rnnp3x86pkkyiqj4yhpxoy4k7nd2ia39xrz0p76errcaiweg",
"firstCurrency": "BTC",
"secondCurrency": "USD"
}
|
Response (JSON) |
trade_id |
Id de la orden |
fromCurrency |
Primera moneda del par |
toCurrency |
Segunda moneda del par |
Amount |
Cantidad |
Price |
Precio |
Type |
Tipo de Orden BUY o SELL |
Fee |
Monto de Comisión |
Total |
Monto total = Price* Amount |
datetime |
Fecha y hora de creación |
status |
Estatus de la orden |
ORDERS CANCELLED
Historial de las transacciones completadas del usuario. Puede visualizar las órdenes actuales y las anteriores.
Request |
POST |
https://www.bitinka.com/api/apinka/orders_cancelled |
|
Retorna historial de ordenes canceladas del usuario, respuesta en formato XML |
POST |
https://www.bitinka.com/api/apinka/orders_cancelled/format/json |
|
Retorna historial de ordenes canceladas del usuario, respuesta en formato JSON |
Request parameters |
Key |
API Key. |
secret |
Secret. |
trade |
Tipo de trade |
Example |
{
"key": "KMHTBHNQ-DM2BZQ9O-8PZAXMD3-6VQLYGAI-3RBE8Y5L",
"secret": "l8xky697w8itvvw1rnnp3x86pkkyiqj4yhpxoy4k7nd2ia39xrz0p76errcaiweg",
"trade": 1
}
|
Response (JSON) |
order_id |
Id de la orden |
fromCurrency |
Primera moneda del par |
toCurrency |
Segunda moneda del par |
Type |
Tipo de Orden BUY o SELL |
Price |
Precio |
Amount |
Cantidad |
Total |
Monto total = Price* Amount |
status |
Estatus de la orden |
CREATE ORDER BROKER
Realiza una compra o venta instantanea en el broker.
Request |
POST |
https://www.bitinka.com/api/v1/addOrderbroker |
|
Realiza una compra o venta instantanea en el broker, respuesta en formato XML. |
POST |
https://www.bitinka.com/api/v1/addOrderbroker/format/json |
|
Realiza una compra o venta instantanea en el broker, respuesta en formato JSON. |
Request parameters |
Key |
API Key. |
secret |
Secret. |
firstCurrency |
Primera moneda del par |
secondCurrency |
Segunda moneda del par |
amount |
Cantidad |
type |
“Buy” o “Sell” |
Example |
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x",
"new" :
{
"firstCurrency" : "btc",
"secondCurrency" : "usd",
"amount" : "0.0025",
"type" : "buy",
}
}
|
Response (JSON) |
order_id |
Id de la orden |
Price |
Precio |
Total |
Monto total = Price* Amount |