Skip to content

List Orders

Retrieves orders for a specific subaccount, with various filtering options to narrow down the results based on order characteristics.

Method Declaration

Python
async def get_subaccount_orders(
    self,
    address: str,
    subaccount_number: int,
    ticker: Optional[str] = None,
    ticker_type: TickerType = TickerType.PERPETUAL,
    side: Optional[OrderSide] = None,
    status: Optional[OrderStatus] = None,
    type: Optional[OrderType] = None,
    limit: Optional[int] = None,
    good_til_block_before_or_at: Optional[int] = None,
    good_til_block_time_before_or_at: Optional[str] = None,
    return_latest_orders: Optional[bool] = None,
) -> Any
Unification Plan

Parameters

ParameterLocationTypeRequiredDescription
addressqueryAddresstrueThe wallet address that owns the account.
subaccountNumberquerySubaccountNumbertrueThe identifier for the specific subaccount within the wallet address.
limitqueryu32falseMaximum number of asset positions to return in the response.
tickerqueryTickerfalseThe ticker filter.
sidequeryOrderSidefalseThe order side filter.
statusqueryOrderStatusfalseThe order status filter.
typequeryOrderTypefalseThe order type filter.
goodTilBlockBeforeOrAtqueryHeightfalseThe block number filter for orders good until before or at.
goodTilBlockTimeBeforeOrAtqueryDateTime in UTCfalseThe timestamp filter for orders good until before or at.
returnLatestOrdersqueryboolfalseWhether to return only the latest orders.

Response

StatusMeaningSchemaDescription
200OKListOrdersResponseThe orders data.
400Bad RequestThe request was malformed or invalid.
404Not FoundThe subaccount was not found.
API Example

Examples: Guide - List Orders