Today Orders
This API is used to get today order or get order by order id.
SDK Links
Python |
Rust |
Go |
Node.js |
Java |
C++ |
Request
| HTTP Method | GET |
| HTTP URL | /v1/trade/order/today |
Parameters
Content-Type: application/json; charset=utf-8
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | NO | Stock symbol, use ticker.region format, example: AAPL.US |
| status | string[] | NO | Order status example: status=FilledStatus&status=NewStatus |
| side | string | NO | Order side Enum Value: BuySell |
| market | string | NO | Market Enum Value: US - United States of America MarketHK - Hong Kong Market |
| order_id | string | NO | Order ID, example: 701276261045858304 |
| is_attached | bool | NO | Whether order_id refers to an attached order, returns the attached order information if true |
Request Example
from longbridge.openapi import TradeContext, Config, OrderStatus, OrderSide, Market, OAuthBuilder
oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = TradeContext(config)
resp = ctx.today_orders(
symbol = "700.HK",
status = [OrderStatus.Filled, OrderStatus.New],
side = OrderSide.Buy,
market = Market.HK,
)
print(resp)import asyncio
from longbridge.openapi import AsyncTradeContext, Config, OrderStatus, OrderSide, Market, OAuthBuilder
async def main() -> None:
oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = AsyncTradeContext.create(config)
resp = await ctx.today_orders(
symbol = "700.HK",
status = [OrderStatus.Filled, OrderStatus.New],
side = OrderSide.Buy,
market = Market.HK,
)
print(resp)
if __name__ == "__main__":
asyncio.run(main())const { Config, TradeContext, OAuth } = require('longbridge')
async function main() {
const oauth = await OAuth.build('your-client-id', (_, url) => {
console.log('Open this URL to authorize: ' + url)
})
const config = Config.fromOAuth(oauth)
const ctx = TradeContext.new(config)
const resp = await ctx.todayOrders({})
console.log(resp)
}
main().catch(console.error)import com.longbridge.*;
import com.longbridge.trade.*;
class Main {
public static void main(String[] args) throws Exception {
try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get();
Config config = Config.fromOAuth(oauth);
TradeContext ctx = TradeContext.create(config)) {
Order[] resp = ctx.getTodayOrders(null).get();
for (Order o : resp) System.out.println(o);
}
}
}use std::sync::Arc;
use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config};
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open this URL to authorize: {url}")).await?;
let config = Arc::new(Config::from_oauth(oauth));
let (ctx, _) = TradeContext::new(config);
let resp = ctx.today_orders(None).await?;
println!("{:?}", resp);
Ok(())
}#include <iostream>
#include <longbridge.hpp>
#ifdef WIN32
#include <windows.h>
#endif
using namespace longbridge;
using namespace longbridge::trade;
static void
run(const OAuth& oauth)
{
Config config = Config::from_oauth(oauth);
TradeContext ctx = TradeContext::create(config);
ctx.today_orders(std::nullopt, [](auto res) {
if (!res) { std::cout << "failed" << std::endl; return; }
for (const auto& o : *res) std::cout << o.order_id << std::endl;
});
}
int main(int argc, char const* argv[]) {
#ifdef WIN32
SetConsoleOutputCP(CP_UTF8);
#endif
const std::string client_id = "your-client-id";
OAuthBuilder(client_id).build(
[](const std::string& url) {
std::cout << "Open this URL to authorize: " << url << std::endl;
},
[](auto res) {
if (!res) {
std::cout << "authorization failed: " << *res.status().message() << std::endl;
return;
}
run(*res);
});
std::cin.get();
return 0;
}package main
import (
"context"
"fmt"
"log"
"github.com/longbridge/openapi-go/config"
"github.com/longbridge/openapi-go/oauth"
"github.com/longbridge/openapi-go/trade"
)
func main() {
o := oauth.New("your-client-id").
OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) })
if err := o.Build(context.Background()); err != nil {
log.Fatal(err)
}
conf, err := config.New(config.WithOAuthClient(o))
if err != nil {
log.Fatal(err)
}
tctx, err := trade.NewFromCfg(conf)
if err != nil {
log.Fatal(err)
}
defer tctx.Close()
orders, err := tctx.TodayOrders(context.Background(), &trade.GetTodayOrders{})
if err != nil {
log.Fatal(err)
}
for _, o := range orders {
fmt.Println(o.OrderId)
}
}Response
Response Headers
- Content-Type: application/json
Response Example
{
"code": 0,
"message": "success",
"data": {
"orders": [
{
"currency": "HKD",
"executed_price": "0.000",
"executed_quantity": "0",
"expire_date": "",
"last_done": "",
"limit_offset": "",
"msg": "",
"order_id": "706388312699592704",
"order_type": "ELO",
"outside_rth": "UnknownOutsideRth",
"price": "11.900",
"quantity": "200",
"side": "Buy",
"status": "RejectedStatus",
"stock_name": "Bank of East Asia Ltd/The",
"submitted_at": "1651644897",
"symbol": "23.HK",
"tag": "Normal",
"time_in_force": "Day",
"trailing_amount": "",
"trailing_percent": "",
"trigger_at": "0",
"trigger_price": "",
"trigger_status": "NOT_USED",
"updated_at": "1651644898",
"remark": "",
"limit_depth_level": 0,
"monitor_price": "",
"trigger_count": 1,
"attached_orders": [
{
"order_id": "706388312699592705",
"attached_type_display": 2,
"trigger_price": "10.500",
"quantity": "200",
"executed_qty": "0",
"status": "NewStatus",
"updated_at": "1651644898",
"withdrawn": false,
"gtd": "",
"time_in_force": "Day",
"counter_id": "",
"trigger_status": 0,
"executed_amount": "0",
"tag": 0,
"submitted_at": "1651644897",
"executed_price": "0.000",
"force_only_rth": "RTH_ONLY",
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
}
],
"multi_leg": {
"strategy": "2",
"strategy_name": "Vertical spread",
"multileg_id": "Spread_QQQ20260731C764/767",
"code": "QQQ 260731 764/767 Vertical spread",
"legs": [
{
"symbol": "QQQ260731C764000.US",
"side": "Buy",
"position": "LONG",
"ratio_quantity": "1",
"strike_price": "764",
"expire_date": "20260731",
"contract_direction": "C"
},
{
"symbol": "QQQ260731C767000.US",
"side": "Sell",
"position": "SHORT",
"ratio_quantity": "1",
"strike_price": "767",
"expire_date": "20260731",
"contract_direction": "C"
}
]
}
}
]
}
}
Response Status
| Status | Description | Schema |
|---|---|---|
| 200 | Get Today Orders Success | today_orders_rsp |
| 400 | The query failed with an error in the request parameter. | None |
Schemas
today_orders_rsp
| Name | Type | Required | Description |
|---|---|---|---|
| orders | object[] | false | Order Detail |
| ∟ order_id | string | true | Order ID |
| ∟ status | string | true | Order Status |
| ∟ stock_name | string | true | Stock Name |
| ∟ quantity | string | true | Submitted Quantity |
| ∟ executed_quantity | string | true | Executed Quantity. when the order is not filled, value is 0 |
| ∟ price | string | true | Submitted Price. when market condition order is not triggered, value is empty string |
| ∟ executed_price | string | true | Executed Price. when the order is not filled, value is 0 |
| ∟ submitted_at | string | true | Submitted Time |
| ∟ side | string | true | Order Side Enum Value: BuySell |
| ∟ symbol | string | true | Stock symbol, use ticker.region format, example: AAPL.US |
| ∟ order_type | string | true | Order Type |
| ∟ last_done | string | true | Last done. when the order is not filled, value is empty string |
| ∟ trigger_price | string | true | LIT / MIT Order Trigger Price.When the order is not LIT / MIT order, value is empty string |
| ∟ msg | string | true | Rejected message or remark, default value is empty string. |
| ∟ tag | string | true | Order tag Enum Value Normal - Normal OrderGtc - Long term OrderGrey - Grey Order |
| ∟ time_in_force | string | true | Time in force Type Enum Value: Day - Day OrderGTC - Good Til Canceled OrderGTD - Good Til Date Order |
| ∟ expire_date | string | true | Long term order expire date, format: YYYY-MM-DD, example: 2022-12-05.When not a long term order, default value is empty string |
| ∟ updated_at | string | true | Last updated time, formatted as a timestamp (second) |
| ∟ trigger_at | string | true | Conditional order trigger time. formatted as a timestamp (second) |
| ∟ trailing_amount | string | true | TSLPAMT order trailing amount.When the order is not TSLPAMT order, value is empty string |
| ∟ trailing_percent | string | true | TSLPPCT order trailing percent.When the order is not TSLPPCT order, value is empty string |
| ∟ limit_offset | string | true | TSLPAMT / TSLPPCT order limit offset amount.When the order is not TSLPAMT / TSLPPCT order, value is empty string |
| ∟ trigger_status | string | true | Conditional Order Trigger Status When an order is not a conditional order or a conditional order is not triggered, the trigger status is NOT_USED Enum Value NOT_USEDDEACTIVEACTIVERELEASED |
| ∟ currency | string | true | Currency |
| ∟ outside_rth | string | true | Enable or disable outside regular trading hours Default is UnknownOutsideRth when the order is not a US stockEnum Value: RTH_ONLY - Regular trading hour onlyANY_TIME - Any timeOVERNIGHT - Overnight” |
| ∟ remark | string | true | Remark |
| ∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level |
| ∟ monitor_price | string | true | Monitoring price |
| ∟ trigger_count | int32 | true | Number of triggers |
| ∟ attached_orders | object[] | false | List of attached order details |
| ∟∟ order_id | string | true | Attached order ID |
| ∟∟ attached_type_display | int32 | true | Attached order type. Enum Value: 1 - Take Profit2 - Stop Loss |
| ∟∟ trigger_price | string | true | Trigger price |
| ∟∟ quantity | string | true | Order quantity |
| ∟∟ executed_qty | string | true | Executed quantity |
| ∟∟ status | string | true | Order status |
| ∟∟ updated_at | string | true | Last updated time, formatted as a timestamp (second) |
| ∟∟ withdrawn | boolean | true | Whether the order has been withdrawn |
| ∟∟ gtd | string | true | GTD expiration date, format: YYYY-MM-DD |
| ∟∟ time_in_force | string | true | Time in force Type Enum Value: Day - Day OrderGTC - Good Til Canceled OrderGTD - Good Til Date Order |
| ∟∟ counter_id | string | true | Counter order ID |
| ∟∟ trigger_status | int32 | true | Conditional order trigger status after the attached order is activated.0 - Not activated1 - Monitoring2 - Cancelled4 - Triggered |
| ∟∟ executed_amount | string | true | Executed amount |
| ∟∟ tag | int32 | true | Order tag |
| ∟∟ submitted_at | string | true | Submitted time, formatted as a timestamp (second) |
| ∟∟ executed_price | string | true | Executed price |
| ∟∟ force_only_rth | string | true | Whether execution is restricted to regular trading hours only |
| ∟∟ reviewed | boolean | true | Whether the order has been reviewed |
| ∟∟ activate_order_type | string | true | Order type submitted after triggering, e.g. LIT (limit-if-touched) or MIT (market-if-touched) |
| ∟∟ activate_rth | string | true | Whether the order submitted after triggering allows pre/post market trading |
| ∟∟ submit_price | string | true | Submitted price |
| ∟ multi_leg | object | false | Multi-leg strategy information. Only returned for multi-leg option combination orders; otherwise not returned. |
| ∟∟ strategy | string | false | Multi-leg strategy Enum Value: 0 - CoveredCall (Covered stock)1 - CoveredPut (Covered stock)2 - VerticalCallSpread (Vertical spread)3 - VerticalPutSpread (Vertical spread)4 - Collar5 - Straddle6 - Strangle |
| ∟∟ strategy_name | string | false | Strategy name |
| ∟∟ multileg_id | string | false | Multi-leg combination ID |
| ∟∟ code | string | false | Multi-leg combination code |
| ∟∟ legs | object[] | false | Legs of the combination order |
| ∟∟∟ symbol | string | false | Option symbol, use ticker.region format, example: QQQ260731C764000.US |
| ∟∟∟ side | string | false | Order Side Enum Value: BuySell |
| ∟∟∟ position | string | false | Position direction Enum Value: LONGSHORT |
| ∟∟∟ ratio_quantity | string | false | Leg ratio quantity |
| ∟∟∟ strike_price | string | false | Strike price |
| ∟∟∟ expire_date | string | false | Option expiry date, format: YYYYMMDD |
| ∟∟∟ contract_direction | string | false | Contract type Enum Value: C - CallP - Put |