Spot - idax API Doc

Public

Security: None

Test Connectivity

GET https://openapi.idax.exchange/sapi/v1/ping This endpoint checks connectivity to the host

{}

Check Server Time

GET https://openapi.idax.exchange/sapi/v1/time This endpoint checks connectivity to the server and retrieves server timestamp

{
    "timezone": "GMT+08:00",
    "serverTime": 1595563624731
}

Pairs List

GET https://openapi.idax.exchange/sapi/v1/symbols

{
    "symbols": [
        {
          "quantityPrecision":1,
          "symbol":"spc1mont",
          "pricePrecision":5,
          "quoteAssetName":"MNT",
          "baseAssetName":"SPC",
          "baseAsset":"SPC1",
          "quoteAsset":"MONT"
        },
        {
          "quantityPrecision":1,
          "symbol":"spc1ardx1557",
          "pricePrecision":6,
          "quoteAssetName":"ARDX",
          "baseAssetName":"SPC",
          "baseAsset":"SPC1",
          "quoteAsset":"ARDX1557"
        },
        {
          "quantityPrecision":1,
          "symbol":"usdttestmnttest",
          "pricePrecision":8,
          "quoteAssetName":"MNTTEST",
          "baseAssetName":"USDTTEST",
          "baseAsset":"USDTTEST",
          "quoteAsset":"MNTTEST"
        },
        {
          "quantityPrecision":1,
          "symbol":"zesc1620mont",
          "pricePrecision":3,
          "quoteAssetName":"MNT",
          "baseAssetName":"ZESC",
          "baseAsset":"ZESC1620",
          "quoteAsset":"MONT"
        },
        {
          "quantityPrecision":1,
          "symbol":"zesc1620ardx1557",
          "pricePrecision":6,
          "quoteAssetName":"ARDX",
          "baseAssetName":"ZESC",
          "baseAsset":"ZESC1620",
          "quoteAsset":"ARDX1557"
        }
    ]
}

weight(IP/UID): 1

Response:


symbol	string	`zesc1620ardx1557`	Name of the symbol	Currency to name
baseAsset	string	`ZESC1620`	Underlying asset for the symbol	base currency
quoteAsset	string	`ARDX1557`	Quote asset for the symbol	The base currency
baseAssetName	string	`ZESC`	Name of the underlying asset	base currency
quoteAssetName	string	`ARDX`	Name of the quote asset	The base currency
pricePrecision	integer	`6`	Precision of the price	Price Accuracy
quantityPrecision	integer	`1`	Precision of the quantity	Quantity accuracy

Market

Security Type: None

Depth

GET https://openapi.idax.exchange/sapi/v1/depth Get market depth data.

Query Parameters

Name	Type	Description
limit	integer	Default 100; Max 100
symbol*	String	Symbol Name E.g. BTCUSDT

{
  "bids": [
    [
      3.90000000,   // price
      431.00000000  // vol
    ],
    [
      4.00000000,
      431.00000000
    ]
  ],
  "asks": [
    [
      4.00000200,  // price
      12.00000000  // vol
    ],
    [
      5.10000000,
      28.00000000
    ]
  ]
}

weight(IP/UID): 5

Response:


time	long	`1595563624731`	Current timestamp (ms)
bids	list	;	List of all bids, best bids first. See below for entry details.
asks	list	;	List of all asks, best asks first. See below for entry details.

The fields bids and asks are lists of order book price level entries, sorted from best to worst.


’ ‘	float	`131.1`	price level
’ ‘	float	`2.3`	The total quantity of orders for this price level

24hrs ticker

GET https://openapi.idax.exchange/sapi/v1/ticker Get data of 24 hour price change statistics.

Query Parameters

Name	Type	Description
symbol*	String	Symbol Name. E.g. `BTCUSDT`

{
  "high":"91450.14",
  "vol":"1920.5569555",
  "last":"89999.01",
  "low":"88721.87",
  "buy":89998.05,
  "sell":89999.86,
  "rose":"-0.0028905413",
  "time":1731891837000,
  "open":"90259.91"
}

weight(IP/UID): 5

Response:


time	long	`1595563624731`	Open Time
high	string	`9900`	High Price
low	string	`8800.34`	Low Price
open	string	`8700`	Open Price
last	string	`8900`	Last Price
vol	string	`4999`	Trade Volume
rose	string	0	Price increase or Price rise
buy	float	`4999`	Highest bid price on orderbook
sell	float	0	Lowest ask price on orderbook

Recent Trades List

GET https://openapi.idax.exchange/sapi/v1/trades Fetch list of recent trades in reverse chronological order.

Query Parameters

Name	Type	Description
symbol*	String	Symbol Name. E.g. `BTCUSDT`
limit	String	Default 100; Max 1000

{
    "list":[
      {
        "symbol":"BTCUSDT",
        "side":"SELL",
        "price":"90080.04",
        "qty":"0.02955",
        "id":185678400,
        "time":1731892228378
      }
    ]
}

weight(IP/UID): 5

Response:


price	string	`0.055`	The price of the trade
time	long	`1537797044116`	Current timestamp (ms)
qty	string	`5`	The quantity traded
side	string	`BUY/SELL`	Taker side
symbol	string	`BTCUSDT`	Symbol
id	long	`185678400`	Trade id

Kline/candlestick data

GET https://openapi.idax.exchange/sapi/v1/klines Returns kline data (chart data) of symbol.

Query Parameters

Name	Type	Description
symbol*		Symbol Name. E.g. `BTCUSDT`
interval*	String	Interval of the Kline. Possible values include: `1min`,`5min`,`15min`,`30min`,`60min`,`1day`,`1week`,`1month`
limit	String	Default 100; Max 300
startTime	long	startTime example:`1538728740000`
endTime	long	endTime example:`1538728740000`

[
  {
    "high":"90452.29",
    "vol":"0.93406",
    "low":"90392.44",
    "idx":1731893160000,
    "close":"90415.62",
    "open":"90407.82"
  },
  {
    "high":"90420.17",
    "vol":"2.78998",
    "low":"90314.01",
    "idx":1731893100000,
    "close":"90399.63",
    "open":"90320.15"
  },
  {
    "high":"90320.17",
    "vol":"0.91645",
    "low":"90200.03",
    "idx":1731893040000,
    "close":"90320.17",
    "open":"90216.15"
  }
]

weight(IP/UID): 1

Response:


idx	long	`1538728740000`	Open time
open	string	`90216.15`	open price
close	string	`90320.17`	close price
high	string	`36.00000`	high price
low	string	`30.00000`	low price
vol	string	`2456.111`	volume

Trade

Security Type: TRADE

Endpoints under Trade require an API Key and a signature

New Order

POST https://openapi.idax.exchange/sapi/v1/order Rate Limit: 100times/2s Place a new order.

Query Parameters

Name	Type	Description
X-CH-SIGN	string	Signature
X-CH-APIKEY	string	Your API-key
X-CH-TS	integer	Timestamp

Request Body

Name	Type	Description
symbol*	String	Symbol Name. E.g. `BTCUSDT`
symbolName	String	Currency display name: choose either symbol or symbolName to fill in.
volume*	number	Order vol. For MARKET BUY orders, vol=amount.
side*	String	Side of the order,`BUY/SELL`
type*	String	Type of the order, `LIMIT/MARKET`
price*	number	Order price, REQUIRED for LIMIT orders
newClientOrderId	String	Unique order ID generated by users to mark their orders
recvWindow*	integer	Time window

{
  "symbol": "USDTTESTMNTTEST",
  "side": "BUY",
  "executedQty": "0",
  "orderId": "2462009480448926608",
  "price": "3452",
  "origQty": "123",
  "clientOrderId": null,
  "transactTime": "1731893951010",
  "orderIdString": "2462009480448926608",
  "type": "LIMIT",
  "status": "0"
}

weight(IP/UID): 5

Response:


orderId	string	`150695552109032492`	ID of the order
orderIdString	string	`150695552109032492`	ID of the order (in string format)
clientorderId	string	`213443`	A unique ID of the order.
symbol	string	`BTCUSDT`	Symbol Name
transactTime	string	`1273774892913`	Time the order is placed
price	string	`4765.29`	Time the order is placed
origQty	string	`1.01`	Quantity ordered
executedQty	string	`1.01`	Quantity of orders that has been executed
type	string	`LIMIT`	Order type `LIMIT,MARKET`
side	string	`BUY`	Order side：`BUY, SELL`
status	string	`0`	0 = new order

Test New Order

POST https://openapi.idax.exchange/sapi/v1/order/test Test new order creation and signature/recvWindow length. Creates and validates a new order but does not send the order into the matching engine.

Headers

Name	Type	Description
X-CH-APIKEY	String	Your API-key
X-CH-TS	String	timestamp
X-CH-SIGN	String	Sign

Request Body

Name	Type	Description
type*	String	Type of the order, `LIMIT/MARKET`
price*	number	Order price, REQUIRED for `LIMIT` orders
volume*	number	Order vol. For MARKET BUY orders, vol=amount.
side*	String	Side of the order, `BUY/SELL`
symbol*	String	Symbol Name. E.g. `BTCUSDT`
recvWindow*	integer	Time window
newClientorderId	String	Unique order ID generated by users to mark their orders

{
    // Same as creating an actual order
}

weight(IP/UID): 1

Batch Orders

POST https://openapi.idax.exchange/sapi/v1/batchOrders batch contains at most 10 orders

Headers

Name	Type	Description
X-CH-APIKEY	String	Your API-key
X-CH-TS	String	timestamp
X-CH-SIGN	String	Sign

Request Body

Name	Type	Description
orders	list	The batch order information can contain a maximum of 10 records.
symbol*	String	Symbol Name. E.g. `BTCUSDT`
symbolName	String	Currency display name: choose either symbol or symbolName to fill in.

{
    "idsString": [ //Character String Type Order ID (Recommended)
        "165964665990709251",
        "165964665990709252",
        "165964665990709253"
    ],
    "ids": [
        165964665990709251,
        165964665990709252,
        165964665990709253
    ]
}

weight(IP/UID): 10

Request `orders` field:

name	type	Example	Description
price	float	`1000`	Price
volume	float	`20.1`	Quantity
side	string	`BUY/SELL`	Direction
batchType	string	`LIMIT/MARKET`	Type

Response

Name	Type of array	Sample	Description
idsString	String	“3213213”	A collection of order ids in string format.
ids	long	2100	Collection of order numbers.

Query Order

GET https://openapi.idax.exchange/sapi/v1/order

Query Parameters

Name	Type	Description
orderId*	String	Order ID
newClientorderId	String	Client Order Id, Unique order ID generated by users to mark their orders. E.g. 354444heihieddada
symbol*	String	Symbol Name. E.g. `BTCUSDl`
symbolName	String	Currency display name: choose either symbol or symbolName to fill in.

Headers

Name	Type	Description
X-CH-APIKEY	String	Your API-key
X-CH-TS	String	timestampResponses200
X-CH-SIGN	String	Sign

{
  'symbol': 'USDTTESTMNTTEST', 
  'orderType': '1', 
  'side': 'SELL', 
  'executedQty': '0.0', 
  'executedMoney': '0.0', 
  'orderId': '2462019444773044769', 
  'origQty': '123.0', 
  'avgPrice': '0.0', 
  'clientOrderId': None, 
  'orderIdString': '2462019444773044769', 
  'type': 'LIMIT', 
  'stopPrice': '0', 
  'price': '3451.0', 
  'transactTime': '1731899741000', 
  'isWorking': True, 
  'status': 'NEW'
}

weight(IP/UID): 1

Response:


orderId	string	`150695552109032492`	Order ID (system generated)
clientorderId	string	`213443`	Client order ID (sent by yourself)
symbol	string	`BTCUSDT`	Currency Pair Name
price	string	`4765.29`	Order Price
origQty	string	`1.01`	Number of orders
executedQty	string	`1.01`	Number of orders already filled
avgPrice	string	`4754.24`	Average price of orders already filled
type	string	`limit`	The order type`LIMIT,MARKET`
side	string	`BUY`	Order direction. Possible values can only be: BUY (buy long) and SELL (sell short)
status	string	`NEW`	Order status. Possible values are NEW (new order, no transaction), PARTIALLY_FILLED (partially filled), FILLED (fully filled), CANCELED (cancelled) and REJECTED (order rejected).POST
transactTime	string	1574327555669	Order Creation Time

Cancel Order

POST https://openapi.idax.exchange/sapi/v1/cancel

Headers

Name	Type	Description
X-CH-APIKEY	String	Your API-key
X-CH-TS	String	timestamp
X-CH-SIGN	String	Sign

Request Body

Name	Type	Description
newClientOrderId	String	Client Order Id, Unique order ID generated by users to mark their orders. E.g. 354444heihieddada
orderId*	String	Order ID
symbol*	String	Symbol Name. E.g. `BTCUSDT`

{
    'symbol': 'BHTUSDT', 
    'clientOrderId': '0', 
    'orderId': '499890200602846976', 
    'status': 'CANCELED'
}

weight(IP/UID): 5

Response:


orderId	long	`150695552109032492`	ID of the order
clientorderId	string	`213443`	Unique ID of the order.
symbol	string	`BTCUSDT`	Name of the symbol
status	string	`NEW`	The state of the order.Possible values include `NEW`, `PARTIALLY_FILLED`, `FILLED`, `CANCELED`, and `REJECTED`.POST

Batch cancel orders

POST https://openapi.idax.exchange/sapi/v1/batchCancel batch contains at most 10 orders

Headers

Name	Type	Description
X-CH-APIKEY	String	Your API-key
X-CH-TS	String	timestamp
X-CH-SIGN	String	Sign

Request Body

Name	Type	Description
orderIds	String	Order ID collection `[123,456]`Responses200GET
symbol*	String	Symbol Name. E.g. `BTCUSDT`

{
    "success": [
        165964665990709251,
        165964665990709252,
        165964665990709253
    ],
    "failed": [ //cancel fails because the order does not exist or the order state has expired
        165964665990709250  
    ]
}

weight(IP/UID): 10

Current Open Orders

GET https://openapi.idax.exchange/sapi/v1/openOrders

Query Parameters

Name	Type	Description
symbol*	String	Symbol Name. E.g. `BTCUSDT`
limit	String	Default 100; Max 1000

Headers

Name	Type	Description
X-CH-APIKEY	String	Your API-key
X-CH-TS	String	timestamp
X-CH-SIGN	String	Sign

[
    {
        'orderId': 499902955766523648, 
        'orderIdString': '499902955766523648', //Character String Type Order ID (Recommended)
        'symbol': 'BHTUSDT', 
        'price': '0.01', 
        'origQty': '50', 
        'executedQty': '0', 
        'avgPrice': '0', 
        'status': 'NEW', 
        'type': 'LIMIT', 
        'side': 'BUY', 
        'time': '1574329076202'
        },...
]

weight(IP/UID): 1

Response:


orderId	long	`150695552109032492`	ID of the order
orderIdString	string	”`150695552109032492"`	Character String Type Order ID (Recommended)
clientorderId	string	`213443`	Unique ID of the order.
symbol	string	`BTCUSDT`	Name of the symbol
price	float	`4765.29`	Price of the order
origQty	float	`1.01`	Quantity ordered
executedQty	float	`1.01`	Quantity of orders that has been executed
avgPrice	float	`4754.24`	Average price of filled orders.
type	string	`LIMIT`	The order type`LIMIT,MARKET`
side	string	`BUY`	The order side `BUY,SELL`
status	string	`NEW`	The state of the order.Possible values include `NEW`, `PARTIALLY_FILLED`, `FILLED`, `CANCELED`, and `REJECTED`.GET
time	string	1574327555669	Creation Time

Trades

GET https://openapi.idax.exchange/sapi/v1/myTrades

Query Parameters

Name	Type	Description
symbol*	String	Symbol Name. E.g. `BTCUSDT`
limit	String	Default 100; Max1000
fromId	String	Trade Id to fetch from

Headers

Name	Type	Description
X-CH-APIKEY	String	Your API-key
X-CH-TS	String	timestamp
X-CH-SIGN	String	Sign

[
  {
    "symbol": "ETHBTC",
    "id": 100211,
    "bidId": 150695552109032492,
    "askId": 150695552109032493,
    "price": "4.00000100",
    "qty": "12.00000000",
    "time": 1499865549590,
    "isBuyer": true,
    "isMaker": false,
    "feeCoin": "ETH",
    "fee":"0.001",
    "bidUserId":23334,
    "askUserId":44112
  },...
]

weight(IP/UID): 1

Response:


symbol	string	`BTCUSDT`	Name of the symbol
id	integer	`28457`	Trade ID
bidId	long	`150695552109032492`	Bid Order ID
askId	long	`150695552109032492`	Ask Order ID
price	integer	`4.01`	Price of the trade
qty	float	`12`	Quantiry of the trade
time	number	`1499865549590`	timestamp of the trade
isBuyer	bool	`true`	`true`= Buyer `false`= Seller
isMaker	bool	`false`	`true`=Maker `false`=Taker
feeCoin	string	`ETH`	Trading fee coin
fee	number	`0.001`	Trading fee
bidUserId	long	23334	Buyer UID
askUserId	long	44112	Seller UID
isSelf	bool	true	whether is self dealt

Account

Security Type: USER_DATA

Endpoints under Account require an API-key and a signature.

Account Information

GET https://openapi.idax.exchange/sapi/v1/account

Headers

Name	Type	Description
X-CH-APIKEY	String	Your API-key
X-CH-TS	String	timestamp
X-CH-SIGN	String	Sign

{
    'balances': 
        [
            {
                'asset': 'BTC', 
                'free': '0', 
                'locked': '0'
                }, 
            {
                'asset': 'ETH', 
                'free': '0', 
                'locked': '0'
                },...
        ]
}

weight(IP/UID): 1

Response:

name	type	description
`balances`	[]	Show balance details

balances field:

name	type	example	description
`asset`	string	`USDT`	Name of the asset
`free`	float	1000.30	Amount available for use
`locked`	float	400	Amount locked (for open orders)

Essentials

​Public

​Security: None

​Test Connectivity

​Check Server Time

​Pairs List

​Response:

​Market

​Security Type: None

​Depth

​Query Parameters

​Response:

​24hrs ticker

​Query Parameters

​Response:

​Recent Trades List

​Query Parameters

​Response:

​Kline/candlestick data

​Query Parameters

​Response:

​Trade

​Security Type: TRADE

​New Order

​Query Parameters

​Request Body

​Response:

​Test New Order

​Headers

​Request Body

​Batch Orders

​Headers

​Request Body

​Request orders field:

​Response

​Query Order

​Query Parameters

​Headers

​Response:

​Cancel Order

​Headers

​Request Body

​Response:

​Batch cancel orders

​Headers

​Request Body

​Current Open Orders

​Query Parameters

​Headers

​Response:

​Trades

​Query Parameters

​Headers

​Response:

​Account

​Security Type: USER_DATA

​Account Information

​Headers

​Response:

Public

Security: None

Test Connectivity

Check Server Time

Pairs List

Response:

Market

Security Type: None

Depth

Query Parameters

Response:

24hrs ticker

Query Parameters

Response:

Recent Trades List

Query Parameters

Response:

Kline/candlestick data

Query Parameters

Response:

Trade

Security Type: TRADE

New Order

Query Parameters

Request Body

Response:

Test New Order

Headers

Request Body

Batch Orders

Headers

Request Body

Request `orders` field:

Response

Query Order

Query Parameters

Headers

Response:

Cancel Order

Headers

Request Body

Response:

Batch cancel orders

Headers

Request Body

Current Open Orders

Query Parameters

Headers

Response:

Trades

Query Parameters

Headers

Response:

Account

Security Type: USER_DATA

Account Information

Headers

Response: