跳轉到內容

訂單詳情

此端點可查詢指定訂單的詳細資訊。有兩種查詢訂單詳情的方式:

  1. 按訂單編號查詢(推薦):使用系統產生的 order_no 查詢
  2. 按參考編號查詢:使用客戶自訂的 reference_id 查詢

按訂單編號查詢(推薦)

使用系統產生的訂單編號查詢訂單詳情。這是推薦的查詢方式。

HTTP 請求

bash
GET /trade/v1/orders/{order_no}

請求參數

參數名稱類型是否必填說明
order_noSTRING系統產生的內部訂單編號

cURL 請求範例

bash
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'

按參考編號查詢

使用客戶自訂的參考編號查詢訂單詳情。

⚠️ 重要提醒reference_id 是用戶自訂的識別碼。用戶需自行確保其唯一性。如果存在重複的 reference_id 值,可能會返回多筆訂單記錄,用戶需自行承擔重複識別碼所產生的後果。

HTTP 請求

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

請求參數

參數名稱類型是否必填說明
reference_idSTRING客戶自訂的訂單識別碼

cURL 請求範例

bash
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'

回應格式

訂單物件欄位

兩種查詢方式都返回具有以下結構的訂單物件:

訂單物件欄位說明

欄位名稱類型說明
marketENUM市場代碼(如 hkex, nasdaq
order_typeENUM訂單類型(如限價單、增強限價單)
symbolSTRING股票代碼
nameSTRING股票名稱
order_sideENUM買賣方向:buysell
account_codeSTRING交易帳戶識別碼
order_noSTRING系統產生的內部訂單編號
order_statusENUM當前訂單狀態
priceDECIMAL下單價格
qtyDECIMAL下單總數量
outstand_qtyDECIMAL尚未成交的剩餘數量
execute_qtyDECIMAL已成交數量
execute_priceDECIMAL平均成交價格
execute_amountDECIMAL已成交總金額
chargeDECIMAL交易手續費
charge_base_currencySTRING手續費幣別
charge_detailsARRAY<charge_detail>手續費詳情,詳見 charge_detail 字段明細
base_currencySTRING交易幣別
trigger_priceDECIMAL觸發價格(如適用)
reference_idSTRING客戶自訂識別碼
portfolio_idSTRING投資組合 ID(用戶自訂外部 ID)
reject_reasonSTRING拒單原因(如有)
currency_conversioncurrency_conversion貨幣轉換資訊,詳見 currency_conversion 字段明細
update_timeLONG最後更新時間(UNIX 時間戳)
create_timeLONG訂單建立時間(UNIX 時間戳)

字段明細

名稱類型描述
codeSTRING手續費項編碼,例如 us_trading_commission
amountDECIMAL該項手續費金額
currencySTRING貨幣幣種

手續費項目明細

代碼收費項
us_trading_commission佣金
us_platform_fee平台使用費
us_settlement_and_delivery_cost交收費
us_sec_membership_fee证监会规费
us_external_agency_fee_and_trading_activity_fee交易活動費
us_accounting_tracks_fund_fees綜合審計追蹤資金費用
us_option_regulation_fees監管費

按訂單編號查詢回應

data 欄位中直接返回單一訂單物件。

單一訂單回應範例(按訂單編號查詢)

json
{
  "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
  }
}

按參考編號查詢回應

data 欄位中直接返回訂單物件陣列。如果存在重複的 reference_id 值,可能會返回多筆訂單。

回應結構

回應在 data 欄位中直接包含訂單物件陣列。每個訂單物件包含上述訂單物件欄位部分中描述的相同欄位。

多筆訂單回應範例(按參考編號查詢)

json
{
  "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
      }
    ]
  }
}

錯誤回應範例

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

完整錯誤說明請參見 錯誤碼參考