Order Details

This endpoint retrieves the detailed information of a specific order. There are two ways to query order details:

1. By Order Number (Recommended): Query using the system-generated order_no
2. By Reference ID: Query using a custom reference_id

---

Query by Order Number (Recommended)

Retrieve order details using the system-generated order number. This is the recommended query method.

HTTP Request

GET /trade/v1/orders/{order_no}

Request Parameters

Name	Type	Required	Description
order_no	STRING	Yes	Internal order number generated by the system.

Example cURL Request

curl --location --request GET '{$base_url}/trade/v1/orders/22000000023' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'X-API-Signature: YOUR_GENERATED_SIGNATURE' \
--header 'X-API-Timestamp: 1746774142003'

---

Query by Reference ID

Retrieve order details using a custom client-defined reference ID.

⚠️ Important Notice: The reference_id is a user-defined identifier. Users are responsible for ensuring its uniqueness. If duplicate reference_id values exist, multiple orders may be returned, and users bear full responsibility for the consequences of such duplicates.

HTTP Request

GET /trade/v1/orders/byref/{reference_id}

Request Parameters

Name	Type	Required	Description
reference_id	STRING	Yes	Custom client-defined identifier for the order.

Example cURL Request

curl --location --request GET '{$base_url}/trade/v1/orders/byref/be65dd22898b44158d34ad1014148d90' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'X-API-Signature: YOUR_GENERATED_SIGNATURE' \
--header 'X-API-Timestamp: 1746774142003'

---

Response Format

Order Object Fields

Both query methods return order objects with the following structure:

Field	Type	Description
market	ENUM	Market code (e.g., hkex, nasdaq)
order_type	ENUM	Order type (e.g., limit, enhanced limit)
symbol	STRING	Product code
name	STRING	Product name
order_side	ENUM	Order direction: buy or sell
account_code	STRING	Trading account identifier
order_no	STRING	System-generated internal order number
order_status	ENUM	Current order status
price	DECIMAL	Order price
qty	DECIMAL	Total order quantity
outstand_qty	DECIMAL	Remaining unfilled quantity
execute_qty	DECIMAL	Executed quantity
execute_price	DECIMAL	Average executed price
execute_amount	DECIMAL	Total executed value
charge	DECIMAL	Transaction fee
charge_base_currency	STRING	Currency code for the transaction fee
charge_details	ARRAY<charge_detail>	charge. See the charge_detail field description for more information.
base_currency	STRING	Currency of the trade
trigger_price	DECIMAL	Trigger price (if applicable)
reference_id	STRING	Custom client-defined ID
portfolio_id	STRING	Portfolio ID (which is a user-defined external id )
reject_reason	STRING	Reason for rejection (if any)
currency_conversion	currency_conversion	Currency conversion information. See the currency_conversion field description for more information.
update_time	LONG	Last update time (UNIX timestamp)
create_time	LONG	Order creation time (UNIX timestamp)

Field Description

Field	Type	Description
code	STRING	Fee item code, e.g., us_trading_commission
amount	DECIMAL	Amount of the specific fee item
currency	STRING	Currency of the fee

Fee Details by Market

Code	Fee Item
us_trading_commission	Commission
us_platform_fee	Platform Usage Fee
us_settlement_and_delivery_cost	Settlement Fee
us_sec_membership_fee	Securities and Futures Commission (SFC) levy
us_external_agency_fee_and_trading_activity_fee	Transaction Activity Fee
us_accounting_tracks_fund_fees	Consolidated Audit Trail Fee
us_option_regulation_fees	Options regulatory fee

---

Query by Order Number Response

Returns a single order object.

Single Order Response Example (Query by Order Number)

{
  "code": 0,
  "data": {
    "market": "usex",
    "order_type": "limit_order",
    "symbol": "AAPL",
    "name": "Apple Inc.",
    "order_side": "buy",
    "account_code": "80112345",
    "order_no": "25000000033",
    "order_status": "filled",
    "price": 200.00,
    "qty": 100,
    "outstand_qty": 0,
    "execute_qty": 100,
    "execute_price": 200.00,
    "execute_amount": 20000.00,
    "charge": 2.04,
    "charge_base_currency": "USD",
    "charge_details": [
      {
        "code": "us_trading_commission",
        "amount": 1.00,
        "currency": "USD"
      },
      {
        "code": "us_platform_fee",
        "amount": 1.00,
        "currency": "USD"
      },
      {
        "code": "us_settlement_and_delivery_cost",
        "amount": 0.03,
        "currency": "USD"
      },
      {
        "code": "us_accounting_tracks_fund_fees",
        "amount": 0.01,
        "currency": "USD"
      },
      {
        "code": "us_sec_membership_fee",
        "amount": 0,
        "currency": "USD"
      },
      {
        "code": "us_external_agency_fee_and_trading_activity_fee",
        "amount": 0,
        "currency": "USD"
      },
      {
        "code": "us_option_regulation_fees",
        "amount": 0,
        "currency": "USD"
      }
    ],
    "base_currency": "USD",
    "reference_id": "client_ref_001",
    "portfolio_id": "portfolio_123",
    "reject_reason": "",
    "currency_conversion": {
      "base_currency": "USDT",
      "target_currency": "USD",
      "base_amount": 20097.427919,
      "target_amount": 20002.04,
      "rate": 0.995253725
    },
    "update_time": 1746775317,
    "create_time": 1746775257
  }
}

Query by Reference ID Response

Returns an array of order objects directly in the data field. Multiple orders may be returned if duplicate reference_id values exist.

Response Structure

The response contains an array of order objects directly in the data field. Each order object contains the same fields as described in the Order Object Fields section above.

---

Multiple Orders Response Example (Query by Reference ID)

{
  "code": 0,
  "data": {
    "reference_id": "client_ref_001",
    "orders": [
      {
        "market": "hkex",
        "order_type": "limit_order",
        "symbol": "00700",
        "name": "TENCENT",
        "order_side": "buy",
        "account_code": "80114138",
        "order_no": "22000000022",
        "order_status": "filled",
        "price": 423.83,
        "qty": 1000,
        "outstand_qty": 0,
        "execute_qty": 1000,
        "execute_price": 423.83,
        "execute_amount": 423830.0,
        "charge": 20.03,
        "charge_base_currency": "HKD",
        "charge_details": [
          {
            "code": "hk_trading_commission",
            "amount": 15.0,
            "currency": "HKD"
          },
          {
            "code": "hk_platform_fee",
            "amount": 5.03,
            "currency": "HKD"
          }
        ],
        "base_currency": "HKD",
        "reference_id": "client_ref_001",
        "portfolio_id": "portfolio_123",
        "reject_reason": "",
        "currency_conversion": {
          "base_currency": "USDT",
          "target_currency": "HKD",
          "base_amount": 53125.03,
          "target_amount": 423850.03,
          "rate": 7.978
        },
        "update_time": 1746775317,
        "create_time": 1746775257
      },
      {
        "market": "hkex",
        "order_type": "limit_order",
        "symbol": "00700",
        "name": "TENCENT",
        "order_side": "sell",
        "account_code": "80114138",
        "order_no": "22000000023",
        "order_status": "pending",
        "price": 425.0,
        "qty": 500,
        "outstand_qty": 500,
        "execute_qty": 0,
        "execute_price": 0,
        "execute_amount": 0,
        "charge": 0,
        "charge_base_currency": "HKD",
        "charge_details": [],
        "base_currency": "HKD",
        "reference_id": "client_ref_001",
        "portfolio_id": "portfolio_123",
        "reject_reason": "",
        "currency_conversion": {
          "base_currency": "USDT",
          "target_currency": "HKD",
          "rate": 7.978
        },
        "update_time": 1746775400,
        "create_time": 1746775400
      }
    ]
  }
}

---

Error Response Example

{
  "code": 500,
  "message": "Internal Service Error",
  "details": ""
}

See the Error Code Reference for full error descriptions.