GETPublicsymbol-search

Instrument Symbol Search

Supports searching for contract symbols of global financial instruments like stocks, futures, forex, and cryptocurrencies by name, Pinyin initials, or category, returning a list of matching instruments.

Documentation

API Capabilities

This API provides an instrument symbol search service for global financial markets. It supports retrieving corresponding contract symbols via fuzzy keywords (e.g., name, Pinyin initials, code snippets) or specified categories (e.g., US stocks, HK stocks, forex, futures, digital currencies, etc.). For the futures category, it also supports filtering for main contracts.

Request and Response

Request Parameters: Requires pidx (page number, max 50 items per page). At least one of rout (category, e.g., USST, HKST, CMDTY, etc.) and keywords (fuzzy keyword) must be provided. For futures, futmain can be passed to filter for main contracts.
Response Result: Returns a list of instruments matching the search criteria, including basic information such as contract symbol, name, and category, facilitating subsequent market data retrieval or chart display for developers.

Use Cases

Financial Terminal Development: Provide instrument search and watchlist addition features in stock, futures, or forex trading software.
Quantitative Analysis Platforms: Help users quickly find corresponding standardized contract symbols by name for data backtesting.
Financial News Websites: Automatically match and link corresponding financial instrument symbols within articles or pages.

Usage Instructions and Limitations

At least one of rout and keywords must be provided; otherwise, an effective search cannot be performed.
Fuzzy queries may return many results; it is recommended to combine with the category parameter rout for precise filtering.
This API only provides basic instrument symbol information retrieval and does not include real-time market quotes. The format of the returned contract symbols needs to be adapted according to the requirements of specific market data APIs.

Integration Examples

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

Request Example

{
  "pidx": "页码，每页最多50",
  "rout": "分类rout和keywords两参数中至少输入其中一个,参考(CNST,USST,HKST,GBFSB,GBCFD,GBFT,CNFT,GBDC,GBIDX,C...",
  "keywords": "模糊关键字，拼音首字母/代码等(rout和keywords两参数中必须至少输入其中一个)",
  "futmain": "是否筛选主力合约(1是0否)，针对期货分类有效"
}

Response Example

{}

Request Fields

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

Path	Type	Sample
type	string	object
properties	object	{...}
properties.pidx	object	{...}
properties.pidx.type	string	int
properties.pidx.description	string	页码，每页最多50
properties.rout	object	{...}
properties.rout.type	string	string

Response Fields

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

Path	Type	Sample
type	string	object

curl --request GET \ --url 'https://openapi.toolkk.com/v1/aliyunmarket-cmapi029045-query-symbols' \ --header 'Content-Type: application/json' \ --header 'X-API-Key: YOUR_API_KEY' \ --data '{\n "pidx": "页码，每页最多50",\n "rout": "分类rout和keywords两参数中至少输入其中一个,参考(CNST,USST,HKST,GBFSB,GBCFD,GBFT,CNFT,GBDC,GBIDX,C...",\n "keywords": "模糊关键字，拼音首字母/代码等(rout和keywords两参数中必须至少输入其中一个)",\n "futmain": "是否筛选主力合约(1是0否)，针对期货分类有效"\n}'

import os import requests url = "https://openapi.toolkk.com/v1/aliyunmarket-cmapi029045-query-symbols" payload = { "pidx": "页码，每页最多50", "rout": "分类rout和keywords两参数中至少输入其中一个,参考(CNST,USST,HKST,GBFSB,GBCFD,GBFT,CNFT,GBDC,GBIDX,C...", "keywords": "模糊关键字，拼音首字母/代码等(rout和keywords两参数中必须至少输入其中一个)", "futmain": "是否筛选主力合约(1是0否)，针对期货分类有效" } headers = { "Content-Type": "application/json", "X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"), } response = requests.get(url, headers=headers, params=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/aliyunmarket-cmapi029045-query-symbols" payload := []byte("{\n \"pidx\": \"页码，每页最多50\",\n \"rout\": \"分类rout和keywords两参数中至少输入其中一个,参考(CNST,USST,HKST,GBFSB,GBCFD,GBFT,CNFT,GBDC,GBIDX,C...\",\n \"keywords\": \"模糊关键字，拼音首字母/代码等(rout和keywords两参数中必须至少输入其中一个)\",\n \"futmain\": \"是否筛选主力合约(1是0否)，针对期货分类有效\"\n}") req, err := http.NewRequest("GET", 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 \"pidx\": \"页码，每页最多50\",\n \"rout\": \"分类rout和keywords两参数中至少输入其中一个,参考(CNST,USST,HKST,GBFSB,GBCFD,GBFT,CNFT,GBDC,GBIDX,C...\",\n \"keywords\": \"模糊关键字，拼音首字母/代码等(rout和keywords两参数中必须至少输入其中一个)\",\n \"futmain\": \"是否筛选主力合约(1是0否)，针对期货分类有效\"\n}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://openapi.toolkk.com/v1/aliyunmarket-cmapi029045-query-symbols")) .method("GET", 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/aliyunmarket-cmapi029045-query-symbols'; $payload = "{\n \"pidx\": \"页码，每页最多50\",\n \"rout\": \"分类rout和keywords两参数中至少输入其中一个,参考(CNST,USST,HKST,GBFSB,GBCFD,GBFT,CNFT,GBDC,GBIDX,C...\",\n \"keywords\": \"模糊关键字，拼音首字母/代码等(rout和keywords两参数中必须至少输入其中一个)\",\n \"futmain\": \"是否筛选主力合约(1是0否)，针对期货分类有效\"\n}"; $ch = curl_init($endpoint); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', 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;

Instrument Symbol Search

Documentation

API Capabilities

Request and Response

Use Cases

Usage Instructions and Limitations

Integration Examples

Request Example

Response Example

Request Fields

Response Fields

Shell Example

Python Example

Go Example

Java Example

PHP Example

Try it online