Query Opened Orders

Interface Description

• Function description: Paging query pending orders.

• Applicable objects: Customers who connect to Webull through the OpenApi development platform.

• Request URL: /trade/orders/list-open

• Request method:: GET

• Frequency limit: The calling frequency of each AppId is limited to 2 times in 2 seconds.

Request Parameters

Parameter	Type	Required fields	Description	Example value
account_id	String	Yes	Account ID	20150320010101001
page_size	int	Yes	Number of entries per page: default value is 10, and maximum value is 100. Integers can be filled.	10
last_client_order_id	String	No	The 3rd party order ID is not passed, and the default check is conducted on the first page.	2022021819071234

Response Parameter

Parameter	Type	Required fields	Description	Example value
has_next	Boolean	Yes	Is there a next page	true
orders	[ ]Order	No	Order List	Reference sample code

Order:

Field	Type	Description
account_id	String	Account ID
category	String	Category:referring to the data dictionary
currency	String	Currency, value reference dictionary value: Currency, such as: HKD
client_order_id	String	The ID passed in when the customer places an order
extended_hours_trading	Boolean	Whether to support pre-market and post-market
filled_price	String	Average trading price
filled_qty	String	The number of transactions
instrument_id	String	Symbol ID
last_filled_time	String	Last trade time: UTC time. Time format: yyyy-MM-ddTHH:mm:ss.SSSZ. Only traded orders have value
limit_price	String	Limit price: it has values if it is a limit order, or a stop limit order.
order_id	String	Order ID
order_status	String	Order status: referring to OrderStatus in the data dictionary.
order_type	String	Order type: referring to OrderType in the data dictionary
place_time	String	Order time: UTC time. Time format: yyyy-MM-ddTHH:mm:ss.SSSZ
qty	String	Quantity
side	String	Buy and sell directions: referring to OrderSide in the data dictionary.
stop_price	String	Stop loss price: it has values if the order type is stop loss order or stop loss limit order.
symbol	String	Stock code, eg: 01810
short_name	String	Stock name, such as: Xiaomi Group-W
tif	String	Order validity period: referring toOrderTIF in the data dictionary.
trailing_stop_step	String	Trailing spread: it has value when the order type is trailing stop order.
trailing_type	String	Trailing type, TrailingType only has value when the order type is trailing stop order

Request Example

Python

from webullsdktrade.api import API
from webullsdkcore.client import ApiClient
from webullsdkcore.common.region import Region

api_client = ApiClient(your_app_key, your_app_secret, Region.HK.value)
api = API(api_client)
response = api.order.list_open_orders(account_id, page_size, last_client_order_id)
if response.status_code == 200:
    open_orders = response.json()

Java

HttpApiConfig apiConfig = HttpApiConfig.builder()
        .appKey(Env.APP_KEY)
        .appSecret(Env.APP_SECRET)
        .regionId(Region.hk.name())
        .build();
TradeApiService apiService = new TradeHttpApiService(apiConfig);
Orders openedOrders = apiService.getOpenedOrders(accountId, pageSize, lastClientOrderId);

Response Example

{
  "hasNext": false,
  "pageSize": 10,
  "orders": [
    {
      "account_id": "7THGGKDQ5SRN2SFORREFD54DO9",
      "category": "US_STOCK",
      "currency": "USD",
      "place_time": "2022-03-14T01:43:22.000+0000",
      "order_id": "U9GAUCICTSFPDORF43TGI33QAB",
      "instrument_id": "913256135",
      "client_order_id": "01916116290117123190",
      "side": "BUY",
      "tif": "DAY",
      "order_type": "LIMIT",
      "limit_price": "385.0000000000",
      "qty": "1.0000000000",
      "extended_hours_trading": false,
      "order_status": "SUBMITTED",
      "filled_qty": "0E-10",
      "symbol": "AAPL",
      "short_name": "APPLE INC"
    }
  ]
}

Exception Example

{
  "error_code": "INVALID_PARAMETER",
  "message": "page_size range must be [10,100]"
}