POSTprecious-metal-inter-contract
国際貴金属先物契約
国際貴金属先物契約
導入ドキュメント
インターフェースの紹介
このインターフェースは、国際貴金属 (銀 SI など) の先物契約コード リストを照会するために使用されます。指定された貴金属品種識別子 (シンボル) を渡すことにより、開発者はその品種に基づくすべての取引可能な先物契約のコード配列を取得でき、取引対象セレクターや基本的な市場サブスクリプション データの構築に役立ちます。
該当するシナリオ
- 金融ターミナル開発: ユーザーが特定の種類の貴金属の市場価格を表示することを選択すると、対応する先物契約オプションが動的にロードされます。
- 定量取引システム: 後続の履歴データの取得またはリアルタイムの市場サブスクリプションのための初期化フェーズ中に完全な契約コードを取得します。
- 投資教育プラットフォーム: ユーザーがロールオーバー ルールを理解できるように、さまざまな月に期限が切れる貴金属先物契約の構造を表示します。
リクエストと返品の手順
- リクエスト方法: POST
- コアパラメータ:
シンボル(必須)、文字列タイプ。国際貴金属品種コードを表します (たとえば、「SI」は銀を表します)。渡されたコードが国際標準またはアップストリームでサポートされている列挙値に準拠していることを確認する必要があります。 - 結果を返す:
code: ステータス コード、200 は成功を意味します。data.list: この商品のすべての先物契約コードを含む文字列配列 (「SI2411」、「SI2501」など、通常は商品コード + 年と月で構成されます)。taskNo: トラブルシューティングを容易にするための、このリクエストの一意の追跡 ID。
提案へのアクセス
- キャッシュ戦略: 先物契約リストの変更頻度は低くなります (通常は月が変わるか、新しい契約が開始されるときです)。 API 呼び出しの数を減らし、応答速度を向上させるために、返された結果をローカルにキャッシュすることをお勧めします (例: 24 時間有効)。
- パラメータ検証: 無効なリクエストを避けるために、フロントエンドは「シンボル」の入力範囲を制限し、既知の貴金属の種類コードのみを渡すことを許可する必要があります。
- エラー処理:
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 | {...} |