Skip to navigation
API ReferenceSpread Trading

Place spread order

Place a new order on a spread. You can place orders only if you have sufficient funds in your trading account.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
sprdIdstringRequired

Spread ID, e.g. BTC-USDT_BTC-USDT-SWAP.

sideenumRequired
Order side.
Allowed values:
ordTypeenumRequired

Order type. limit: limit order; post_only: post-only order; ioc: immediate-or-cancel; market: market order.

Allowed values:
szstringRequired
Quantity to buy or sell.
pxstringRequired

Order price. Only applicable to limit, post_only, and ioc orders.

clOrdIdstringOptional

Client Order ID as assigned by the client. A combination of case-sensitive alphanumerics, up to 32 characters.

tagstringOptional

Order tag. A combination of case-sensitive alphanumerics, up to 16 characters.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional