POSTPublicprecious-metal-domestic-contract

Chinese Precious Metals Futures Contracts

Documentation

API Introduction

This API is used to query basic information for precious metal futures contracts listed on domestic exchanges. By passing a variety identifier, it returns the corresponding contract code (symbol) and Chinese name (name), helping developers build standardized trading instrument mapping tables.

Use Cases

Financial Terminal Development: Automatically synchronize lists of major and non-major contracts for gold, silver, etc., from the Shanghai Futures Exchange.
Quantitative Strategy Systems: Dynamically obtain tradable contract codes to avoid contract expiration errors caused by hardcoding.
Market Data Display: Provide users with a clear contract selection dropdown menu, displaying standard contract names.

Request and Response Details

Request Method: POST
Key Parameters: symbol (Required), specifies the precious metal variety type.
Response Structure:
code/msg: API status code and description.
data.list: An array of contracts, including symbol (e.g., AU2412) and name (e.g., Gold 2412).

Integration Recommendations

Caching Mechanism: Contract lists change infrequently (typically during rollover periods). It is recommended to cache locally for 24 hours to reduce call costs.
Error Handling: Please validate whether the returned code is 200 and handle empty list scenarios appropriately.
Data Mapping: Use the returned symbol as a unique key to link with real-time market data or historical data APIs.

Integration Examples

Includes ready-to-use Shell, Python, Go, Java, and PHP examples for direct integration.

Request Example

{
  "symbol": "国内贵金属品种，详见国内贵金属现货，详见国内贵金属期货"
}

Response Example

{
  "code": 200,
  "msg": "成功",
  "taskNo": "668229506174286233793097",
  "data": {
    "list": [
      {
        "symbol": "AU0",
        "name": "黄金2412"
      },
      {
        "symbol": "AU2412",
        "name": "黄金2412"
      }
    ]
  }
}

Request Fields

The fields below are derived from example JSON for integration reference only.

Path	Type	Sample
type	string	object
properties	object	{...}
properties.symbol	object	{...}
properties.symbol.type	string	string
properties.symbol.description	string	国内贵金属品种，详见国内贵金属现货，详见国内贵金属期货
required	array	"symbol"
required[]	string	symbol

Response Fields

The fields below are derived from example JSON for integration reference only.

Path	Type	Sample
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	{...}

curl --request POST \ --url 'https://openapi.toolkk.com/v1/precious-metal-domestic-contract' \ --header 'Content-Type: application/json' \ --header 'X-API-Key: YOUR_API_KEY' \ --data '{\n "symbol": "国内贵金属品种，详见国内贵金属现货，详见国内贵金属期货"\n}'

import os import requests url = "https://openapi.toolkk.com/v1/precious-metal-domestic-contract" payload = { "symbol": "国内贵金属品种，详见国内贵金属现货，详见国内贵金属期货" } headers = { "Content-Type": "application/json", "X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"), } response = requests.request("POST", url, headers=headers, json=payload, timeout=30) response.raise_for_status() print(response.json())

package main import ( "bytes" "fmt" "io" "net/http" ) func main() { endpoint := "https://openapi.toolkk.com/v1/precious-metal-domestic-contract" payload := []byte("{\n \"symbol\": \"国内贵金属品种，详见国内贵金属现货，详见国内贵金属期货\"\n}") req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload)) if err != nil { panic(err) } req.Header.Set("Content-Type", "application/json") req.Header.Set("X-API-Key", "YOUR_API_KEY") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() body, err := io.ReadAll(resp.Body) if err != nil { panic(err) } fmt.Println(string(body)) }

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class ToolkkExample { public static void main(String[] args) throws Exception { String payload = "{\n \"symbol\": \"国内贵金属品种，详见国内贵金属现货，详见国内贵金属期货\"\n}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://openapi.toolkk.com/v1/precious-metal-domestic-contract")) .method("POST", HttpRequest.BodyPublishers.ofString(payload)) .header("Content-Type", "application/json") .header("X-API-Key", "YOUR_API_KEY") .build(); HttpResponse<String> response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } }

<?php $endpoint = 'https://openapi.toolkk.com/v1/precious-metal-domestic-contract'; $payload = "{\n \"symbol\": \"国内贵金属品种，详见国内贵金属现货，详见国内贵金属期货\"\n}"; $ch = curl_init($endpoint); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'Content-Type: application/json', 'X-API-Key: YOUR_API_KEY', ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); if ($response === false) { throw new RuntimeException(curl_error($ch)); } curl_close($ch); echo $response;

Chinese Precious Metals Futures Contracts

Documentation

API Introduction

Use Cases

Request and Response Details

Integration Recommendations

Integration Examples

Request Example

Response Example

Request Fields

Response Fields

Shell Example

Python Example

Go Example

Java Example

PHP Example

Try it online