Query Day Orders
Interface Description
Function description: Query all orders of the day, the number of data returned each time can be specified, the maximum value is 100.
URL: /trade/orders/list-today
Method: GET
Rate limit: The calling frequency of each App ID is limited to 10 times in 30 seconds.
Request Parameters
| Parameter | Type | Required fields | Description | Example value |
|---|---|---|---|---|
| account_id | String | Yes | Account ID | ace133122a |
| page_size | int | Yes | For the number of entries per page, the default value is 10, and the maximum value is 100. Integers can be filled. | 10 |
| last_client_order_id | String | No | Webull Pay Order ID is not passed, and the default check is conducted on the first page. | CO0358O5QRRC83E0KHK8G8000000 |
Response Parameter
| Parameter | Type | Required fields | Description | Example value |
|---|---|---|---|---|
| hasNext | 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 |
| instrument_id | String | Instrument ID |
| symbol | String | Crypto code, eg: BTCUSD |
| category | String | Security type, enumeration. Reference: Category, Currently only CRYPTO is supported. |
| short_name | String | Crypto short name, eg: BTC |
| currency | String | Currency,eg: USD |
| client_order_id | String | Webull Pay Order ID |
| entrust_type | String | Entrust type: AMT (by amount), QTY (by quantity) |
| place_amt | String | place amount |
| place_qty | String | place quantity |
| filled_price | String | Average transaction price |
| filled_qty | String | The number of transactions |
| filled_amt | String | The amount of transactions |
| filled_time | String | Transaction time, EST time, time format: yyyy-MM-dd HH:mm:ss Z (Only the completed orders have value) |
| limit_price | String | Limit price: it only has values if the order type is a limit order or stop limit order. |
| stop_price | String | Stop loss price: it only has values when order type is stop loss order or stop loss limit. |
| order_status | String | For order status, please refer to OrderStatus in the data dictionary |
| order_type | String | For order type, please refer to OrderType in the data dictionary |
| create_time | String | Order time: EST time. Time format: yyyy-MM-dd HH:mm:ss Z |
| side | String | For buy and sell directions, please refer to OrderSide in the data dictionary |
| tif | String | For order validity period, please refer to OrderTIF in the data dictionary |
| update_time | String | Update time: EST time. Time format: yyyy-MM-dd HH:mm:ss Z |
Request Example
- Python
- Java
from webullpaysdktrade.api import API
from webullpaysdkcore.client import ApiClient
from webullpaysdkcore.common.region import Region
your_app_key = "<your_app_key>"
your_app_secret = "<your_app_secret>"
account_id = "account_id"
page_size = 10
last_client_order_id = ""
api_client = ApiClient(your_app_key, your_app_secret, Region.US.value)
api = API(api_client)
response = api.order.list_today_orders(account_id, page_size, last_client_order_id)
if response.status_code == 200:
today_orders = response.json()
print(today_orders)
HttpApiConfig apiConfig = HttpApiConfig.builder()
.appKey("<your_app_key>")
.appSecret("<your_app_secret>")
.regionId(Region.us.name())
.build();
TradeApiService apiService = new TradeHttpApiService(apiConfig);
Orders<SimpleOrder> dayOrders = apiService.getDayOrders("accountId", 10, "");
//print
System.out.println(JsonSerializer.toJson(dayOrders, SerializeConfig.builder().underscoresToCamel(true).build()));
Response Example
{
"hasNext": false,
"orders": [
{
"symbol": "BCHUSD",
"currency": "USD",
"account_id": "co393b0b701",
"category": "CRYPTO",
"instrument_id": "950160803",
"short_name": "BCH",
"client_order_id": "CO0357EPSI4083E0KHKDHS000000",
"order_status": "SUBMITTED",
"order_type": "MKT",
"side": "BUY",
"tif": "IOC",
"entrust_type": "CASH",
"place_amt": "10.00",
"place_qty": "0",
"filled_qty": "0",
"filled_amt": "0.00",
"create_time": "2025-02-10 02:42:20 EST",
"update_time": "2025-02-10 02:42:21 EST"
}
]
}
Exception Example
{
"error_code": "INVALID_PARAMETER",
"message": "page_size range must be [10,100]"
}