Spot

Public

Security: None

Test Connectivity

GET https://openapi.darkex.com/sapi/v1/ping

This endpoint checks connectivity to the host

{}

Check Server Time

GET https://openapi.xxx.xx/sapi/v1/time

GET https://openapi.darkex.com/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.darkex.com/sapi/v1/symbols

{
"symbols": [
{

weight(IP/UID): 1

Response:

symbol

string

BTCUSDT

Name of the symbol

Currency to name

baseAsset

string

BTC

Underlying asset for the symbol

base currency

quoteAsset

string

USDT

Quote asset for the symbol

The base currency

pricePrecisio n

integer

2

Precision of the price

Price Accuracy

quantityPrec ision

integer

6

Precision of the quantity

Quantity accuracy

limitAmount Min

String

100

Limit order minimum order amount quote

limitPriceMin

String

100

Minimum price of a limit order

limitVolume Min

String

100

Limit order minimum order quantity base

baseAssetN ame

String

BTC

Base Currency Display Name

quoteAssetN ame

String

USDT

Quote Currency

Display

SymbolNam e

String

BTC/USDT

TNraamdieng Pair Display Name

Market

Security Type: None

Depth

GET https://openapi.darkex.com/sapi/v1/depth

market detpth data

Query Parameters

Name

Type

Description

limit

integer

Default 100; Max 100

symbol*

String

Symbol Name E.g. BTCUSDT

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

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.darkex.com/sapi/v1/ticker

24 hour price change statistics.

Query Parameters

Name

Type

Description

symbol*

String

Symbol Name. E.g. BTCUSDT

{
"high": "9279.0301",
"vol": "1302",
"last": "9200",
"low": "9279.0301",
"rose": "0",
"time": 1595563624731
}

weight(IP/UID): 5

Response:

time

long

1595563624731

Open Time

high

float

9900

High Price

low

float

8800.34

Low Price

open

float

8700

Open Price

last

float

8900

Last Price

vol

float

4999

Trade Volume

Price increase

Recent Trades List

GET https://openapi.darkex.com/sapi/v1/trades

Query Parameters

Name

Type

Description

symbol*

String

Symbol Name. E.g. BTCUSDT

limit

String

Default 100; Max 1000Responses200

{
"list":[
{
"price":"3.00000100",
"qty":"11.00000000", "time":1499865549590,
"side":"BUY"
}
]
}

weight(IP/UID): 5

Response:

price

float

0.055

The price of the trade

time

long

1537797044116

Current timestamp (ms)

qty

float

5

The quantity traded

Kline/candlestick data

GET https://openapi.darkex.com/sapi/v1/klines

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 , 1mont h

Default 100; Max 300

String

Default 100; Max 300Responses200

startTime

long

startTime

example: 1538728740000

endTime

long

endTime

example: 1538728740000

[
{
"high": "6228.77",
"vol": "111",
"low": "6228.77",
"idx": 1538728740000,
"close": "6228.77",
"open": "6228.77", "id":1538728740
},
{
"high": "6228.77",
"vol": "222",
"low": "6228.77",
"idx": 1538728740000,
"close": "6228.77",
"open": "6228.77", "id":1538728740
},
{
"high": "6228.77",
"vol": "333",
"low": "6228.77",
"idx": 1538728740000,
"close": "6228.77",
"open": "6228.77", "id":1538728740
}
]

weight(IP/UID): 1

Response:

idx

long

1538728740000

Open time

（ms）

open

float

36.00000

open price

close

float

33.00000

close price

high

float

36.00000

high price

low

float

30.00000

low price

vol

float

2456.111

volume

Trade

Security Type: TRADE

Endpoints under Trade require an API Key and a signature

New Order

POST https://openapi.darkex.com/sapi/v1/order

Rate Limit: 100times/2s

Query Parameters

Name

Type

Description

X-CH-SIGN

string

Sign

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: Either symbol or symbolName must be provided.

Example: BTC/USDT

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/FOK/POST_O NLY/IOC

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': 'LXTUSDT', 'orderId': 150695552109032492,
'orderIdString': '150695552109032492',//Character String Type Order ID 'clientOrderId': '157371322565051',
'transactTime': '1573713225668',
'price': '0.005452',
'origQty': '110',
'executedQty': '0',
'status': 'NEW',
'type': 'LIMIT',
'side': 'SELL'
}

weight(IP/UID): 5

Response:

orderId

long

1506955521090

32492

ID of the order

clientorderId

string

213443

A unique ID of the order.

symbol

string

BTCUSDT

Symbol Name

symbolName

string

BTC/USDT

Currency display name: Either symbol or symbolName must be provided.

Example: BTC/USDT

transactTime

integer

1273774892913

Time the order is placed

price

float

4765.29

Time the order is placed

origQty

float

1.01

Quantity ordered

executedQty

float

1.01

Quantity of orders that has been executed

type

string

LIMIT

Order type

LIMIT,MARKET

side

string

BUY

Order side：

BUY, SELL

Test New Order

POST https://openapi.darkex.com/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

symbolName

String

Currency display name: Either symbol or symbolName must be provided. Example: BTC/USDT

recvwindow

integer

Time window

newClientorderId

String

Unique order ID generated by users to mark their orders

{
// Response
}

weight(IP/UID): 1

Batch Orders

POST https://openapi.darkex.com/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

number

The batch order information can contain a maximum of 10 records.

symbol*

String

Symbol Name. E.g. BTCUSDT

symbolName

String

Currency display name: Either symbol or symbolName must be provided. Example: BTC/USDT

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

Resquest field:

orders

name

type

Example

Description

price

folat

1000

Price

volume

folat

20.1

Quantity

side

String

BUY/SELL

Direction

Resquest

idsString

String

“3213213”

A collection of

order numbers of type String.

ids

integer

2100

Collection of order numbers.

Query Order

GET

https://openapi.darkex.com/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: Either symbol or symbolName must be provided. Example: BTC/USDT

Headers

Name

Type

Description

X-CH-APIKEY

String

Your API-key

X-CH-TS

String

timestampResponses200

X-CH-SIGN

String

Sign

{
'orderId': '499890200602846976',
'clientOrderId': '157432755564968', 'symbol': 'BHTUSDT',
'price': '0.01',
'origQty': '50',
'executedQty': '0',
'avgPrice': '0',
'status': 'NEW',
'type': 'LIMIT',
'side': 'BUY',
'transactTime': '1574327555669'
}

weight(IP/UID): 1

Response:

orderId

long

1506955521090

32492

Order ID (system generated)

clientorderId

string

213443

Order ID (sent by yourself)

symbol

string

BTCUSDT

Currency Pair Name

symbolName

string

BTC/USDT

Currency display name: Either symbol or symbolName must be provided.

Example: BTC/USDT

price

float

4765.29

Order Price

origQty

float

1.01

Number of orders

executedQty

float

1.01

Number of orders already filled

avgPrice

float

4754.24

Average price of orders already filled

type

string

limit

The order

type LIMIT,MAR KET

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_FIL

LED (partially filled), FILLED (fully filled), CANCELED

(cancelled) and REJECTED

(order rejected).POST

transactTime

string

157432755566

9

Order Creation Time

Cancel Order

POST https://openapi.darkex.com/sapi/v1/cancel

Headers

Name

Type

Description

X-CH-APIKEY

String

Your API-key

X-CH-TS

String

timestamp

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

symbolName

String

Currency display name: Either symbol or symbolName must be provided. Example: BTC/USDT

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

weight(IP/UID): 5

Response:

orderId

long

1506955521090

32492

ID of the order

clientorderId

string

213443

Unique ID of the order.

symbol

string

BTCUSDT

Name of the symbol

The state of the order.Possible values include NEW ,

status

string

NEW

PARTIALLY_FIL LED , FILLED , CANCELED , and REJECTED .POS

T

Batch cancel orders

POST https://openapi.darkex.com/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

symbolName

String

The state of the order.Possible values include NEW , PARTIALLY_FILLED , FILLED , CANCELED , and REJECTED .POST

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

weight(IP/UID): 10

Current Open Orders

GET

https://openapi.darkex.com/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 Ord '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

1506955521090

32492

ID of the order

orderIdString

string

" 150695552109

032492"

Character String Type Order ID (Recommended

)

clientorderId

string

213443

Unique ID of the order.

symbol

string

BTCUSDT

Name of the symbol

symbolName

string

BTC/USDT

Currency display name: Either symbol or symbolName must be provided.

Example: BTC/USDT

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,MAR KET

side

string

BUY

The order side

BUY,SELL

status

string

NEW

The state of the order.Possible values include NEW , PARTIALLY_FIL LED , FILLED , CANCELED , and REJECTED .GET

157432755566

Trades

GET

https://openapi.darkex.com/sapi/v1/myTrades

Query Parameters

Name

Type

Description

symbol*

String

Symbol Name. E.g. BTCUSDT

symbolName

String

Currency display name: Either symbol or symbolName must be provided. Example: BTC/USDT

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

Account

Security Type: USER_DATA

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

Account Information

GET

https://openapi.darkex.com/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

field:

balances

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)

Margin

PreviousENUMNextMargin

Last updated