接入文件
介面簡介
本介面用於查詢國際貴金屬(如白銀 SI 等)的期貨合約程式碼列表。開發者傳入指定的貴金屬品種標識(symbol),即可獲取該品種下所有可交易的期貨合約程式碼陣列,輔助構建交易標的選擇器或行情訂閱基礎資料。
適用場景
- 金融終端開發:在使用者選擇檢視某類貴金屬行情時,動態載入對應的期貨合約選項。
- 量化交易系統:初始化階段獲取全量合約程式碼,用於後續的歷史資料拉取或實時行情訂閱。
- 投資教育平臺:展示不同月份到期的貴金屬期貨合約結構,幫助使用者理解展期規則。
請求與返回說明
- 請求方式:POST
- 核心引數:
symbol(必填),字串型別,代表國際貴金屬品種程式碼(例如 "SI" 代表白銀)。需確保傳入的程式碼符合國際通用標準或上游支援的列舉值。 - 返回結果:
code:狀態碼,200 表示成功。data.list:字串陣列,包含該品種下的所有期貨合約程式碼(如 "SI2411", "SI2501" 等,通常由品種程式碼+年月組成)。taskNo:本次請求的唯一追蹤 ID,便於問題排查。
接入建議
- 快取策略:期貨合約列表變更頻率較低(通常在換月或新合約上市時變動),建議對返回結果進行本地快取(如有效期 24 小時),以減少 API 呼叫次數並提升響應速度。
- 引數校驗:前端應限制
symbol的輸入範圍,僅允許傳入已知的貴金屬品種程式碼,避免無效請求。 - 錯誤處理:請根據
code和msg欄位處理異常情況,特別是當傳入不支援的品種程式碼時,介面可能返回非 200 狀態碼或空列表。
接入示例程式碼
提供 Shell、Python、Go、Java、PHP 等常見接入示例,便於直接接到現有專案裡。
請求示例
{
"symbol": "国际贵金属品种,详见国际贵金属现货,详见国际贵金属期货"
}響應示例
{
"code": 200,
"msg": "成功",
"taskNo": "251234402215985750524304",
"data": {
"list": [
"SI",
"SI2411",
"SI2412",
"SI2501",
"SI2503",
"SI2505",
"SI2507",
"SI2509",
"SI2512"
]
}
}請求欄位
以下欄位根據示例 JSON 自動提取,僅作接入參考。
| 欄位路徑 | 型別 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.symbol | object | {...} |
| properties.symbol.type | string | string |
| properties.symbol.description | string | 国际贵金属品种,详见国际贵金属现货,详见国际贵金属期货 |
| required | array | "symbol" |
| required[] | string | symbol |
響應欄位
以下欄位根據示例 JSON 自動提取,僅作接入參考。
| 欄位路徑 | 型別 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.code | object | {...} |
| properties.code.type | string | number |
| properties.code.example | number | 200 |
| properties.code.description | string | 返回码对应描述 |
| properties.msg | object | {...} |