DOCUMENTATION

Stock Data

Stock Data API

Query base securities data including stocks, indices, funds and ETFs, bonds, trade calendar, and adjust factors.

MethodEndpointDescription
GET/v1/stocks/infoStock list
GET/v1/indices/infoIndex list
GET/v1/funds/infoFund and ETF list
GET/v1/bonds/infoConvertible bond list
GET/v1/markets/calendarTrade calendar
GET/v1/stocks/adjust-factorAdjust factor history

1. Stock List

Get list of all A-share stocks.

Endpoint

MethodEndpoint
GET/v1/stocks/info

Parameters

ParameterTypeRequiredDefaultDescription
pageint-1Page number, starting at 1
page_sizeint-50Records per page (1-1000)
keywordstring--Search by code, name, or type (optional)
exchangestring--Exchange filter (SSE/SZSE/BSE) (optional)
security_typestring--Security type filter (optional)

Try It

GET/v1/stocks/info
curl -X GET "https://api.tickerlab.org/v1/stocks/info?page=1&page_size=50&keyword=%E5%B9%B3%E5%AE%89&exchange=SZSE" \
  -H "X-API-Key: YOUR_API_KEY"

Code Examples

Python

import requests

API_KEY = "your_api_key"

response = requests.get(
    "https://tickerlab.org/v1/stocks/info",
    params={"page": 1, "page_size": 50, "keyword": "平安"},
    headers={"X-API-Key": API_KEY}
)

data = response.json()
print(f"Matching stocks: {data['total']}")
for stock in data['data'][:5]:
    print(f"{stock['symbol']}: {stock['short_name']}")

cURL

curl -H "X-API-Key: your_key" \
  "https://tickerlab.org/v1/stocks/info?page=1&page_size=50&keyword=平安"

Response Example

{
  "status": "ok",
  "count": 50,
  "total": 138,
  "page": 1,
  "page_size": 50,
  "data": [
    {
      "symbol": "sh.600000",
      "short_name": "浦发银行",
      "list_date": "1999-11-10",
      "security_type": "stock"
    }
  ]
}

Fuzzy search stocks by code or name. Supports Chinese keywords (e.g. 茅台) and codes (e.g. 600519).

Endpoint

MethodEndpoint
GET/v1/stocks/search

Parameters

ParameterTypeRequiredDefaultDescription
qstring--Search keyword (code or name); returns empty if omitted
limitint-10Number of results (1-50)

Try It

GET/v1/stocks/search
curl -X GET "https://api.tickerlab.org/v1/stocks/search?q=%E8%8C%85%E5%8F%B0&limit=10" \
  -H "X-API-Key: YOUR_API_KEY"

Code Examples

cURL

curl -G "https://tickerlab.org/v1/stocks/search" \
  -H "X-API-Key: your_api_key" \
  -d "q=茅台" \
  -d "limit=10"

Response Example

{
  "status": "ok",
  "count": 1,
  "data": [
    {
      "symbol": "sh.600519",
      "short_name": "贵州茅台",
      "industry_sw": "白酒Ⅱ"
    }
  ]
}

2. Index List

Get list of stock indices.

Endpoint

MethodEndpoint
GET/v1/indices/info

Parameters

ParameterTypeRequiredDefaultDescription
pageint-1Page number, starting at 1
page_sizeint-50Records per page
limitint--Compatibility parameter
keywordstring--Search by code or name
exchangestring--Exchange filter

Try It

GET/v1/indices/info
curl -X GET "https://api.tickerlab.org/v1/indices/info?page=1&page_size=50&keyword=index" \
  -H "X-API-Key: YOUR_API_KEY"

3. Bond List

Get list of convertible bonds.

Endpoint

MethodEndpoint
GET/v1/bonds/info

Parameters

ParameterTypeRequiredDefaultDescription
pageint-1Page number, starting at 1
page_sizeint-50Records per page
limitint--Compatibility parameter
keywordstring--Search by bond code, name, or type
exchangestring--Exchange filter
security_typestring--Bond type filter

Try It

GET/v1/bonds/info
curl -X GET "https://api.tickerlab.org/v1/bonds/info?page=1&page_size=50&keyword=bond" \
  -H "X-API-Key: YOUR_API_KEY"

3.1 Fund and ETF List

Get the base directory for funds and ETFs, useful for ETF watchlists and tradable fund discovery.

Endpoint

MethodEndpoint
GET/v1/funds/info

Parameters

ParameterTypeRequiredDefaultDescription
pageint-1Page number, starting at 1
page_sizeint-50Records per page
limitint--Compatibility parameter
keywordstring--Search by fund code, name, or type
exchangestring--Exchange filter

Try It

GET/v1/funds/info
curl -X GET "https://api.tickerlab.org/v1/funds/info?page=1&page_size=50&keyword=ETF" \
  -H "X-API-Key: YOUR_API_KEY"

3.2 Daily Valuation Metrics

Get daily stock valuation, trading, and turnover metrics with watchlist-style batch querying, server-side sorting, and pagination.

Endpoint

MethodEndpoint
GET/v1/stocks/daily-basic

Parameters

ParameterTypeRequiredDefaultDescription
symbolstring--Single stock code
datestring--Exact trading date
start_datestring--Start trading date
end_datestring--End trading date
sort_bystring-dateSort field, such as amount, volume, or turnover_rate
orderstring-descasc or desc
pageint-1Page number
page_sizeint-50Records per page

Try It

GET/v1/stocks/daily-basic
curl -X GET "https://api.tickerlab.org/v1/stocks/daily-basic?symbol=sz.000001&date=2024-01-02&sort_by=amount&order=desc&page=1&page_size=50" \
  -H "X-API-Key: YOUR_API_KEY"

4. Trade Calendar

Get exchange trade calendar.

Endpoint

MethodEndpoint
GET/v1/markets/calendar

Parameters

ParameterTypeRequiredDefaultDescription
exchangestring--Exchange (SSE/SZSE) (optional)
start_datestring--Start date (YYYY-MM-DD) (optional)
end_datestring--End date (YYYY-MM-DD) (optional)
is_trading_dayint--Filter by trading day (1=yes, 0=no) (optional)
pageint-1Page number, starting at 1
page_sizeint-50Records per page (1-1000)

Try It

GET/v1/markets/calendar
curl -X GET "https://api.tickerlab.org/v1/markets/calendar?exchange=SSE&page=1&page_size=30" \
  -H "X-API-Key: YOUR_API_KEY"

Response Example

{
  "status": "ok",
  "count": 30,
  "data": [
    {
      "exchange": "SSE",
      "date": "2024-01-02",
      "is_trading_day": 1
    }
  ]
}

5. Adjust Factor

Get stock adjust factors for forward/backward price adjustment.

Endpoint

MethodEndpoint
GET/v1/stocks/adjust-factor

Parameters

ParameterTypeRequiredDefaultDescription
symbolstring-Stock code (e.g., sh.600000)
start_datestring--Start date
end_datestring--End date
limitint-1000Max records

Try It

GET/v1/stocks/adjust-factor
curl -X GET "https://api.tickerlab.org/v1/stocks/adjust-factor?symbol=sh.600000&limit=30" \
  -H "X-API-Key: YOUR_API_KEY"

Response Example

{
  "status": "ok",
  "count": 30,
  "data": [
    {
      "symbol": "sh.600000",
      "divid_operate_date": "2024-01-02",
      "fore_adjust_factor": 1.234,
      "back_adjust_factor": 0.812
    }
  ]
}