Sign in

v1

latestOpenAPI 3.0.32026-07-14101828.2 KB
Trade

/trade/standbyOrders

Retrieve details of orders in standby for a specific account.

get/api/v1/trade/standbyOrders

Query parameters

symbolstring

Filter by specific perpetual symbol (optional)

Response

Orders in standby retrieved successfully.

orderHashstring required

The Order Hash, which is the default way to uniquely identify an order in the system

clientOrderIdstring

The Client Order ID, which is used a unique identifier for an order, provided by the client, in case of proprietary order management systems

symbolstring required

The market symbol

accountAddressstring required

The account address of the order. May be an account user is authorized for.

signerAddressstring required

The signer address of the order. May be an account user is authorized for.

priceE9string required

The price in base e9 of the asset to be traded. Should always be a number

quantityE9string required

The quantity in base e9 of the asset to be traded. Should always be a number

side'LONG' | 'SHORT' | 'UNSPECIFIED' required

Side of the order

leverageE9string required

The leverage in base e9 of the order to be traded. Should always be a number

isIsolatedboolean required

Is this order isolated or cross margin. Note market must be set to the same mode.

saltstring required

The random generated SALT. Should always be a number

expiresAtMillisinteger required

Unix timestamp in millis at which order will expire. Defaults to 1 month for LIMIT orders if not provided

signedAtMillisinteger required

The timestamp in millis at which the request was signed

type'LIMIT' | 'MARKET' | 'STOP_LIMIT' | 'STOP_MARKET' | 'LIQUIDATION' | 'STOP_LOSS_MARKET' | 'TAKE_PROFIT_MARKET' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT_LIMIT' | 'BANKRUPTCY_LIQUIDATION' | 'UNSPECIFIED' required

The type of order. (BANKRUPTCY_LIQUIDATION is deprecated)

reduceOnlyboolean required

Is this order to only reduce a position? Default false

postOnlyboolean required

If set to TRUE, the order can only be a maker order

timeInForce'GTT' | 'IOC' | 'FOK' | 'UNSPECIFIED' required

The time-in-force policy for the order. By default, all orders are GTT. UNSPECIFIED is set to default.

GTT: Good Til Time

IOC: Immediate Or Cancel

FOK: Fill Or Kill

triggerPriceE9string

Trigger price in base e9 for stop orders. This should always be a number

filledQuantityE9string required

The quantity in base e9 of the asset currently filled. This should always be a number

status'STANDBY' | 'OPEN' | 'PARTIALLY_FILLED_OPEN' | 'PARTIALLY_FILLED_CANCELED' | 'FILLED' | 'CANCELLED' | 'EXPIRED' | 'PARTIALLY_FILLED_EXPIRED' | 'UNSPECIFIED' required

The current status of the order.

selfTradePreventionType'TAKER' | 'MAKER' | 'BOTH' | 'UNSPECIFIED' required

The strategy used to resolve self trades.

TAKER: On a self trade, the taker order will be cancelled

MAKER: On a self trade, the maker order will be cancelled

BOTH: On a self trade, both the taker and the maker order will be cancelled

UNSPECIFIED: set to default value

orderTimeAtMillisinteger required

The timestamp in millis when the order was opened

updatedAtMillisinteger required

The timestamp in millis that this order was last updated (including status updates)

Example response

[
  {
    "clientOrderId": "company1_order1",
    "salt": "123335432",
    "expiresAtMillis": 123456734567,
    "signedAtMillis": 1234567856
  }
]