API
Biztranex provides a simple and powerful REST API to allow you to programatically perform nearly all actions you can from our web interface. All requests use the application/json content type and go over https. The base url is https://biztranex.com/api-{version}/. All requests are GET requests and all responses come in a default response object with the result in the result field. Always check the success flag to ensure that your API call succeeded.
We are currently restricting orders to 500 open orders and 200,000 orders a day. We reserve the right to change these settings as we tune the system. If you are affected by these limits as an active trader, please open a support ticket.
If you have any questions, feedback or recommendation for API support you can post a question in our support center.
General
We provide a simple RESTful API. All calls are GETs and should be called via https. We will support n-1 versions of the API. Our current stable API is v1. The endpoints have a standard format as follows:
https://biztranex.com/api-{version}/{method}?param=value
Authentication
In the spirit of keeping things simple, we offer an easy to manage API Key authentication method. You can have multiple API keys, each with their own level of rights. To manage your API keys please go to Settings > API.
You have to pass apisign inside header of request, example pseudo code:
apisign = md5(REQUEST_EXCEPT_APIKEY+API_SECRET)
Example 1:
https://biztranex.com/api-v1/account/getbalance?currency=BTC&apikey=API_KEY
apisign = md5("currency=BTC"+API_SECRET)
Example 2:
https://biztranex.com/api-v1/market/sell?market=BTC-ETH&quantity=1&rate=0.02&apikey=API_KEY
apisign = md5("market=BTC-ETH&quantity=1&rate=0.02"+API_SECRET)
Note
You MUST have 2FA enabled to create an API key for your own safety.
- Read Info - You can only view the balances, orders, and other details of the account
- Withdraw - We allow you to programatically withdraw any currency to an address you provide. This can be used to quick arbitrage exchanges or move money into cold storage after thresholds.
- Trade - This allows the API key to place uy and sell orders
API Reference
Our APIs are broken into three distinct groups
- Public - Public information available without an API key
- Market - For programmatic trading of crypto currencies
- Account - For managing your account
-
public/getmarkets
Used to get the open and available trading markets at Biztranex along with other meta data.ParamertersNoneİstekhttps://biztranex.com/api-v1/public/getmarkets
Tepki -
public/getcurrencies
Used to get all supported currencies at Biztranex along with other meta data.ParamertersNoneİstekhttps://biztranex.com/api-v1/public/getcurrencies
Tepki -
public/getticker
Used to get the current tick values for a market.Paramertersmarketrequiredİstekhttps://biztranex.com/api-v1/public/getticker?market=BTC-ETH
Tepki -
public/getmarketsummaries
Used to get the last 24 hour summary of all active markets.ParamertersNoneİstekhttps://biztranex.com/api-v1/public/getmarketsummaries
Tepki -
public/getmarketsummary
Used to get the last 24 hour summary of a specific market.Paramertersmarketrequiredİstekhttps://biztranex.com/api-v1/public/getmarketsummary?market=BTC-ETH
Tepki -
public/getorderbook
Used to get retrieve the orderbook for a given market.Paramertersmarketrequiredtyperequiredİstekhttps://biztranex.com/api-v1/public/getorderbook?market=BTC-ETH&type=both
Tepki -
public/getmarkethistory
Used to retrieve the latest trades that have occured for a specific market.Paramertersmarketrequiredİstekhttps://biztranex.com/api-v1/public/getmarkethistory?market=BTC-ETH
Tepki -
public/getmarkethistory-new
ParamertersNoneİstekhttps://biztranex.com/api-v1/public/getmarkethistory-new
Tepki
-
market/buy
Used to place a buy order in a specific market. Make sure you have the proper permissions set on your API keys for this call to work.Paramertersmarketrequiredquantityrequiredraterequiredİstekhttps://biztranex.com/api-v1/market/buy?market=BTC-ETH&quantity=0.5&rate=0.0832&apikey=API_KEY
Tepki -
market/sell
Used to place an sell order in a specific market. Make sure you have the proper permissions set on your API keys for this call to work.Paramertersmarketrequiredquantityrequiredraterequiredİstekhttps://biztranex.com/api-v1/market/sell?market=BTC-ETH&quantity=0.5&rate=0.08321&apikey=API_KEY
Tepki -
market/cancel
Used to cancel a buy or sell order.Paramertersuuidrequiredİstekhttps://biztranex.com/api-v1/market/cancel?uuid=z5n4xi3x&apikey=API_KEY
Tepki -
market/getopenorders
Get all orders that you currently have opened. A specific market can be requested.Paramertersmarketrequiredİstekhttps://biztranex.com/api-v1/market/getopenorders?market=BTC-ETH&apikey=API_KEY
Tepki
-
account/getbalances
Used to retrieve all balances from your account.ParamertersNoneİstekhttps://biztranex.com/api-v1/account/getbalances?apikey=API_KEY
Tepki -
account/getbalance
Used to retrieve the balance from your account for a specific currency.Paramerterscurrencyrequiredİstekhttps://biztranex.com/api-v1/account/getbalance?currency=BTC&apikey=API_KEY
Tepki -
account/getdepositaddress
Used to retrieve or generate an address for a specific currency. If one does not exist, the call will fail and return ADDRESS_GENERATING until one is available.Paramerterscurrencyrequiredİstekhttps://biztranex.com/api-v1/account/getdepositaddress?currency=BTC&apikey=API_KEY
Tepki -
account/withdraw
Used to withdraw funds from your account. Note: please account for txfee.Paramerterscurrencyrequiredquantityrequiredaddressrequiredİstekhttps://biztranex.com/api-v1/account/withdraw?currency=BTC&quantity=1&address=3BEV18uSaKgsLqJ9EkDYfs92tYYNSvE6rM&apikey=API_KEY
Tepki -
account/getorder
Used to retrieve a single order by uuid.Paramertersuuidrequiredİstekhttps://biztranex.com/api-v1/account/getorderuuid=z5n4xi3x&apikey=API_KEY
Tepki -
account/getorderhistory
Used to retrieve your order history.Paramertersmarketrequiredİstekhttps://biztranex.com/api-v1/account/getorderhistory?market=BTC-ETH&apikey=API_KEY
Tepki -
account/getwithdrawalhistory
Used to retrieve your withdrawal historyParamerterscurrencyrequiredİstekhttps://biztranex.com/api-v1/account/getwithdrawalhistory?currency=BTC&apikey=API_KEY
Tepki -
account/getdeposithistory
Used to retrieve your deposit historyParamerterscurrencyrequiredİstekhttps://biztranex.com/api-v1/account/getdeposithistory?currency=BTC&apikey=API_KEY
Tepki