POSTPublicfinance-us-shares-symbol

US Stock Categories

Documentation

API Introduction

This API is used to retrieve the list of trading symbols for specified US stock markets. By passing a market code (e.g., NYSE, NASDAQ, or AMEX), it returns the corresponding stock symbol and its Chinese name. The data is suitable for building a basic US stock market database or a frontend stock picker.

Use Cases

Financial Terminal Development: Initialize US stock dropdown selectors or search indexes.
Quantitative Strategy Backtesting: Obtain the full universe of symbols for a specific exchange, used for filtering tradable assets.
Information Aggregation Applications: Establish a mapping between stock symbols and Chinese names to enhance user reading experience.

Request and Response Description

Request Method: POST
Core Parameter: market (Required), enum values include nu (NYSE), ou (NASDAQ), au (AMEX).
Response Structure: Standard JSON format. On success, code is 200, and the data.list array contains objects, each with symbol (stock code) and name (Chinese name).

Integration Suggestions

Caching Strategy: The frequency of US stock listings changes is relatively low. It is recommended to cache the returned results locally (e.g., update once daily) to reduce API call frequency and latency.
Error Handling: Please validate the returned code field. If the status code is not 200, record the msg information for troubleshooting.
Data Cleaning: Returned stock names may contain special characters or lengthy descriptions. It is recommended to truncate or format them for frontend display compatibility.

Integration Examples

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

Request Example

{
  "market": "市场，au 美交所 ，nu 纽交所 ，ou 纳斯达克"
}

Response Example

{
  "msg": "成功",
  "code": 200,
  "taskNo": "644761017176228998465587",
  "data": {
    "list": [
      {
        "symbol": "gdxu",
        "name": "金矿指数3倍做多ETN"
      },
      {
        "symbol": "evav",
        "name": "2倍做多电动和自动驾驶汽车ETF-Direxion"
      }
    ]
  }
}

Request Fields

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

Path	Type	Sample
type	string	object
properties	object	{...}
properties.market	object	{...}
properties.market.type	string	string
properties.market.description	string	市场，au 美交所，nu 纽交所，ou 纳斯达克
required	array	"market"
required[]	string	market

Response Fields

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

Path	Type	Sample
type	string	object
properties	object	{...}
properties.msg	object	{...}
properties.msg.type	string	string
properties.msg.example	string	成功
properties.msg.description	string	返回码对应描述
properties.code	object	{...}

curl --request POST \ --url 'https://openapi.toolkk.com/v1/finance-us-shares-symbol' \ --header 'Content-Type: application/json' \ --header 'X-API-Key: YOUR_API_KEY' \ --data '{\n "market": "市场，au 美交所，nu 纽交所，ou 纳斯达克"\n}'

import os import requests url = "https://openapi.toolkk.com/v1/finance-us-shares-symbol" payload = { "market": "市场，au 美交所，nu 纽交所，ou 纳斯达克" } 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/finance-us-shares-symbol" payload := []byte("{\n \"market\": \"市场，au 美交所，nu 纽交所，ou 纳斯达克\"\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 \"market\": \"市场，au 美交所，nu 纽交所，ou 纳斯达克\"\n}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://openapi.toolkk.com/v1/finance-us-shares-symbol")) .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/finance-us-shares-symbol'; $payload = "{\n \"market\": \"市场，au 美交所，nu 纽交所，ou 纳斯达克\"\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;

US Stock Categories

Documentation

API Introduction

Use Cases

Request and Response Description

Integration Suggestions

Integration Examples

Request Example

Response Example

Request Fields

Response Fields

Shell Example

Python Example

Go Example

Java Example

PHP Example

Try it online