Orders
Get open orders
Get current user all open orders
OK
Orders list
Create order
Open a new order
Order content
Unique client assigned ID for the order
"123454321"
Order flags, allow flag: REDUCE_ONLY
Order Instruction, GTC, IOC or POST_ONLY if empty GTC
Market for which order is created
"BTC-USD-PERP"
Order price
"29500.12"
Order will be created if it is received by API within RecvWindow milliseconds from signature timestamp, minimum is 10 milliseconds
Order side
Order Payload signed with STARK Private Key
Timestamp of order creation, used for signature verification
Size of the order
"1.213"
Self Trade Prevention, EXPIRE_MAKER, EXPIRE_TAKER or EXPIRE_BOTH, if empty EXPIRE_TAKER
Trigger price for stop order
Order type
Created
Account identifier (user's account address)
"0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x"
Average fill price of the order
"26000"
Reason for order cancellation if it was closed by cancel
"NOT_ENOUGH_MARGIN"
Client id passed on order creation
"x1234"
Order creation time
1681493746016
Order flags, allow flag: REDUCE_ONLY
Unique order identifier
"123456"
OrderInstruction (GTC, IOC, POST_ONLY)
"GTC"
Order last update time. No changes once status=CLOSED
1681493746016
Market to which order belongs
"BTC-USD-PERP"
Order price. 0 for MARKET orders
"26000"
Order published to the client time
1681493746016
Order received from the client time
1681493746016
Remaining size of the order
"0"
Unique increasing number (non-sequential) that is assigned to this order update and changes on every order update. Can be used to deduplicate multiple feeds. WebSocket and REST responses use independently generated seq_no per event.
1681471234972000000
Order side
Order size
"0.05"
Order status
Self Trade Prevention mode (EXEPIRE_MAKER, EXPIRE_TAKER, EXPIRE_BOTH)
"EXPIRE_MAKER"
Order signature timestamp
1681493746016
Trigger price for stop order
"26000"
Order type
Cancel all open orders
OK
Get orders
Get current user orders filtered on attributes
OK
The pointer to fetch next set of records (null if there are no records left)
"eyJmaWx0ZXIiMsIm1hcmtlciI6eyJtYXJrZXIiOiIxNjc1NjUwMDE3NDMxMTAxNjk5N="
The pointer to fetch previous set of records (null if there are no records left)
"eyJmaWx0ZXIiOnsiTGltaXQiOjkwfSwidGltZSI6MTY4MTY3OTgzNzk3MTMwOTk1MywibWFya2VyIjp7Im1zMjExMD=="
List of Orders
Get order by client id
Get an order by client id. Only returns orders in OPEN
status.
Client Order Id
OK
Account identifier (user's account address)
"0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x"
Average fill price of the order
"26000"
Reason for order cancellation if it was closed by cancel
"NOT_ENOUGH_MARGIN"
Client id passed on order creation
"x1234"
Order creation time
1681493746016
Order flags, allow flag: REDUCE_ONLY
Unique order identifier
"123456"
OrderInstruction (GTC, IOC, POST_ONLY)
"GTC"
Order last update time. No changes once status=CLOSED
1681493746016
Market to which order belongs
"BTC-USD-PERP"
Order price. 0 for MARKET orders
"26000"
Order published to the client time
1681493746016
Order received from the client time
1681493746016
Remaining size of the order
"0"
Unique increasing number (non-sequential) that is assigned to this order update and changes on every order update. Can be used to deduplicate multiple feeds. WebSocket and REST responses use independently generated seq_no per event.
1681471234972000000
Order side
Order size
"0.05"
Order status
Self Trade Prevention mode (EXEPIRE_MAKER, EXPIRE_TAKER, EXPIRE_BOTH)
"EXPIRE_MAKER"
Order signature timestamp
1681493746016
Trigger price for stop order
"26000"
Order type
Cancel open order by client order id
Client Order Id
No Content
Get order
Get an order by id. Only return orders in OPEN
or NEW
status.
Order Id
OK
Account identifier (user's account address)
"0x4638e3041366aa71720be63e32e53e1223316c7f0d56f7aa617542ed1e7512x"
Average fill price of the order
"26000"
Reason for order cancellation if it was closed by cancel
"NOT_ENOUGH_MARGIN"
Client id passed on order creation
"x1234"
Order creation time
1681493746016
Order flags, allow flag: REDUCE_ONLY
Unique order identifier
"123456"
OrderInstruction (GTC, IOC, POST_ONLY)
"GTC"
Order last update time. No changes once status=CLOSED
1681493746016
Market to which order belongs
"BTC-USD-PERP"
Order price. 0 for MARKET orders
"26000"
Order published to the client time
1681493746016
Order received from the client time
1681493746016
Remaining size of the order
"0"
Unique increasing number (non-sequential) that is assigned to this order update and changes on every order update. Can be used to deduplicate multiple feeds. WebSocket and REST responses use independently generated seq_no per event.
1681471234972000000
Order side
Order size
"0.05"
Order status
Self Trade Prevention mode (EXEPIRE_MAKER, EXPIRE_TAKER, EXPIRE_BOTH)
"EXPIRE_MAKER"
Order signature timestamp
1681493746016
Trigger price for stop order
"26000"
Order type
Cancel order
Order Id
No Content
Create batch of orders
[Experimental] Place a batch of orders
- Valid batch size is between 1-10 order(s)
- If basic validation(including signature) fails - all orders will be rejected.
- Orders are queued for risk checking independently and failure of one order doesn't affect processing of another order.
Order content
Unique client assigned ID for the order
"123454321"
Order flags, allow flag: REDUCE_ONLY
Order Instruction, GTC, IOC or POST_ONLY if empty GTC
Market for which order is created
"BTC-USD-PERP"
Order price
"29500.12"
Order will be created if it is received by API within RecvWindow milliseconds from signature timestamp, minimum is 10 milliseconds
Order side
Order Payload signed with STARK Private Key
Timestamp of order creation, used for signature verification
Size of the order
"1.213"
Self Trade Prevention, EXPIRE_MAKER, EXPIRE_TAKER or EXPIRE_BOTH, if empty EXPIRE_TAKER
Trigger price for stop order
Order type
Created
Last updated