DOCUMENTATION

Securities Reference Data

Stock catalog, master profiles, daily basic valuation metrics, IPOs, risk warnings, indices, funds, and convertible bonds.

Securities Reference Data API

Stock catalog, master profiles, daily basic valuation metrics, IPOs, risk warnings, indices, funds, and convertible bonds.

Endpoints Summary (18 endpoints)

EndpointMethodKey ParametersDescription
/v1/bonds/detailGETsymbol, limitBond Detail
/v1/bonds/historyGETsymbol, interval, start_date, end_date, limitBond Historical Quotes
/v1/bonds/infoGETpage, page_size, keyword, exchange, security_typeGet Bond List
/v1/funds/historyGETsymbol, interval, start_date, end_date, limitFund Historical Quotes
/v1/funds/infoGETpage, page_size, keyword, exchange, security_typeFund List
/v1/indices/historyGETsymbol, interval, start_date, end_date, limitIndex Historical Quotes
/v1/indices/infoGETpage, page_size, keyword, exchangeGet Index List
/v1/stocks/adjust-factorGETsymbol, start_date, end_date, limitGet Adjust Factor
/v1/stocks/daily-basicGETsymbol, date, start_date, end_date, sort_by, order, page, page_sizeDaily Stock Metrics Master Table
/v1/stocks/delistedGETexchange, start_date, end_date, limitDelisted Stock List
/v1/stocks/esg-ratingGETsymbol, dateStock ESG Rating
/v1/stocks/index-constituentsGETindex_codeIndex Constituents (R19)
/v1/stocks/infoGETpage, page_size, keyword, exchange, security_typeGet Stock List
/v1/stocks/ipoGETstart_date, end_date, limitIPO New Listings
/v1/stocks/name-historyGETsymbol, limitStock Former Names
/v1/stocks/profileGETsymbolStock Basic Info/Profile
/v1/stocks/risk-boardGETlimitRisk Warning Board/ST Stocks
/v1/stocks/searchGETq, limitStock Search

Detailed Endpoint Specifications

GET /v1/bonds/detail

Bond Detail

Retrieve convertible bond details.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringOptional—Security code (optional)
limitintegerOptional100Number of records returned

cURL Example

curl -X GET "https://tickerlab.org/v1/bonds/detail?symbol=sz.000001&limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/bonds/detail"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "symbol": "sz.000001",
    "limit": 10
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/bonds/history

Bond Historical Quotes

Retrieve historical candlestick data for bonds.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringRequired—Bond code (e.g. sz.123059)
intervalstringOptionaldailyK-line interval (supported: 1d/daily, 1w/weekly, 1M/monthly)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
limitintegerOptional200Number of records returned (compatibility parameter)

cURL Example

curl -X GET "https://tickerlab.org/v1/bonds/history?symbol=sz.000001&interval=1d&start_date=2026-01-01" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/bonds/history"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "symbol": "sz.000001",
    "interval": "1d",
    "start_date": "2026-01-01"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/bonds/info

Get Bond List

Retrieve the bond list.

Request Parameters

ParameterTypeRequiredDefaultDescription
pageintegerOptional1Page number, starting from 1
page_sizeintegerOptional50Items per page
keywordstringOptional—Code/name/type keyword (optional)
exchangestringOptional—Exchange filter (SSE/SZSE/BSE) (optional)
security_typestringOptional—Bond type filter (optional)

cURL Example

curl -X GET "https://tickerlab.org/v1/bonds/info" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/bonds/info"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "page": "value",
    "page_size": "value",
    "keyword": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/funds/history

Fund Historical Quotes

Retrieve historical candlestick data for funds.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringRequired—Fund code (e.g. sh.510300)
intervalstringOptionaldailyK-line interval (supported: 1d/daily, 1w/weekly, 1M/monthly)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
limitintegerOptional200Number of records returned (compatibility parameter)

cURL Example

curl -X GET "https://tickerlab.org/v1/funds/history?symbol=sz.000001&interval=1d&start_date=2026-01-01" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/funds/history"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "symbol": "sz.000001",
    "interval": "1d",
    "start_date": "2026-01-01"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/funds/info

Fund List

Retrieve the full fund/ETF list data.

Request Parameters

ParameterTypeRequiredDefaultDescription
pageintegerOptional1Page number, starting from 1
page_sizeintegerOptional50Items per page
keywordstringOptional—Code/name/type keyword (optional)
exchangestringOptional—Exchange filter (SSE/SZSE/BSE) (optional)
security_typestringOptional—Fund type filter (optional)

cURL Example

curl -X GET "https://tickerlab.org/v1/funds/info" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/funds/info"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "page": "value",
    "page_size": "value",
    "keyword": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/indices/history

Index Historical Quotes

Retrieve historical candlestick data for indices.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringRequired—Index code (e.g. sh.000001, sz.399001)
intervalstringOptionaldailyK-line interval (supported: 1d/daily, 1w/weekly, 1M/monthly)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
limitintegerOptional200Number of records returned (compatibility parameter)

cURL Example

curl -X GET "https://tickerlab.org/v1/indices/history?symbol=sz.000001&interval=1d&start_date=2026-01-01" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/indices/history"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "symbol": "sz.000001",
    "interval": "1d",
    "start_date": "2026-01-01"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/indices/info

Get Index List

Retrieve the index list.

Request Parameters

ParameterTypeRequiredDefaultDescription
pageintegerOptional1Page number, starting from 1
page_sizeintegerOptional50Items per page
keywordstringOptional—Code/name keyword (optional)
exchangestringOptional—Exchange filter (SSE/SZSE/BSE) (optional)

cURL Example

curl -X GET "https://tickerlab.org/v1/indices/info" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/indices/info"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "page": "value",
    "page_size": "value",
    "keyword": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/adjust-factor

Get Adjust Factor

Retrieve stock adjustment factors (forward/backward adjusted).

Returns the stock’s daily forward and backward adjustment factors.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringRequired—Stock code (e.g. sz.000001, sh.600519)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
limitintegerOptional1000Number of records returned

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/adjust-factor?symbol=sz.000001&start_date=2026-01-01&limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/adjust-factor"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "symbol": "sz.000001",
    "start_date": "2026-01-01",
    "end_date": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/daily-basic

Daily Stock Metrics Master Table

Retrieve the daily comprehensive metrics summary for individual stocks.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringRequired—Stock code (e.g. sz.000001, sh.600519)
datestringOptional—Trading date (YYYY-MM-DD) (optional)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
sort_bystringOptional—Sort field (optional)
orderstringOptionaldescSort direction (asc/desc)
pageintegerOptional1Page number, starting from 1
page_sizeintegerOptional50Items per page

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/daily-basic?symbol=sz.000001&date=2026-06-18&start_date=2026-01-01" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/daily-basic"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "symbol": "sz.000001",
    "date": "value",
    "start_date": "2026-01-01"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/delisted

Delisted Stock List

Retrieve the historical list of delisted stocks (including SSE, SZSE, the two-network (STAQ/NET) boards, and delisting-arrangement stocks).

Request Parameters

ParameterTypeRequiredDefaultDescription
exchangestringOptional—Exchange filter (SSE=Shanghai Stock Exchange, SZSE=Shenzhen Stock Exchange, BSE=Beijing Stock Exchange) (optional)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
limitintegerOptional500Number of records returned

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/delisted?start_date=2026-01-01&limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/delisted"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "exchange": "value",
    "start_date": "2026-01-01",
    "end_date": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/esg-rating

Stock ESG Rating

Retrieve a stock’s ESG rating and component scores (including environmental, social, governance, and controversy scores).

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringRequired—Stock code (e.g. sz.000001, sh.600519)
datestringOptional—Specific date (YYYY-MM-DD) (optional; defaults to the latest data)

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/esg-rating?symbol=sz.000001&date=2026-06-18" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/esg-rating"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "symbol": "sz.000001",
    "date": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/index-constituents

Index Constituents (R19)

Retrieve index constituent lists (CSI 300/CSI 500/SSE 50/CSI 1000/ChiNext Index/STAR 50).

Request Parameters

ParameterTypeRequiredDefaultDescription
index_codestringOptional000300Index code (000300/000905/000016/000852/399006/000688)

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/index-constituents" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/index-constituents"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "index_code": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/info

Get Stock List

Retrieve the list of listed companies.

Request Parameters

ParameterTypeRequiredDefaultDescription
pageintegerOptional1Page number, starting from 1
page_sizeintegerOptional50Items per page
keywordstringOptional—Code/name/type keyword (optional)
exchangestringOptional—Exchange filter (SSE/SZSE/BSE) (optional)
security_typestringOptional—Security type filter (optional)

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/info" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/info"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "page": "value",
    "page_size": "value",
    "keyword": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/ipo

IPO New Listings

Retrieve the list of new stock IPOs and listings, including issue price, P/E ratio, funds raised, and more.

Request Parameters

ParameterTypeRequiredDefaultDescription
start_datestringOptional—IPO date from (YYYY-MM-DD) (optional)
end_datestringOptional—IPO date to (YYYY-MM-DD) (optional)
limitintegerOptional200Number of records returned

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/ipo?start_date=2026-01-01&limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/ipo"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "start_date": "2026-01-01",
    "end_date": "value",
    "limit": 10
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/name-history

Stock Former Names

Retrieve historical stock renaming records.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringOptional—Stock code (e.g. sz.000001, sh.600519) (optional; if omitted, returns all records)
limitintegerOptional200Number of records returned

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/name-history?symbol=sz.000001&limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/name-history"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "symbol": "sz.000001",
    "limit": 10
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/profile

Stock Basic Info/Profile

Retrieve basic info and Profile data for a single stock.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringRequired—Stock code (e.g. sz.000001, sh.600519)

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/profile?symbol=sz.000001" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/profile"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "symbol": "sz.000001"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/risk-board

Risk Warning Board/ST Stocks

Retrieve the list of stocks currently on the risk warning board (ST/*ST/SST).

Request Parameters

ParameterTypeRequiredDefaultDescription
limitintegerOptional500Number of records returned (compatibility parameter)

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/risk-board?limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/risk-board"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "limit": 10
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/stocks/search

Stock Search

Fuzzy search stocks by code or name.

Request Parameters

ParameterTypeRequiredDefaultDescription
qstringOptional—Search keyword (code or name)
limitintegerOptional10Number of records returned

cURL Example

curl -X GET "https://tickerlab.org/v1/stocks/search?limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/stocks/search"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "q": "value",
    "limit": 10
}
response = requests.get(url, headers=headers, params=params)
print(response.json())