For the complete documentation index, see llms.txt. This page is also available as Markdown.

GET Symbol Fundamentals

Retrieve essential product data including name, exchange, currency, and shares with the Symbol Basic Information API. Ideal for market analytics and symbol lookup.

Overview

The Symbol Fundamentals API provides metadata for instruments across different asset classes.

  • Equities (STOCK_US / STOCK_CN / STOCK_HK / STOCK_IN / STOCK_JP / STOCK_KS / STOCK_TW) return the full fundamentals set — names, exchange, currency, lot size, share counts, earnings data and board.

  • Non-equity instruments (FOREX / METAL / ENERGY / FUTURES / INDICES / CRYPTO) return the instrument code, multilingual names and the quote currency. Equity-specific fields do not apply and are always returned as null.

See Response Fields below for the exact difference between the two sets.

Endpoint

  • Base Path: /common/basic/symbols/info

  • Full Path: https://data.infoway.io/common/basic/symbols/info

Request Frequency

This API shares the same rate limits as other endpoints. The number of allowed requests per second depends on your subscription plan. Please refer to the Rate Limit for details.

Error Codes

See the HTTP Error Codes section for reference.

Authentication

Each request must include your API Key in the header.

Header

Type

Required

Description

apiKey

String

Yes

Your API Key associated with your current plan.

Request Parameters

Parameter

Type

Required

Description

Example

type

String

Yes

Instrument type. See the Type Reference table below.

STOCK_US

symbols

String

Yes

Comma-separated list of instrument codes (up to 500 symbols per request).

000001.SZ,00076.HK

Type Reference

Type Code

Description

Response Set

STOCK_US

U.S. Stocks

Equity

STOCK_CN

China A-Shares

Equity

STOCK_HK

Hong Kong Stocks

Equity

STOCK_IN

India Stocks

Equity

STOCK_JP

Japan Stocks

Equity

STOCK_KS

Korea Stocks

Equity

STOCK_TW

Taiwan Stocks

Equity

FUTURES

Futures

Non-equity

FOREX

Foreign Exchange

Non-equity

ENERGY

Energy

Non-equity

METAL

Metals

Non-equity

INDICES

Indices

Non-equity

CRYPTO

Cryptocurrencies

Non-equity

Unsupported types: any type outside the table above (for example INDEX) returns HTTP 400 with msg set to not support type. It does not return 200 with an empty array.

Futures codes: FUTURES accepts both continuous-contract notations — CL and CL1! both resolve to the same instrument, and the returned symbol matches the notation you sent.

Example Request

Example Response — Equity

Example Response — Non-equity

Response Fields

The JSON shape is identical for every type; only the populated fields differ.

Equity Fields

Applies to STOCK_US / STOCK_CN / STOCK_HK / STOCK_IN / STOCK_JP / STOCK_KS / STOCK_TW.

Field

Type

Required

Description

Example / Values

symbol

string

Yes

Instrument code.

AAPL.US

market

string

No

Market the instrument belongs to.

US, CN, HK, IN, JP, KS, TW

name_cn

string

No

Simplified Chinese name.

苹果

name_en

string

No

English name.

Apple

name_hk

string

No

Traditional Chinese name.

蘋果

exchange

string

No

Trading exchange where the instrument is listed.

NASD, SSE, SZSE, SEHK, NYSE, AMEX, OTC, NYSD

currency

string

No

Trading currency.

USD, CNY, HKD, EUR, SGD, JPY, AUD, GBP

lot_size

int32

No

Lot size (number of shares per trade lot).

100

total_shares

int64

No

Total outstanding shares.

1000000000

circulating_shares

int64

No

Shares available for public trading.

800000000

hk_shares

int64

No

Hong Kong–listed share count (for HK stocks only).

500000000

eps

string

No

Earnings per share.

5.25

eps_ttm

string

No

Trailing twelve-month (TTM) earnings per share.

5.50

bps

string

No

Book value per share.

120.50

dividend_yield

string

No

Dividend yield (percentage).

3.5

board

string

No

The board or trading segment the symbol belongs to. See Board Reference below.

SZMainConnect

Non-equity Fields

Applies to FOREX / METAL / ENERGY / FUTURES / INDICES / CRYPTO.

Field

Type

Required

Description

Example / Values

symbol

string

Yes

Instrument code.

EURUSD, CL, BTCUSDT

name_cn

string

No

Simplified Chinese name.

欧元/美元

name_en

string

No

English name.

Euro / U.S. Dollar

name_hk

string

No

Traditional Chinese name; returns an empty string when not yet available.

黃金現貨 / 美元

currency

string

No

Quote currency. A small number of indices have no quote currency and return null.

USD, USDT

Every other field (market, lot_size, total_shares, circulating_shares, hk_shares, eps, eps_ttm, bps, dividend_yield, stock_derivatives, board) is equity-specific, does not apply to non-equity instruments, and is always returned as null.

exchange is also always null for non-equity instruments: the listing venue is not exposed for these asset classes. This is by design, not missing data.

Board Reference

Board Code

Description

USMain

U.S. Main Board

USPink

U.S. OTC / Pink Sheets

USDJI

Dow Jones Index

USNSDQ

NASDAQ Index

USSector

U.S. Sector & Industry

USOption

U.S. Options

USOptionS

U.S. Special Options (Close at 16:15)

HKEquity

Hong Kong Equity

HKPreIPO

Hong Kong Pre-IPO Market

HKWarrant

Hong Kong Warrants

HKHS

Hang Seng Index

HKSector

Hong Kong Sector & Industry

SHMainConnect

Shanghai Main Board – Connect

SHMainNonConnect

Shanghai Main Board – Non-Connect

SHSTAR

STAR Market (Sci-Tech Innovation Board)

CNIX

Mainland China Index

CNSector

Mainland China Sector & Industry

SZMainConnect

Shenzhen Main Board – Connect

SZMainNonConnect

Shenzhen Main Board – Non-Connect

SZGEMConnect

ChiNext Board – Connect

SZGEMNonConnect

ChiNext Board – Non-Connect

Last updated