Debug a new order Required minimum session key permission level is read_only
Parameters
amountstringrequired Order amount in units of the base
directionstringrequired Order direction enum buysell
instrument_namestringrequired Instrument name
limit_pricestringrequired Limit price in quote currency. This field is still required for market orders because it is a component of the signature. However, market orders will not leave a resting order in the book in case of a partial fill.
max_feestringrequired Max fee per unit of volume, denominated in units of the quote currency (usually USDC).Order will be rejected if the supplied max fee is below the estimated fee for this order.
nonceintegerrequired Unique nonce defined as (UTC_timestamp in ms)(random_number_up_to_3_digits) (e.g. 1695836058725001, where 001 is the random number).Note, using a random number beyond 3 digits will cause JSON serialization to fail.
signaturestringrequired Ethereum signature of the order
signature_expiry_secintegerrequired Unix timestamp in seconds. Order signature becomes invalid after this time, and the system will cancel the order.Expiry MUST be at least 5 min from now.
signerstringrequired Owner wallet address or registered session key that signed order
subaccount_idintegerrequired Subaccount ID
is_atomic_signingboolean Used by vaults to determine whether the signature is an EIP-1271 signature.
labelstring Optional user-defined label for the order
mmpboolean Whether the order is tagged for market maker protections (default false)
order_typestring Order type: - limit: limit order (default) - market: market order, note that limit_price is still required for market orders, but unfilled order portion will be marked as cancelled enum limitmarket
reduce_onlyboolean If true, the order will not be able to increase position's size (default false). If the order amount exceeds available position size, the order will be filled up to the position size and the remainder will be cancelled. This flag is only supported for market orders or non-resting limit orders (IOC or FOK)
referral_codestring Optional referral code for the order
reject_timestampinteger UTC timestamp in ms, if provided the matching engine will reject the order with an error if reject_timestamp < server_time. Note that the timestamp must be consistent with the server time: use public/get_time method to obtain current server time.
time_in_forcestring Time in force behaviour: - gtc: good til cancelled (default) - post_only: a limit order that will be rejected if it crosses any order in the book, i.e. acts as a taker order - fok: fill or kill, will be rejected if it is not fully filled - ioc: immediate or cancel, fill at best bid/ask (market) or at limit price (limit), the unfilled portion is cancelled Note that the order will still expire on the signature_expiry_sec timestamp. enum gtcpost_onlyfokioc
trigger_pricestring (Required for trigger orders) "index" or "mark" price to trigger order at
trigger_price_typestring (Required for trigger orders) Trigger with "mark" price as "index" price type not supported yet. enum markindex
trigger_typestring (Required for trigger orders) "stoploss" or "takeprofit" enum stoplosstakeprofit
Response
idstring or integerrequired
resultobjectrequired
result.action_hashstringrequired Keccak hashed action data
result.encoded_datastringrequired ABI encoded order data