Crypto-Shoutbox
  • Last : 640.24 USD
  • Low : 636.57 USD
  • High : 664.99999998 USD
  • Volume : 0.14006077 BTC / 89.88 USD
  • 07-12-2014 13:45:30
API v1 API Documention
Basic Knowledge Base

Log into your Account

1) Select "API Settings" from account drop list.
2) Click on "Generate New API" to generate a new API set.
3) Click on "Save Permissions" after checking your desired permission(s).

Info - required for using Get Information API
History - required for using Trades History, Order History, Order Info and Transactions APIs
Trade - required for using Trade,CancelOrder API

After you are done with API generation , you can start using APIs (Available APIs Section) by using code examples below or by making your own code following the guidelines of the API you will be using. Some APIs do not need API keys, for example the "Ticker API".

Main API Function

This is the main callable function which is called by all API functions (eg. Get Information calling function) which are mentioned one by one after this section

Get Information

Get Trades History

Get My Orders History

Get Transactions History

Get Order Info

Trade

Cancel Order



APIs Descriptions

Returns the current ticker for a given pair, eg. btc_usd

Authentication:
Permission:
Method:
URL:
URL Example:
Response Type:
No
None
GET
https://crypto-trade.com/api/1/ticker/[currencyA]_[currencyB]
https://crypto-trade.com/api/1/ticker/btc_usd
JSON

Success:
{"status":"success","data":{"last":"128","low":"127.9999","high":"129.1","vol_btc":"5.4","vol_usd":"693.8199","min_ask":"129.1","max_bid":"128"}}

Error:
{"status":"error","error":"Invalid pair"}

Returns the current order depth for a given pair, eg. btc_usd

Authentication:
Permission:
Method:
URL:
URL Example:
Response Type:
No
None
GET
https://crypto-trade.com/api/1/depth/[currencyA]_[currencyB]
https://crypto-trade.com/api/1/depth/btc_usd
JSON

Success:
{"asks":[["102","0.81718312"],["103","1.69078621"],["110","1"],["115","1.358"],["120","0.29"],["122","1.34848"],["128.0556","0.093"],["128.1","0.09288"],["128.115","0.0183"],["130.01","0.11992"],["139","0.09"],["150","0.1"],["1000","0.1"]],"bids":[["100","3.493"],["99.04","0.67687862"],["99.03","4"],["99.01","2"],["98","3.394"],["96.59","1.3948"],["93","1.012994"],["92","1.92"],["91.1","1.0399"],["90","1.284"],["85","0.39"],["82.23","2.2445"],["81.4","1.239"],["80","2.34855"],["75.43","0.14234"],["75","1"],["60","10"],["50","4.245"]]}

Error:
{"status":"error","error":"Invalid pair"}

Returns information about your account: currency balances , api permissions , transaction counts, active order counts, and the server timestamp.

Authentication:
Permission:
Method:
URL:
Response Type:
Required
Info
POST
https://crypto-trade.com/api/1/private/getinfo
JSON

Success:
{"status":"success","data":{"funds":{"usd":"1896.55927015","eur":"0","btc":"12098.91081965","ltc":"1000","nmc":"0","trc":"0","dvc":"0","ppc":"0","ftc":"0","cnc":"0","bqc":"0"},"perms":{"info":"1","history":"1","trade":"1"},"active_orders":0,"transactions_count":43,"server_timestamp":1370985781}}

Error:
{"status":"error","error":"Permission Error"}

Returns trades history for any given pair or all pairs based on parameters.

Authentication:
Permission:
Method:
URL:
Response Type:
Required
History
POST
https://crypto-trade.com/api/1/private/tradeshistory
JSON

Success:
{"status":"success","data":[{"id":17,"timestamp":1370965122,"pair":"btc_usd","type":"Sell","amount":"0.1","rate":"128","my_order":1},{"id":15,"timestamp":1370965111,"pair":"btc_usd","type":"Buy","amount":"1","rate":"128.7","my_order":1}]}

Error:
{"status":"error","error":"Permission Error"}

Parameters:
Sl. No Name Description Type/Value Required? Default Example
1 start_id Starting trade id of the data range to be fetched Integer No 0 100
2 end_id Ending trade id of the data range to be fetched Integer No 4294967295 1000
3 start_date Starting trade date/timestamp of the data range to be fetched Unix Timestamp No 0 1371032175
4 end_date Ending trade date/timestamp of the data range to be fetched Unix Timestamp No 4294967295 1371043175
5 count Number of trade records to fetch ( Maximum : 6000 ) Integer No 1000 1500
6 order Order of the fetched data based on id (ascending or descending) ASC or DESC No DESC ASC
7 pair Currency pair based on which the data set will be filtered String No All Pairs btc_usd

Returns your order history for any given pair or all pairs based on parameters.

Authentication:
Permission:
Method:
URL:
Response Type:
Required
History
POST
https://crypto-trade.com/api/1/private/ordershistory
JSON

Success:
{"status":"success","data":[{"id":7,"timestamp":1370952372,"pair":"btc_usd","type":"Sell","initial_amount":"1","remaining_amount":"0","rate":"128.7","status":"Completed"},{"id":6,"timestamp":1370944501,"pair":"btc_usd","type":"Buy","initial_amount":"2","remaining_amount":"0","rate":"128.5","status":"Completed"}]}

Error:
{"status":"error","error":"Permission Error"}

Parameters:
Sl. No Name Description Type/Value Required? Default Example
1 start_id Starting order id of the data range to be fetched Integer No 0 100
2 end_id Ending order id of the data range to be fetched Integer No 4294967295 1000
3 start_date Starting order date/timestamp of the data range to be fetched Unix Timestamp No 0 1371032175
4 end_date Ending order date/timestamp of the data range to be fetched Unix Timestamp No 4294967295 1371043175
5 count Number of order records to fetch ( Maximum : 6000 ) Integer No 1000 1500
6 order Display order of the fetched data based on id (ascending or descending) ASC or DESC No DESC ASC
7 pair Currency pair based on which the data set will be filtered String No All Pairs btc_usd

Returns your transaction history based on parameters.

Authentication:
Permission:
Method:
URL:
Response Type:
Required
History
POST
https://crypto-trade.com/api/1/private/transactions
JSON

Success:
{"status":"success","data":[{"id":2425,"timestamp":1371058368,"currency":"BTC","type":"Bought","amount":"0.49925","desc":"Bought 0.5 BTC (-0.15% Fees) @ 123 USD from Order #8","status":"Completed"},{"id":2424,"timestamp":1371058367,"currency":"BTC","type":"Sold","amount":"-0.5","desc":"Sold 0.5 BTC for receiving 61.5 USD from Order #8","status":"Completed"}]}

Error:
{"status":"error","error":"Permission Error"}

Parameters:
Sl. No Name Description Type/Value Required? Default Example
1 start_id Starting transaction id of the data range to be fetched Integer No 0 100
2 end_id Ending transaction id of the data range to be fetched Integer No 4294967295 1000
3 start_date Starting transaction date/timestamp of the data range to be fetched Unix Timestamp No 0 1371032175
4 end_date Ending transaction date/timestamp of the data range to be fetched Unix Timestamp No 4294967295 1371043175
5 count Number of transaction records to fetch ( Maximum : 6000 ) Integer No 1000 1500
6 order Display order of the fetched data based on id (ascending or descending) ASC or DESC No DESC ASC

Fetches information about a specific order.

Authentication:
Permission:
Method:
URL:
Response Type:
Required
History
POST
https://crypto-trade.com/api/1/private/orderinfo
JSON

Success:
{"status":"success","data":[{"id":12,"orderdate":1371070208,"pair":"btc_usd","type":"Buy","initial_amount":"1","remaining_amount":"1","rate":"121.34","status":"Cancelled"}]}

Error:
{"status":"error","error":"Permission Error"}

Parameters:
Sl. No Name Description Type/Value Required? Default Example
1 orderid Id of the order Integer Yes None 111

Places a buy or sell order.

Authentication:
Permission:
Method:
URL:
Response Type:
Required
Trade
POST
https://crypto-trade.com/api/1/private/trade
JSON

Success:
{"status":"success","data":{"bought":0,"remaining":"1","order_id":"13","funds":{"usd":"1535.78614365","eur":"0","btc":"12098.50646965","ltc":"1000","nmc":"0","trc":"0","dvc":"0","ppc":"0","ftc":"0","cnc":"0","wdc":"0","dgc":"0"}}}

Error:
{"status":"error","error":"Permission Error"}

Parameters:
Sl. No Name Description Type/Value Required? Default Example
1 pair Currency pair to execute trade String Yes None btc_usd
2 type Type of trade action ie. Buy or Sell Buy or Sell Yes None Buy
3 amount Amount to buy or sell Integer/Float Yes None 1000
4 rate Price rate at which to buy or sell Integer/Float Yes None 15

Cancels an existing trade order.

Authentication:
Permission:
Method:
URL:
Response Type:
Required
Trade
POST
https://crypto-trade.com/api/1/private/cancelorder
JSON

Success:
{"status":"success","data":{"order_id":"10","orderstatus":"Cancelled","funds":{"usd":"1920.50627486","eur":"0","btc":"12098.50496965","ltc":"1000","nmc":"0","trc":"0","dvc":"0","ppc":"0","ftc":"0","cnc":"0","bqc":"0"}}}

Error:
{"status":"error","error":"Permission Error"}

Parameters:
Sl. No Name Description Type/Value Required? Default Example
1 orderid Id of the order Integer Yes None 111
News Updates
22nd Jun,2014
ESECURITYSA LTC dividends paid
ESECURITYSA LTC dividends paid from January to May...
All News
Last completed order 3 mins. ago
  • ID - # 398079
  • Pair - LTC/BTC
  • Type - Buy
  • Amount - 0.13916776 LTC
  • Price - 0.01287821 BTC
Partnerships
  • Dedicated Server - Koddos.com
  • DDoS Protection - Koddos.com
  • Mining Pool - n/A
  • Forum Partner - n/A
  • Information Resource - n/A
Our Contacts
  • Contact us
  • Level 23, One Island East,18 Westlands       Road, Quarry Bay, HK
  • +852 3750 7973
  • +852 2297 2289
ajaxloader