HabitTrade API

繁體中文

English

繁體中文

English

主題

貨幣基金交易 ​

此端點用於對貨幣基金產品訂單進行操作，包括申購、贖回、撤單、查詢。整體流程和介面是：

  • 調用下單介面，其將返回訂單編號
  • 如果想撤銷，可以調用撤銷介面
  • 當訂單被審核時，不論是核准通過還是駁回，都會透過非同步通知流進行即時訊息通知
  • 調用查詢介面取得訂單詳情
  • 關於淨值查詢詳見貨幣基金淨值查詢
  • 所有請求和回應資料中的時間戳預設以 UNIX 秒為單位表示。

下單 ​

HTTP 請求 ​

bash
POST /trade/v1/money-funds/orders/

請求參數 ​

參數名稱類型是否必填說明
symbolSTRING是基金產品代碼。
order_typeENUM是指示要下什麼類型的訂單。詳見 類型 列舉支援值。
amountDECIMAL是申購時為金額（賬戶結算貨幣），贖回時為份額

cURL 請求範例 ​

bash
curl --location --request POST '{$base_url}/trade/v1/money-funds/orders' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'X-API-Signature: YOUR_GENERATED_SIGNATURE' \
--header 'X-API-Timestamp: 1759253657'
--data '{
  "order_type": 'subscribe',
  "symbol": "EFUSDFund",
  "amount": 120
}'

成功回應 ​

欄位名稱類型說明
order_noSTRING訂單編號

範例

json
{
  "code": 0,
  "data": {
    "order_no": "25000001978"
  }
}

錯誤回應 ​

欄位名稱類型說明
codeINT錯誤代碼
messageSTRING錯誤訊息
detailsSTRING補充說明

範例

json
{
  "code": 11070302,
  "message": "Insufficient share"
}

撤銷 ​

已提交的申購/贖回訂單：撤單需在最近一個工作日的 01:50 （UTC+0時間，下同）前進行，超過此時間則不允許再撤單。例如：

  • 用戶在星期一00:00提交了一筆申購訂單，那此筆訂單可以在當天01:50前撤單，超過了01:50則不可再撤單。
  • 用戶在星期一02:30提交了一筆申購訂單，那此筆訂單可以在星期二01:50前撤單。
  • 用戶在星期五12:00提交了一筆申購訂單，那此筆訂單可以在下星期一01:50前撤單。

HTTP 請求 ​

bash
DELETE /trade/v1/money-funds/orders/

請求參數 ​

參數名稱類型是否必填說明
order_noSTRING是訂單編號

cURL 請求範例 ​

bash
curl --location --request DELETE '{$base_url}/trade/v1/money-funds/orders' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'X-API-Signature: YOUR_GENERATED_SIGNATURE' \
--header 'X-API-Timestamp: 1759253657'
--data '{
  "order_no": '25000001967'
}'

成功回應 ​

欄位名稱類型說明
order_noSTRING訂單編號

範例

json
{
  "code": 0
}

錯誤回應 ​

欄位名稱類型說明
codeINT錯誤代碼
messageSTRING錯誤訊息
detailsSTRING補充說明

範例

json
{
  "code": 11070432,
  "message": "Cancel failed, wrong order_status"
}

查詢 ​

HTTP 請求 ​

bash
GET /trade/v1/money-funds/orders/{order_no}

請求參數 ​

參數名稱類型是否必填說明
order_noSTRING是路由參數。訂單編號

cURL 請求範例 ​

bash
curl --location --request GET '{$base_url}/trade/v1/money-funds/orders/{order_no}'
--header 'X-API-Key: YOUR_API_KEY' \
--header 'X-API-Signature: YOUR_GENERATED_SIGNATURE' \
--header 'X-API-Timestamp: 1759253657'

成功回應 ​

欄位名稱類型說明
order_noSTRING訂單編號
symbolSTRING基金產品代碼
order_typeENUM指示是什麼類型的訂單。詳見 類型 列舉支援值。
order_statusENUM訂單狀態。詳見 狀態 列舉支援值。
amount_baseDECIMAL申購申請金額/贖回到賬金額（賬戶結算貨幣）
amount_fundDECIMAL基金產品金額
shareDECIMAL份額
navDECIMAL淨值
base_currencyDECIMAL賬戶結算貨幣

範例

json
{
  "code": 0,
  "data": {
    "order": {
      "order_no": "25000001975",
      "symbol": "EFUSDFund",
      "order_type": "subscribe",
      "order_status": "approved",
      "amount_base": 120,
      "amount_fund": 120.0078,
      "share": 1.0265,
      "nav": 116.899
    }
  }
}

錯誤回應 ​

欄位名稱類型說明
codeINT錯誤代碼
messageSTRING錯誤訊息
detailsSTRING補充說明

範例

json
{
  "code": 11070501,
  "message": "Not found"
}

非同步通知 ​

下單後，使用者可即時追蹤訂單審核更新，不論是核准通過還是駁回，都會有即時訊息被推送，如需接收訂單審核通知，請使用WebSocket 連線

訂單狀態 WebSocket 端點 ​

如需訂閱訂單狀態更新，請連接以下 WebSocket 端點：

wss://{{base_url}}/ws/trade/v1

連線並通過認證後，伺服器會即時推送您有效訂單的狀態更新。

WebSocket 訂單回呼 ​

當訂單審核後（如核准通過、不通過）時，WebSocket 會推送以下欄位：

欄位名稱類型說明
order_noSTRING訂單編號
symbolSTRING基金產品代碼
order_typeENUM指示是什麼類型的訂單。詳見 類型 列舉支援值。
order_statusENUM訂單狀態。詳見 狀態 列舉支援值。
amount_baseDECIMAL申購申請金額/贖回到賬金額（賬戶結算貨幣）
amount_fundDECIMAL基金產品金額
shareDECIMAL份額
navDECIMAL淨值
base_currencyDECIMAL賬戶結算貨幣

通過範例（WebSocket 回呼） ​

json
{
  "type": "money_fund_order",
  "data": {
    "order_no": "25000001978",
    "symbol": "EFUSDFund",
    "order_type": "subscribe",
    "order_status": "approved",
    "amount_base": 120,
    "amount_fund": 120.007799852995,
    "share": 1.0265,
    "nav": 116.899
  }
}

不通過範例（WebSocket 回呼） ​

json
{
  "type": "money_fund_order",
  "data": {
    "order_no": "25000001979",
    "symbol": "EFUSDFund",
    "order_type": "subscribe",
    "order_status": "failed",
    "amount_base": 120,
    "amount_fund": 119.995799852995,
    "share": 1.0264,
    "nav": 0
  }
}

列舉型別 ​

類型 ​

用途： 指定下單操作類型。

代碼說明
none未指定
subscribe申購
redeem贖回

狀態 ​

用途： 指示訂單狀態

代碼說明
none未指定
approving等待核准
approved審核通過
cancelled已被撤銷
failed審核不通過
freeze凍結