Public / Private API

6000 requests/keypair/5minutes, you can contact Quidax if you need more.

Ready to use

You need to request for access/secret key at first

Authentication

To use the private API, you need to get your access/secret key first. After you are signed up, verified and have been given API access, please visit the API Tokens page to get your keys. All private API requires 3 authentication parameters and zero or more API specific parameters. The 3 authentication parameters are:

access_key

Your access key.

tonce

tonce is a timestamp in integer, stands for milliseconds elapsed since Unix epoch. Tonce must be within 30 seconds of server's current time. Each tonce can only be used once.

signature

Signature of the API request, generated by you, using your secret key.

Remarks

id: Unique order ID

side: Buy/Sell

price: Order price

avg_price: Average execution price

state: wait, done or cancel. 'wait' represents the order is active, it may be a new order or partial complete order; 'done' means the order has been fulfilled completely; 'cancel' means the order has been canceled.

market: Which market the order belongs to

created_at: Order created time

volume: volume to buy/sell

remaining_volume: remaining_volume is always less or equal than volume

executed_volume: volume = remaining_volume + executed_volume

trades: the order's trade history, see Trade. Note: not all order include trades, only detailed order data returned by certain API will.

Tips / Caveats

API

Detail

POST /api/v2/order/delete

Cancel order is an asynchronous operation. A success response only means your cancel request has been accepted, it doesn't mean the order has been canceled. You should always use /api/v2/order or websocket api to get order's latest state.

POST /api/v2/orders/clear

Cancel all your orders is an asynchronous operation. A success response only means your request has been accepted. The orders in response may or may not have been canceled yet.

API List

All API are listed below with details. Those require access_key/tonce/signature are private API.