This project is designed to assist you make your own projects that interact with the Bitbns API. This project seeks to have complete API coverage excluding WebSockets which would be released in the future version.
Project description
Bitbns Python API
This project is designed to assist you make your own projects that interact with the Bitbns API. This project seeks to have complete API coverage excluding WebSockets which would be released in the future version.
Use Python 3.7+
Installation
pip3 install bitbns
API Access
PERMISSIONS | Read | Write |
---|---|---|
List Open Orders | ✓ | ✖ |
List Open Stop Limit | ✓ | ✖ |
Api Usages Status | ✓ | ✖ |
Current Coin Balance | ✓ | ✖ |
Deposit History | ✓ | ✖ |
Withdrawal History | ✓ | ✖ |
Order Status | ✓ | ✖ |
Buy Stop Loss Order | ✖ | ✓ |
Sell Stop Loss Order | ✖ | ✓ |
Buy Order | ✖ | ✓ |
Sell Order | ✖ | ✓ |
Get Coin Address | ✓ | ✖ |
Cancel Order | ✖ | ✓ |
Cancel Stop Loss Order | ✖ | ✓ |
Platform Status | ✓ | ✖ |
Ticker API | ✓ | ✖ |
Buy OrderBook | ✓ | ✖ |
Sell OrderBook | ✓ | ✖ |
Minimum Volume allowed of supporting currencies
COIN NAME | SYMBOL | MINIMUM VOLUME ALLOWED | MAXIMUM VOLUME ALLOWED |
---|---|---|---|
Bitcoin | BTC | 0.001 | 20 |
Ripple | XRP | 50 | 500000 |
Neo | NEO | 4 | 10000 |
Gas | GAS | 13 | 10000 |
Stellar | XLM | 300 | 500000 |
Ethereum | ETH | 0.32 | 20 |
Bitcoin Cash | BCH | 0.15 | 200 |
Tron | TRX | 2800 | 200000 |
Cardano | ADA | 880 | 2000000 |
VeChain | VET | 5800 | 20000 |
Verge | XVG | 4550 | 2000000 |
Dash | DASH | 0.42 | 200 |
DigixDAO | DGD | 1.5 | 200 |
LiteCoin | LTC | 1.2 | 150 |
Augur | REP | 6 | 500 |
Qtum | QTUM | 17 | 1000 |
Lisk | LSK | 24 | 1000 |
OmiseGo | OMG | 21 | 1000 |
Waves | WAVES | 34 | 1000 |
Ontology | ONT | 35 | 1000 |
0x | ZRX | 10 | 3000 |
Power Ledger | POWR | 400 | 8000 |
PolyMath | POLY | 324 | 10000 |
Tether | USDT | 5 | 5000 |
Sia | SC | 10000 | 1000000 |
NEM | XEM | 564 | 5000000 |
DeepBrain Chain | DBC | 9400 | 500000 |
MONERO | XMR | 0.7 | 200 |
DogeCoin | DOGE | 18000 | 1000000 |
Electroneum | ETN | 4000 | 200000 |
EOS | EOS | 15 | 200000 |
Zilica | ZIL | 2000 | 200000 |
Digibyte | DGB | 3000 | 2000000 |
ICON | ICX | 105 | 20000 |
Request | REQ | 1500 | 200000 |
QLC Chain | QLC | 1500 | 2000000 |
Wan Chain | WAN | 70 | 2000000 |
Achain | ACT | 2500 | 2000000 |
Bluzelle | BLZ | 500 | 200000 |
Substratum | SUB | 600 | 200000 |
Loopring | LRC | 600 | 200000 |
Nexo | NEXO | 450 | 200000 |
Effect.Ai | EFX | 5000 | 200000 |
Apex | CPX | 2500 | 200000 |
LOOM Network | LOOM | 500 | 200000 |
eosDAC | EOSDAC | 1600 | 200000 |
Storm | STORM | 8000 | 200000 |
Golem | GNT | 400 | 200000 |
PundiX | NPXS | 40000 | 2000000 |
Ethereum Classic | ETC | 10 | 200000 |
DENT | DENT | 30 | 200000 |
CloakCoin | CLOAK | 25 | 200000 |
Komodo | KMD | 55 | 200000 |
GroestlCoin | GRS | 150 | 200000 |
LinkEye | LET | 10000 | 200000 |
Phantasma | SOUL | 600 | 200000 |
Getting Started
from bitbns import bitbnsApi apiKey = 'API-KEY' apiSecretKey = 'API-SECRET-KEY'bitbnsObj = bitbnsApi(apiKey, apiSecretKey)
Getting Platform Status
bitbnsObj.platformStatus();
View Response
{ data: { BTC: { status: 1 }, ETH: { status: 1 }, XRP: { status: 1 } }, status: 1, error: null }Explanation of fields: status -> whether the coin is live on platform
bitbnsObj.getTickerApi('BTC')
View Response
{ "data": { "BTC": { "highest_buy_bid": 484159.43, "lowest_sell_bid": 494800, "last_traded_price": 494805.29 } }, "status": 1, "error": null }Explanation of fields: highest_buy_bid -> top entry of buy order book lowest_sell_bid -> top entry of sell order book last_traded_price -> price at which the last trade had happened
Getting latest price of few symbol
bitbnsObj.getTickerApi('BTC,ETH')
View Response
{ "data": { "BTC": { "highest_buy_bid": 484159.43, "lowest_sell_bid": 494800, "last_traded_price": 494805.29 }, "ETH": { "highest_buy_bid": 13205.01, "lowest_sell_bid": 13440, "last_traded_price": 13450 } }, "status": 1, "error": null }
Getting latest price of all symbol
bitbnsObj.getTickerApi('')
View Response
{ "data": { "BTC": { "highest_buy_bid": 480059.8, "lowest_sell_bid": 489000, "last_traded_price": 480059.8 }, "XRP": { "highest_buy_bid": 20, "lowest_sell_bid": 20.16, "last_traded_price": 20.16 }, "NEO": { "highest_buy_bid": 1301, "lowest_sell_bid": 1349.99, "last_traded_price": 1331.92 }, "GAS": { "highest_buy_bid": 406.96, "lowest_sell_bid": 418.46, "last_traded_price": 418.46 }, "ETH": { "highest_buy_bid": 13350, "lowest_sell_bid": 13660.5, "last_traded_price": 13350 }, "XLM": { "highest_buy_bid": 14.75, "lowest_sell_bid": 14.77, "last_traded_price": 14.77 }, "RPX": { "highest_buy_bid": 0.77, "lowest_sell_bid": 0.82, "last_traded_price": 0.8 }, "DBC": { "highest_buy_bid": 0.73, "lowest_sell_bid": 0.77, "last_traded_price": 0.72 }, "LTC": { "highest_buy_bid": 3680, "lowest_sell_bid": 3800, "last_traded_price": 3800 }, "XMR": { "highest_buy_bid": 7555, "lowest_sell_bid": 8000, "last_traded_price": 7600 }, "DASH": { "highest_buy_bid": 13500, "lowest_sell_bid": 14500, "last_traded_price": 13500 }, "DOGE": { "highest_buy_bid": 0.47, "lowest_sell_bid": 0.49, "last_traded_price": 0.49 }, "BCH": { "highest_buy_bid": 33600, "lowest_sell_bid": 34997, "last_traded_price": 34998 }, "SC": { "highest_buy_bid": 0.38, "lowest_sell_bid": 0.42, "last_traded_price": 0.42 }, "TRX": { "highest_buy_bid": 1.35, "lowest_sell_bid": 1.36, "last_traded_price": 1.35 }, "ETN": { "highest_buy_bid": 0.38, "lowest_sell_bid": 0.39, "last_traded_price": 0.39 }, "ONT": { "highest_buy_bid": 126.01, "lowest_sell_bid": 136.1, "last_traded_price": 136.82 }, "ZIL": { "highest_buy_bid": 2.37, "lowest_sell_bid": 2.5, "last_traded_price": 2.51 }, "EOS": { "highest_buy_bid": 365.51, "lowest_sell_bid": 375.1, "last_traded_price": 385 }, "POLY": { "highest_buy_bid": 10.01, "lowest_sell_bid": 10.04, "last_traded_price": 10.04 }, "DGB": { "highest_buy_bid": 1.6, "lowest_sell_bid": 1.83, "last_traded_price": 1.82 }, "NCASH": { "highest_buy_bid": 0.35, "lowest_sell_bid": 0.36, "last_traded_price": 0.36 }, "ADA": { "highest_buy_bid": 4.97, "lowest_sell_bid": 5.09, "last_traded_price": 4.92 }, "ICX": { "highest_buy_bid": 40.01, "lowest_sell_bid": 45.5, "last_traded_price": 40.25 }, "VEN": { "highest_buy_bid": 0.96, "lowest_sell_bid": 1.15, "last_traded_price": 1.15 }, "OMG": { "highest_buy_bid": 239.72, "lowest_sell_bid": 267.71, "last_traded_price": 267.71 }, "REQ": { "highest_buy_bid": 2.22, "lowest_sell_bid": 2.39, "last_traded_price": 2.3 }, "DGD": { "highest_buy_bid": 2385, "lowest_sell_bid": 3000, "last_traded_price": 2385 }, "QLC": { "highest_buy_bid": 3.3, "lowest_sell_bid": 3.96, "last_traded_price": 3.4 }, "POWR": { "highest_buy_bid": 10.02, "lowest_sell_bid": 11.4, "last_traded_price": 10.01 }, "WPR": { "highest_buy_bid": 1.18, "lowest_sell_bid": 1.25, "last_traded_price": 1.17 }, "WAVES": { "highest_buy_bid": 150.1, "lowest_sell_bid": 179, "last_traded_price": 150 }, "WAN": { "highest_buy_bid": 58.51, "lowest_sell_bid": 69.9, "last_traded_price": 53.55 }, "ACT": { "highest_buy_bid": 2.21, "lowest_sell_bid": 2.68, "last_traded_price": 2.21 }, "XEM": { "highest_buy_bid": 5.7, "lowest_sell_bid": 7.51, "last_traded_price": 10 }, "XVG": { "highest_buy_bid": 0.89, "lowest_sell_bid": 0.92, "last_traded_price": 0.88 }, "BLZ": { "highest_buy_bid": 7.61, "lowest_sell_bid": 7.8, "last_traded_price": 7.8 }, "SUB": { "highest_buy_bid": 7.06, "lowest_sell_bid": 8.5, "last_traded_price": 7.45 }, "LRC": { "highest_buy_bid": 6.5, "lowest_sell_bid": 9.95, "last_traded_price": 6.7 }, "NEXO": { "highest_buy_bid": 3.91, "lowest_sell_bid": 4.19, "last_traded_price": 3.91 }, "EFX": { "highest_buy_bid": 0.69, "lowest_sell_bid": 0.9, "last_traded_price": 0.7 }, "CPX": { "highest_buy_bid": 1.05, "lowest_sell_bid": 1.27, "last_traded_price": 1.05 }, "ZRX": { "highest_buy_bid": 38.09, "lowest_sell_bid": 39.49, "last_traded_price": 37.77 }, "REP": { "highest_buy_bid": 1050, "lowest_sell_bid": 1200, "last_traded_price": 1025 }, "LOOM": { "highest_buy_bid": 5.06, "lowest_sell_bid": 6.7, "last_traded_price": 6.7 }, "EOSD": { "highest_buy_bid": 3.51, "lowest_sell_bid": 3.88, "last_traded_price": 3.51 }, "STORM": { "highest_buy_bid": 0.47, "lowest_sell_bid": 0.5, "last_traded_price": 0.48 }, "GNT": { "highest_buy_bid": 9.25, "lowest_sell_bid": 9.26, "last_traded_price": 9.26 }, "QTUM": { "highest_buy_bid": 235, "lowest_sell_bid": 288.97, "last_traded_price": 247.69 }, "QKC": { "highest_buy_bid": 1.86, "lowest_sell_bid": 2.34, "last_traded_price": 1.76 }, "LSK": { "highest_buy_bid": 230, "lowest_sell_bid": 286, "last_traded_price": 230 }, "NPXS": { "highest_buy_bid": 0.11, "lowest_sell_bid": 0.12, "last_traded_price": 0.11 }, "USDT": { "highest_buy_bid": 74.12, "lowest_sell_bid": 77, "last_traded_price": 74.11 }, "ETC": { "highest_buy_bid": 804.02, "lowest_sell_bid": 850, "last_traded_price": 804 }, "DENT": { "highest_buy_bid": 0.15, "lowest_sell_bid": 0.17, "last_traded_price": 0.17 }, "CLOAK": { "highest_buy_bid": 120.51, "lowest_sell_bid": 159.92, "last_traded_price": 135 }, "KMD": { "highest_buy_bid": 70, "lowest_sell_bid": 77, "last_traded_price": 77.6 }, "GRS": { "highest_buy_bid": 35, "lowest_sell_bid": 39.4, "last_traded_price": 38.4 }, "RAM": { "highest_buy_bid": 0.38, "lowest_sell_bid": 0.4, "last_traded_price": 0.38 }, "LET": { "highest_buy_bid": 0.64, "lowest_sell_bid": 0.68, "last_traded_price": 0.68 }, "SOUL": { "highest_buy_bid": 2.26, "lowest_sell_bid": 2.71, "last_traded_price": 2.7 }, "PHX": { "highest_buy_bid": 0.77, "lowest_sell_bid": 0.82, "last_traded_price": 0.8 }, "VET": { "highest_buy_bid": 0.96, "lowest_sell_bid": 1.15, "last_traded_price": 1.15 }, "TST": { "highest_buy_bid": 23, "lowest_sell_bid": 27.5, "last_traded_price": 25 } }, "status": 1, "error": null }
Getting current balance of crypto asset
Inputing "INR" in place of crypto asset would list your inr balance .
bitbnsObj.currentCoinBalance('BTC')
View Response
{ "data": { "inorderBTC": 8.34, "availableorderBTC": 15.76 }, "status": 1, "error": null }Explanation of fields: inorderBTC -> volume which is the order book availableorderBTC -> volume which is present in wallet
Get Deposit History
bitbnsObj.depositHistory('BTC', 0)
View Response
{ data: [ { type: 'BTC deposited', typeI: 1, amount: 0.00159302, date: '2018-08-21T14:35:02.000Z', unit: 'BTC', factor: 100000000, fee: 0, delh_btc: 0, delh_inr: 0, rate: 0, del_btc: 159302, del_inr: 0 }, { type: 'BTC deposited', typeI: 1, amount: 0.00142951, date: '2018-08-21T14:35:02.000Z', unit: 'BTC', factor: 100000000, fee: 0, delh_btc: 0, delh_inr: 0, rate: 0, del_btc: 142951, del_inr: 0 } ], status: 1, error: null }Explanation of fields: type -> type of action typeI -> action id amount -> the amount deposited date -> the time at which this event occured unit -> the symbol name of coin factor -> the division factor del_btc -> delta changes in normal wallet of coin del_inr -> delta changes in normal inr wallet delh_btc -> delta changes in hold wallet of coin
Get Withdrawal History
bitbnsObj.withdrawHistory('XRP', 0)
View Response
{ data: [ { type: 0, amount: 1.1, unit: 'XRP', hash: '42DAD88011C178DCAA1587ABA4458F4D535B30248650A6C353E5E2527', fee: 0.1, to: 'rB1za2ZVgqvrNB7u8LbVN61k5n1ByBUtXCA', status: '-1', canSendMail: 0, cancelable: -1, refer: 5339918, expTime: 'XRP withdraw done' }, { type: 0, amount: 100, unit: 'XRP', hash: '12520219872260A25457E4D03C8F82F696A23EEA558B693B90FF080C5', fee: 0.1, to: 'rLdBnLq5C13ood9wdjY9ZCdgycK8KGevkUj', status: '-1', canSendMail: 0, cancelable: -1, refer: 6531933, expTime: 'XRP withdraw done' } ], status: 1, error: null }
List Open Orders
bitbnsObj.listOpenOrders('BTC')
View Response
{ "data": [ { "entry_id": 322, "btc": 48, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 323, "btc": 100, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 324, "btc": 100, "r ate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 325, "btc": 100, "rate": 25, "time": "2018-0 9-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 326, "btc": 100, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "t ype": 1, "status": 0 }, { "entry_id": 327, "btc": 100, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "e ntry_id": 328, "btc": 100, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 329, "btc": 100, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 330, "btc": 100, "rate": 25, "time": "201 8-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 331, "btc": 100, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 332, "btc": 100, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 333, "btc": 100, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 334, "btc": 100, "rate": 25, "time": "2018-09-10T12:29:52.000Z", "type": 1, "status": 0 }, { "entry_id": 337, "btc": 100, "rate": 25, "time": " 2018-09-10T12:45:51.000Z", "type": 1, "status": 0 }, { "entry_id": 338, "btc": 100, "rate": 25, "time": "2018-09-10T12:46:01.00 0Z", "type": 1, "status": 0 } ], "status": 1, "error": null }Explanation of fields: entry_id -> the unique id assigned to the order btc -> the volume of the coin rate -> the rate at which the order was placed time -> the timestamp at which the order was placed type -> 1 for sell and 0 for buy order status -> -1 for cancelled , 0 for not processed , 1 for partially executed, 2 for fully executed
List Open Stop Loss Orders
bitbnsObj.listOpenStopOrders('TST')
View Response
{ data: [ { entry_id: 28816, btc: 40, rate: 25, t_rate: 24.5, type: 1, status: 0 } ], status: 1, error: null }Explanation of fields: entry_id -> the unique id assigned to the order btc -> the volume of the coin rate -> the rate at which the order was placed t_rate -> the trigger rate at which the order was placed time -> the timestamp at which the order was placed type -> 1 for sell and 0 for buy order status -> -1 for cancelled , 0 for not processed , 1 for partially executed, 2 for fully executed
Get Specify Crypto Coin Address
Coins Without Tag bitbnsObj.getCoinAddress('BTC')
View Response
{ "data": { "token": "3QkuWRDRNcjtMQNneoqFV7hpxQPWW6pupK", "expiry": "2018-09-12 13:04:09" }, "status": 1, "error": null }Explanation of fields: token -> the token address expiry -> the time till which this address is user's valid address
Coins With Tag bitbnsObj.getCoinAddress('XLM')
View Response
{ "data": { "token": "GAVQNY45FBHSN5MEPLAF56U7VDCBDG54TQFGJSS2CRPZTWD3CSHP4YPU", "tag": "123151" }, "status": 1, "error": null }Explanation of fields: token -> the token address tag -> the tag to be used for the token Deposits would not be valid unless you specify the tag
Place Sell Order
bitbnsObj.placeSellOrder('XRP', 200, 25) 200 -> Quantity 25 -> Rate
View Response
{ "data": "Successfully placed bid to sell at specified price", "status": 1, "error": null, "id": 489 }Explanation of fields: data -> Just a custom message id -> the unique id of the order
Place Buy Order
bitbnsObj.placeBuyOrder('XRP', 200, 25) 200 -> Quantity 25 -> Rate
View Response
{ "data": "Successfully placed bid to purchase currency", "status": 1, "error": null, "id": 490 }Explanation of fields: data -> Just a custom message id -> the unique id of the order
bitbnsObj.buyStopLoss('XRP', 40, 24, 24.5)40 -> Quantity 24 -> Rate 24.5 -> Trigger rate
View Response
{ "data": "Successfully placed order for stop loss buy", "status": 1, "error": null, "id": 28595 }Explanation of fields: data -> Just a custom message id -> the unique id of the order
Placing a STOP LOSS order (SELL)
bitbnsObj.sellStopLoss('XRP', 40, 25, 24.5) 40 -> Quantity 24 -> Rate 24.5 -> Trigger rate
View Response
{ "data": "Successfully placed a stop limit sell order", "status": 1, "error": null, "id": 28596 }Explanation of fields: data -> Just a custom message id -> the unique id of the order
Place Cancel Order
bitbnsObj.cancelOrder('XRP', 174) Here 174 is a order id
View Response
{ "data": "Successfully cancelled the order", "status": 1, "error": null }Explanation of fields: data -> just a custom message status -> status of cancellation 1 for success
Getting Sell Order Book for BTC
bitbnsObj.getSellOrderBook('BTC')
View Response
{ data: [ { rate: 481847.56, btc: 6352679 }, { rate: 481700, btc: 5540000 }, { rate: 481551, btc: 5000000 }, { rate: 481000, btc: 11406 }, { rate: 480000, btc: 208021 }, { rate: 479366.65, btc: 5265026 }, { rate: 479345, btc: 453445 }, { rate: 478854.18, btc: 642042 }, { rate: 478749.87, btc: 208356 }, { rate: 478511.87, btc: 2446067 }, { rate: 478000, btc: 80253706 }, { rate: 477900, btc: 6261808 }, { rate: 477777, btc: 208900000 }, { rate: 477740, btc: 15000000 }, { rate: 477706.19, btc: 5003424 } ], status: 1, error: null }Explanation of fields: rate -> the amount of the order btc -> the volume of the coin for that order
Getting Sell Order Book for BTCUSDT
bitbnsObj.getSellOrderBook('BTCUSDT')
View Response
{ data: [ { rate: 481847.56, btc: 6352679 }, { rate: 481700, btc: 5540000 }, { rate: 481551, btc: 5000000 }, { rate: 481000, btc: 11406 }, { rate: 480000, btc: 208021 }, { rate: 479366.65, btc: 5265026 }, { rate: 479345, btc: 453445 }, { rate: 478854.18, btc: 642042 }, { rate: 478749.87, btc: 208356 }, { rate: 478511.87, btc: 2446067 }, { rate: 478000, btc: 80253706 }, { rate: 477900, btc: 6261808 }, { rate: 477777, btc: 208900000 }, { rate: 477740, btc: 15000000 }, { rate: 477706.19, btc: 5003424 } ], status: 1, error: null }Explanation of fields: rate -> the amount of the order btc -> the volume of the coin for that order
Getting Buy Order Book for BTC
bitbnsObj.getBuyOrderBook('BTC')
View Response
{ data: [ { rate: 481847.56, btc: 6352679 }, { rate: 481700, btc: 5540000 }, { rate: 481551, btc: 5000000 }, { rate: 481000, btc: 11406 }, { rate: 480000, btc: 208021 }, { rate: 479366.65, btc: 5265026 }, { rate: 479345, btc: 453445 },{ rate: 478854.18, btc: 642042 }, { rate: 478749.87, btc: 208356 }, { rate: 478511.87, btc: 2446067 }, { rate: 478000, btc: 80253706 }, { rate: 477900, btc: 6261808 }, { rate: 477777, btc: 208900000 }, { rate: 477740, btc: 15000000 }, { rate: 477706.19, btc: 5003424 } ],
status: 1, error: null }
Explanation of fields: rate -> the amount of the order btc -> the volume of the coin for that order
Getting Buy Order Book for BTCUSDT
bitbnsObj.getBuyOrderBook('BTCUSDT')
View Response
{ data: [ { rate: 481847.56, btc: 6352679 }, { rate: 481700, btc: 5540000 }, { rate: 481551, btc: 5000000 }, { rate: 481000, btc: 11406 }, { rate: 480000, btc: 208021 }, { rate: 479366.65, btc: 5265026 }, { rate: 479345, btc: 453445 },{ rate: 478854.18, btc: 642042 }, { rate: 478749.87, btc: 208356 }, { rate: 478511.87, btc: 2446067 }, { rate: 478000, btc: 80253706 }, { rate: 477900, btc: 6261808 }, { rate: 477777, btc: 208900000 }, { rate: 477740, btc: 15000000 }, { rate: 477706.19, btc: 5003424 } ],
status: 1, error: null }
Explanation of fields: rate -> the amount of the order btc -> the volume of the coin for that order
Get API usage Status
bitbnsObj.getApiUsageStatus()
View Response
{ data: { readLimt : 100, writeLimit : 30, readRateUsed: 0, writeRateUsed: 1, status: 1 }, status: 1, error: null }Explanation of the fields: readLimit -> the read limit of the user writeLimit -> the write limit of the user readRateUsed -> the read requests used writeRateUsed -> the write requests used
Getting Order Status
bitbnsObj.orderStatus('BTC', '4221') 4221 -> order id
View Response
{ data: [ { entry_id: 4221, btc: 0.001, rate: 306929.01, time: '2018-09-20T13:54:21.000Z', type: 0, status: 0 } ], status: 1, error: null }Explanation of fields: entry_id -> the unique id for the order btc -> the volume of the currency placed rate -> the rate at which the order is placed time -> the timestamp of the entry type -> 0 for buy and 1 for sell status -> -1 for cancelled, 0 for not processed, 1 for partially executed, 2 for fully executed
Cancel Stop Loss Order
bitbnsObj.cancelStopLossOrder('BTC', 4221) 4221 -> order id
View Response
{ data: 'Successfully cancelled the order', status: 1, error: null }Explanation of fields: data -> the custom message status -> for successful request the status is 1
Curl request to get server time
curl -H "X-BITBNS-APIKEY: API-KEY" -X GET 'https://api.bitbns.com/api/trade/v1/getServerTime'
View Response
{ serverTime: '1538150764273', status: 1, error: null }Explanation of fields: serverTime -> the server timestamp status -> the response succeeded
API V2 (New Features)
Place Orders(BUY or SELL)(Placing Bracket Order)bitbnsObj.placeOrders({'symbol': 'XRP', 'side': 'BUY', 'quantity': 40, 'rate': 4, 'target_rate': 5, 't_rate': 3.5, 'trail_rate': .01})
side -> BUY or SELL symbol -> COIN NAME, quantity -> QUANTITY, rate -> RATE, target_rate -> TARGET RATE, t_rate -> TRRIGER RATE, trail_rate -> TRAIL RATE
To Place Simple Buy or Sell Order use rate To Place Stoploss Buy or Sell Order use rate & t_rate To Place Bracket Buy or Sell Order use rate , t_rate, target_rate & trail_rate
Cancel Order
bitbnsObj.cancelOrders({'symbol': 'XRP', 'side' : 'cancelOrder', 'entry_id': 462}) side -> "cancelOrder","cancelStopLossOrder", "usdtcancelOrder", "usdtcancelStopLossOrder" symbol -> COIN NAME entry_id : ENTRY ID
Place Orders in USDT Market
bitbnsObj.placeOrders({'symbol': 'TRX_USDT', 'side': 'BUY', 'quantity': 40, 'rate': 4, 'target_rate': 5, 't_rate': 3.5, 'trail_rate': .01}) side -> BUY or SELL symbol -> COIN NAME(use suffix "_USDT" with coin name) quantity -> QUANTITY, rate -> RATE, target_rate -> TARGET RATE, t_rate -> TRRIGER RATE, trail_rate -> TRAIL RATE To Place Simple Buy or Sell Order use rate To Place Stoploss Buy or Sell Order use rate & t_rate To Place Bracket Buy or Sell Order use rate , t_rate, target_rate & trail_rate
Cancel Order in USDT MARKET
bitbnsObj.cancelOrders({'symbol': 'TRX_USDT', 'side' : 'usdtcancelOrder', 'entry_id': 462}) side -> "cancelOrder","cancelStopLossOrder", "usdtcancelOrder", "usdtcancelStopLossOrder" symbol -> COIN NAME(use suffix "_USDT" with coin name) entry_id : ENTRY ID
Get Orders in USDT MARKET
bitbnsObj.getOrders({'side' : 'usdtListOpenOrders', 'symbol' : 'TRX_USDT', 'page' : 0}) side -> "listOpenOrders", "listOpenStopOrders", "listOpenBracketOrders", "usdtListOpenBracketOrders", "usdtListOpenStopOrders","usdtListOpenOrders" symbol -> COIN NAME(use suffix "_USDT" with coin name) page -> INTEGER
Get Token to authenticate Orders socket
bitbnsObj.getTokenSocket()
Use socket to get live order book
bitbnsObj.getOrderBookSocket('BTC', 'INR')
Margin Trading V2 APIs
Place a margin order bitbnsObj.placeMarginOrders({'symbol': 'USDT', 'side': 'placeOrder', 'type': 'LEND', 'qnty': 40, 'days': 1, 'rate': 0.0055}) side -> placeOrder type -> BORROW or LEND days -> 1,3,7,15,30 renew -> 0,1,2 symbol -> COIN NAME, qnty -> QUANTITY, rate -> RATE Renew Flags => 0 - Don't renew, 1 -> Renew only Principal, 2 -> Renew with Principal + Interest
Cancel a margin order bitbnsObj.cancelMarginOrder({'id': 1, 'side': 'cancelMarginOrder', 'symbol': 'USDT'}) Pass id of the margin transaction you are looking to cancel symbol -> COIN NAME,
Settle a margin order partially bitbnsObj.settleMarginPartial({'id': 1, 'side': 'settleMarginOrderPartial', 'amt': 50, 'symbol': 'USDT'}) amt -> Amount to settle Pass id of the margin transaction you are looking to settle and amt you want to settle
Settle a margin order completely bitbnsObj.settleMargin({ 'id' : 1, 'side' : 'settleMarginOrder', 'symbol': 'USDT' }) Pass id of the margin transaction you are looking to settle
Get my margin executed orders bitbnsObj.listMarginExecuted({'page': 1, 'side': 'listMarginExecuted', 'type': 'BORROW', 'symbol': 'USDT'}) type => LEND or BORROW
Get my margin pending orders bitbnsObj.listMarginPending({'page': 1, 'side': 'listMarginPending', 'symbol': 'USDT'})
Get open orders of margin market - all users bitbnsObj.listMarginMarketOrders({'type': 'BORROW', 'side': 'listMarketOrders', 'symbol': 'XRP'}) type => LEND or BORROW
HTTP error status codes
HTTP error codes would be returned incase of any errors, the body will also cointain an error feild which will explain the cause of the error
Code | Meaning |
---|---|
200 | null -- requested action has been performed without any problems |
400 | Invalid Request -- Invalid request format |
401 | authentication -- Not authorised or invalid API key |
403 | Undefined -- this request is forbidden |
404 | Exchange not found -- Unable to find exchange |
406 | Coin name not supplied or not yet supported -- coin name applied is incorrect |
409 | parameter type not correct -- parameters entered is incorrect |
412 | Oops ! Cancellation failed. Something went wrong ! -- Unable to cancel order |
413 | volume asked not acceptable -- Desired volume is not within bounds |
416 | Oops ! Not sufficient balance to purchase currency -- wallet balance is not sufficient |
417 | Oops ! Order doesn't exist any more -- Order has alredy been deleted |
428 | Price seems Irregular from current market price. -- Entered price is more than current price |
500 | Problem with our servers, try again later |
503 | currently down for maintaince |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bitbnspy-0.1.29-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51216b6df879c33af0684234c759fff91e1e2087c3e3b6c47336bd988170b873 |
|
MD5 | bdf98caaa88353d2be03ca93ccb6192e |
|
BLAKE2b-256 | 4e10b8d8b26b12e2d5f125b12b48b112d838e9f528b5e67cbf72e403f44ed78c |