What is the Bitinka API?
It is the Application Programming Interface (API) offered by BitInka to provide a suite of methods by which external applications can be integrated into our platform.
What can I do with the Bitinka API?
With API Bitinka, you can check the volume of supply and demand of different cryptocurrency markets, consult the balance sheet, view the history of orders (Trade History), create or cancel purchase / sale orders in all markets and more.
API has public and private methods, which receive data in JSON format and by default they serve responses in XML format in version 1.0, with utf-8 coding or JSON
How do I start?
Sign in and create the keys to be used as credentials to use API.
To create the, go to "Wallet" > "API Keys". Provide an identifier for each key with which you will generate a key with your unique secret code; that will allow you to access a set of private functions
Example:
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x"
}
PUBLIC DATA FUNCTIONS
MARKETS
Allows visualizing the available markets for the exchange.
| Request |
| GET |
https://www.bitinka.com/api/apinka/markets |
|
Returns the available markets in XML format |
| GET |
https://www.bitinka.com/api/apinka/markets?format=json |
|
Returns the available markets in JSON format |
| Response (JSON) |
| pair |
The available pairs of the market |
|
Example: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
Returns market values in the last hours, the 24H volume of each market, the last offer and the last demand.
| Request |
| GET |
https://www.bitinka.com/api/apinka/ticker |
|
Returns market values for all markets in XML format. |
| GET |
https://www.bitinka.com/api/apinka/ticker?format=json |
|
Returns market values for all markets in JSON format. |
| Response (JSON) |
| volumen24hour |
Volume per market in the last 24 hours |
| Ask |
Lowest sale order |
| Bid |
Highest buy order |
| lastPrice |
Last price of each market |
TICKER BROKER
Returns market values in the last hours, the 24H volume of each market, the last offer and the last demand.
| GET |
https://www.bitinka.com/api/apinka/ticker/broker |
|
Returns market values for all markets in XML format. |
| GET |
https://www.bitinka.com/api/apinka/ticker/broker?format=json |
|
Returns market values for all markets in JSON format. |
| Response (JSON) |
| volumen24hour |
Volume per market in the last 24 hours |
| Ask |
Lowest sale order |
| Bid |
Highest buy order |
| lastPrice |
Last price of each market |
TICKER PER PAIR
Returns values of a specific pair in the last hours, the volume 24H of the market, the last offer and the last demand.
| Request |
| GET |
https://www.bitinka.com/api/apinka/ticker/{currency_pair} |
|
Returns market values for all markets in XML format. |
| GET |
https://www.bitinka.com/api/apinka/ticker/{currency_pair}?format=json |
|
Returns selected market values in JSON format. |
|
Supported values for currency_pair:Example: 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 |
Volume per market in the last 24 hours |
| Ask |
Lowest sale order |
| Bid |
Highest buy order |
| lastPrice |
Last price of each market |
TICKER PER BROKER PAIR
Returns values of a specific pair in the last hours, the volume 24H of the market, the last offer and the last demand.
| Request |
| GET |
https://www.bitinka.com/api/apinka/ticker/broker/{pair} |
|
Returns market values for all markets in XML format. |
| GET |
https://www.bitinka.com/api/apinka/ticker/broker/{pair}/?format=json |
|
Returns selected market values in JSON format. |
| Response (JSON) |
| volumen24hour |
Volume per market in the last 24 hours |
| Ask |
Lowest sale order |
| Bid |
Highest buy order |
| lastPrice |
Last price of each market |
|
Supported values per 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
Obtains all active purchase and sale offers from the market.
| Request |
| GET |
https://www.bitinka.com/api/apinka/order_book/{currency_pair} |
|
Returns purchase and sale orders of the selected market in XML format. |
| GET |
https://www.bitinka.com/api/apinka/order_book/{currency_pair}?format=json |
|
Returns purchase and sale orders of the selected market in JSON format. |
|
Supported values for 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) |
| Returns a JSON dictionary with ’’bids’’ and ’’asks’’. Each is a list of open orders and each order is represented as a list holding the price and the amount. |
Order History
History of completed transactions. You can view the current and previous orders.
| Request |
| GET |
https://www.bitinka.com/api/apinka/order_history/{currency_pair} |
|
Returns history of completed orders, response in XML format. |
| GET |
https://www.bitinka.com/api/apinka/order_history/{currency_pair}?format=json |
|
Returns history of completed orders, response in JSON format. |
|
Supported values for 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 |
Quantity |
| Price |
Price |
| Type |
Type of order BUY or SELL |
| Fee |
Fee amount |
| Total |
Total Amount = Price* Amount |
| datetime |
Date and time of creation |
PRIVATE FUNCTIONS
GET TRADE BALANCE
Obtains balance of the Bitinka Wallet in all the currencies available to the user.
| Request |
| POST |
https://www.bitinka.com/api/apinka/get_balance |
|
Returns the available balance of the Bitinka Wallet in each currency in XML format. |
| POST |
https://www.bitinka.com/api/apinka/get_balance/format/json |
|
Returns the available balance of the Bitinka Wallet in each currency in JSON format. |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| Example |
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x"
}
|
| Response (JSON) |
| coin |
Currency |
| balance |
Available balance of the Bitinka Wallet |
GET BALANCE
Obtains balance of the TOP-UP Wallet in all the currencies available to the user.
| Request |
| POST |
https://www.bitinka.com/api/apinka/get_wallet_balance |
|
Returns the available balance of the TOP-UP Wallet in each currency in XML format. |
| POST |
https://www.bitinka.com/api/apinka/get_wallet_balance/format/json |
|
Returns the available balance of the TOP-UP Wallet in each currency in JSON format. |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| Example |
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x"
}
|
| Response (JSON) |
| coin |
Currency |
| balance |
Available balance of the TOP-UP Wallet |
CREATE ORDER
Create a purchase or sale offer in a specific market.
| Request |
| POST |
https://www.bitinka.com/api/apinka/create_order |
|
Create a purchase or sale order according to the type of trade, response in XML format |
| POST |
https://www.bitinka.com/api/apinka/create_order/format/json |
|
Create a purchase or sale order according to the type of trade, response in JSON format |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| typeOrder |
“Buy” or “Sell” |
| price |
Price |
| investement |
Quantity |
| firstCurrency |
First currency of the pair |
| secondCurrency |
Second currency of the pair |
| trade |
Type of trade, in which you want to create the order. |
|
The types of trade are: (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 |
Quantity |
| balanceUser |
Balance available to the user for trading |
| date |
Date |
| error |
True or False, for errors |
| firstCurrency |
First currency of the pair |
| idOrder |
Order ID |
| method |
Creation method |
| price |
Price |
| priceMarket |
Price of the current market |
| secondCurrency |
Second currency of the pair |
| status |
Order status |
| total |
Total Amount = Price* Amount |
| typeOrder |
Type of order BUY or SELL |
| typeTrading |
Type of trade |
| username |
Username of the user in the system |
CREATE ORDER STOP
Create a purchase or sale offer in a specific market.
| Request |
| POST |
https://www.bitinka.com/api/apinka/create_order/stop |
|
Create a purchase or sale order according to the type of trade, response in XML format |
| POST |
https://www.bitinka.com/api/apinka/create_order/stop/format/json |
|
Create a purchase or sale order according to the type of trade, response in XML format |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| typeOrder |
“Buy” or “Sell” |
| priceLimit |
Precio en el que se creará la orden |
| priceStop |
Precio en el que se dispara la orden |
| investement |
Quantity |
| firstCurrency |
First currency of the pair |
| secondCurrency |
Second currency of the pair |
| trade |
Type of trade, in which you want to create the order. |
| percentage |
Porcentaje |
|
Type of 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 |
Quantity |
| balanceUser |
Balance available to the user for trading |
| date |
Date |
| error |
True or False, for errors |
| firstCurrency |
First currency of the pair |
| idOrder |
Order ID |
| method |
Creation method |
| price |
Price |
| priceMarket |
Price of the current market |
| secondCurrency |
Second currency of the pair |
| status |
Order status |
| total |
Total Amount = Price* Amount |
| typeOrder |
Type of order BUY or SELL |
| typeTrading |
Type of trade |
| username |
Username of the user in the system |
ADD ORDER BROKER
Make a purchase or sale in a specific market, instantly.
| Request |
| POST |
https://www.bitinka.com/api/apinka/addOrderbroker |
|
Make an instant purchase or sale, response in XML format. |
| POST |
https://www.bitinka.com/api/apinka/addOrderbroker/format/json |
|
Make an instant purchase or sale, response in JSON format. |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| firstCurrency |
First currency of the pair |
| secondCurrency |
Second currency of the pair |
| amount |
Quantity |
| type |
“Buy” or “Sell” |
| Example |
{
"key": JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC ,
"secret": 3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x ,
new :
{
"firstCurrency" : "BTC",
"secondCurrency" : "USD",
"amount" : "0.00670987",
"type" : "sell"
}
}
|
| Response (JSON) |
| return |
Response for the petition |
| status |
Order status |
| order_id |
Order ID |
| price |
Price |
CANCEL ORDER
Cancel a purchase or sale order in a specific market or by ID.
| Request |
| POST |
https://www.bitinka.com/api/apinka/cancel_order |
|
Cancel one or more orders and return the balance, response in XML format. |
| POST |
https://www.bitinka.com/api/apinka/cancel_order/format/json |
|
Cancel one or more orders and return the balance, response in JSON format. |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| pair |
Cancel all orders of the pair. |
| Request parameters v2 |
| Key |
API Key. |
| secret |
Secret. |
| id |
Cancel all orders according to 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 |
User's updated balance |
| cancellationDate |
Cancellation date |
| coin |
Currency |
| creationDate |
Creation date |
| error |
True or False, for errors |
| idOrder |
Order ID |
| investement |
Quantity |
| status |
Estatus |
| typeOrder |
Type of order BUY or SELL |
| username |
Username del usuario |
ORDERS USER
History of active orders of purchase or sale of the user by type of trade.
| Request |
| POST |
https://www.bitinka.com/api/apinka/orders_user |
|
Returns the history of active orders of the user, response in XML format. |
| POST |
https://www.bitinka.com/api/apinka/orders_user/format/json |
|
Returns the history of active orders of the user, response in JSON format. |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| firstCurrency |
First currency of the pair |
| secondCurrency |
Second currency of the pair |
| trade |
Type of trade |
|
The types of trade are: (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 |
Order ID |
| fromCurrency |
First currency of the pair |
| toCurrency |
Second currency of the pair |
| Type |
Type of order BUY or SELL |
| Price |
Price |
| Amount |
Quantity |
| Total |
Total Amount = Price* Amount |
| datetime |
Creation date |
| status |
Order status |
TRADE HISTORY
History of completed transactions of the user. You can view the current and previous orders.
| Request |
| POST |
https://www.bitinka.com/api/apinka/trade_history |
|
Returns history of completed orders of the user, response in XML format. |
| POST |
https://www.bitinka.com/api/apinka/trade_history/format/json |
|
Returns history of completed orders of the user, response in JSON format. |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| firstCurrency |
First currency of the pair |
| secondCurrency |
Second currency of the pair |
| Example |
{
"key": "KMHTBHNQ-DM2BZQ9O-8PZAXMD3-6VQLYGAI-3RBE8Y5L",
"secret": "l8xky697w8itvvw1rnnp3x86pkkyiqj4yhpxoy4k7nd2ia39xrz0p76errcaiweg",
"firstCurrency": "BTC",
"secondCurrency": "USD"
}
|
| Response (JSON) |
| trade_id |
Order ID |
| fromCurrency |
First currency of the pair |
| toCurrency |
Second currency of the pair |
| Amount |
Quantity |
| Price |
Price |
| Type |
Type of order BUY or SELL |
| Fee |
Fee amount |
| Total |
Total Amount = Price* Amount |
| datetime |
Date and time of creation |
| status |
Order status |
ORDERS CANCELLED
History of completed transactions of the user. You can view the current and previous orders.
| Request |
| POST |
https://www.bitinka.com/api/apinka/orders_cancelled |
|
Returns history of canceled orders of the user, response in XML format. |
| POST |
https://www.bitinka.com/api/apinka/orders_cancelled/format/json |
|
Returns history of canceled orders of the user, response in JSON format. |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| trade |
Type of trade |
| Example |
{
"key": "KMHTBHNQ-DM2BZQ9O-8PZAXMD3-6VQLYGAI-3RBE8Y5L",
"secret": "l8xky697w8itvvw1rnnp3x86pkkyiqj4yhpxoy4k7nd2ia39xrz0p76errcaiweg",
"trade": 1
}
|
| Response (JSON) |
| order_id |
Order ID |
| fromCurrency |
First currency of the pair |
| toCurrency |
Second currency of the pair |
| Type |
Type of order BUY or SELL |
| Price |
Price |
| Amount |
Quantity |
| Total |
Total Amount = Price* Amount |
| status |
Order status |
CREATE ORDER BROKER
Create a instant purchase or sale in the broker.
| Request |
| POST |
https://www.bitinka.com/api/v1/addOrderbroker |
|
Create a instant purchase or sale in the broker, response in XML format. |
| POST |
https://www.bitinka.com/api/v1/addOrderbroker/format/json |
|
Create a instant purchase or sale in the broker, response in JSON format. |
| Request parameters |
| Key |
API Key. |
| secret |
Secret. |
| firstCurrency |
First currency of the pair |
| secondCurrency |
Second currency of the pair |
| amount |
Quantity |
| type |
“Buy” or “Sell” |
| Example |
{
"key": "JU5DC6KD-7QSP8KYQ-BM0TKL3D-LZTRVFSE-9YSM5DZC",
"secret": "3r1cc02nm3h7pkkaje2ftvu2tnpy0pb3hdgtdjh0my7birm25ohzjc2czrbzgn3x",
"new" :
{
"firstCurrency" : "btc",
"secondCurrency" : "usd",
"amount" : "0.0025",
"type" : "buy",
}
}
|
| Response (JSON) |
| order_id |
Order ID |
| Price |
Price |
| Total |
Total Amount = Price* Amount |