接入文件
介面簡介
本介面提供國內期貨市場(內盤)合約基礎資訊查詢服務。開發者傳入標準的期貨品種程式碼(symbol),即可獲取對應的合約列表,包含合約程式碼及中文全稱(如“上海原油2407”)。資料來源自阿里雲市場上游服務,適用於需要標準化期貨品種標識的業務系統。
適用場景
- 金融終端開發:在交易軟體或行情繫統中展示標準化的合約名稱。
- 資料清洗與對映:將內部系統的簡寫程式碼轉換為通用的中文合約名稱。
- 量化策略回測:構建策略時自動匹配歷史合約的程式碼與名稱對應關係。
- 資訊聚合平臺:確保展示的期貨品種名稱符合國內市場規範。
請求與返回說明
請求方式:POST 請求引數:
symbol(必填, string):期貨品種程式碼,需參考官方或上游提供的程式碼表,例如 "SC0"。
返回結果:
code(number):狀態碼,200 表示成功。msg(string):狀態描述。taskNo(string):本次請求的唯一追蹤號。data.list(array):合約列表陣列。symbol(string):合約程式碼。name(string):合約中文名稱,包含品種、交易所及到期月份資訊。
接入建議
- 程式碼規範性:請確保傳入的
symbol嚴格符合上游定義的格式,大小寫敏感,否則可能導致查詢為空。 - 快取策略:期貨合約列表變更頻率較低(主要在換月或新合約上市時),建議對返回結果進行本地快取(如 TTL 設定為 24 小時),以減少 API 呼叫次數並提升響應速度。
- 異常處理:務必檢查返回的
code欄位,非 200 狀態碼時請根據msg提示進行日誌記錄或使用者提示,避免直接解析data導致空指標異常。
接入示例程式碼
提供 Shell、Python、Go、Java、PHP 等常見接入示例,便於直接接到現有專案裡。
請求示例
{
"symbol": "期货品种代码,详见代码表"
}響應示例
{
"msg": "成功",
"taskNo": "075556736233047430019762",
"code": 200,
"data": {
"list": [
{
"symbol": "SC0",
"name": "上海原油2407"
}
]
}
}請求欄位
以下欄位根據示例 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.msg | object | {...} |
| properties.msg.type | string | string |
| properties.msg.example | string | 成功 |
| properties.msg.description | string | 返回码对应描述 |
| properties.taskNo | object | {...} |