DOCUMENTATION

Market Data

Historical K-line OHLCV time series, margin financing, block trades, option snapshots, and trading calendar.

Market Data API

Historical K-line OHLCV time series, margin financing, block trades, option snapshots, and trading calendar.

Endpoints Summary (16 endpoints)

EndpointMethodKey ParametersDescription
/v1/export/historyGETsymbol, start_date, end_date, interval, formatExport Historical Data
/v1/markets/block-trade-dailyGETstart_date, end_date, limitBlock-Trade Market Statistics
/v1/markets/block-trade-detailGETsymbol, date, limitBlock-Trade Detail
/v1/markets/board-summaryGETexchange, date, item, limitSector Trading Summary
/v1/markets/bond/profileGETsymbol, limitGet Bond Profile
/v1/markets/calendarGETexchange, start_date, end_date, is_trading_day, page, page_sizeGet Trade Calendar
/v1/markets/finance/analyst-consensusGETsymbol, date, start_date, end_date, limitGet Analyst Consensus
/v1/markets/finance/forecast-summaryGETsymbol, date, start_date, end_date, limitGet Forecast Summary
/v1/markets/finance/growthGETsymbol, date, start_date, end_date, limitGet Finance Growth
/v1/markets/historyGETsymbol, interval, start_date, end_date, adjustGet Market History
/v1/markets/hsgt-stock-statisticsGETstart_date, end_date, symbol, limitNorthbound Holdings Statistics
/v1/markets/ivixGETunderlying, start_date, end_date, limitETF Options iVIX (R3)
/v1/markets/marginGETstart_date, end_date, limitMargin Trading Market Summary
/v1/markets/margin-detailGETstart_date, end_date, exchange, symbol, limitPer-Stock Margin Detail
/v1/markets/options/snapshotGETunderlying, contract_code, date, limitOptions Quote Snapshot
/v1/markets/suspend-resume-eventsGETstart_date, end_date, symbol, market, limitTrading Halt & Resumption Events

Detailed Endpoint Specifications

GET /v1/export/history

Export Historical Data

Download historical OHLCV data in CSV or JSON format.

Use Cases

  • Backtest trading strategies
  • Train machine learning models
  • Generate reports

Example

curl -X GET "https://tickerlab.org/v1/export/history?symbol=sz.000001&start_date=2024-01-01&end_date=2024-12-31&format=csv" \
     -H "X-API-Key: your_key" \
     -o data.csv

Billing

  • Only successful export requests are billed
  • format affects billing quota; for the exact rules, refer to your current plan and the Playground

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringRequired—Stock code (e.g. sz.000001)
start_datestringRequired—Start date (YYYY-MM-DD)
end_datestringRequired—End date (YYYY-MM-DD)
intervalstringOptional1dK-line interval (supported: 1d/daily, 1w/weekly, 1M/monthly)
formatstringOptionalcsvExport format

cURL Example

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

Python Example

import requests

url = "https://tickerlab.org/v1/export/history"
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/markets/block-trade-daily

Block-Trade Market Statistics

Request Parameters

ParameterTypeRequiredDefaultDescription
start_datestringOptional—Start Date
end_datestringOptional—End Date
limitintegerOptional100

cURL Example

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

Python Example

import requests

url = "https://tickerlab.org/v1/markets/block-trade-daily"
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/markets/block-trade-detail

Block-Trade Detail

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringOptional—
datestringOptional—
limitintegerOptional100

cURL Example

curl -X GET "https://tickerlab.org/v1/markets/block-trade-detail?symbol=sz.000001&date=2026-06-18&limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

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

GET /v1/markets/board-summary

Sector Trading Summary

Get a summary of market trading indicators (such as total market capitalization and average P/E ratio) for major boards/exchanges (SSE, SZSE).

Request Parameters

ParameterTypeRequiredDefaultDescription
exchangestringOptional—Exchange code (e.g. SSE, SZSE) (optional)
datestringOptional—Specific date (YYYY-MM-DD) (optional, defaults to the latest available data)
itemstringOptional—Indicator name (e.g. total market capitalization, average P/E ratio) (optional)
limitintegerOptional500Number of rows to return

cURL Example

curl -X GET "https://tickerlab.org/v1/markets/board-summary?date=2026-06-18&limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/markets/board-summary"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "exchange": "value",
    "date": "value",
    "item": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/markets/bond/profile

Get Bond Profile

Get comprehensive bond profile summary data (DWS).

Includes comprehensive indicators such as convertible bond premium rate, conversion value, and yield to maturity.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringOptional—Bond code (optional)
limitintegerOptional100Number of rows to return

cURL Example

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

Python Example

import requests

url = "https://tickerlab.org/v1/markets/bond/profile"
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/markets/calendar

Get Trade Calendar

Get the trading calendar.

Returns dates and trading-day status for each exchange.

Request Parameters

ParameterTypeRequiredDefaultDescription
exchangestringOptional—Exchange code (SSE/SZSE) (optional)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
is_trading_daystringOptional—Filter trading days (1=yes, 0=no) (optional)
pageintegerOptional1Page number, starting from 1
page_sizeintegerOptional50Rows per page

cURL Example

curl -X GET "https://tickerlab.org/v1/markets/calendar?start_date=2026-01-01" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/markets/calendar"
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/markets/finance/analyst-consensus

Get Analyst Consensus

Get analyst consensus summary data (DWS).

Includes analyst consensus data such as institutional ratings, target prices, and earnings forecasts.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringOptional—Stock code (optional; omit to return the entire market)
datestringOptional—Statistics date (YYYY-MM-DD, optional)
start_datestringOptional—Statistics start date (YYYY-MM-DD)
end_datestringOptional—Statistics end date (YYYY-MM-DD)
limitintegerOptional100Number of rows to return

cURL Example

curl -X GET "https://tickerlab.org/v1/markets/finance/analyst-consensus?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/markets/finance/analyst-consensus"
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/markets/finance/forecast-summary

Get Forecast Summary

Get earnings pre-announcement and flash report summary data (DWS).

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringOptional—Stock code (e.g. sz.000001, sh.600519) (optional)
datestringOptional—Statistics date (YYYY-MM-DD) (optional)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
limitintegerOptional20Number of rows to return

cURL Example

curl -X GET "https://tickerlab.org/v1/markets/finance/forecast-summary?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/markets/finance/forecast-summary"
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/markets/finance/growth

Get Finance Growth

Get financial growth indicator data (DWS).

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringOptional—Stock code (e.g. sz.000001, sh.600519) (optional)
datestringOptional—Reporting period (YYYY-MM-DD) (optional)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
limitintegerOptional100Number of rows to return

cURL Example

curl -X GET "https://tickerlab.org/v1/markets/finance/growth?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/markets/finance/growth"
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/markets/history

Get Market History

Get raw OHLCV data export.

Request Parameters

ParameterTypeRequiredDefaultDescription
symbolstringRequired—Stock code (e.g. sz.000001, sh.600519)
intervalstringOptional1dK-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)
adjuststringOptional—Adjustment type (qfq: forward-adjusted, hfq: backward-adjusted) (optional)

cURL Example

curl -X GET "https://tickerlab.org/v1/markets/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/markets/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/markets/hsgt-stock-statistics

Northbound Holdings Statistics

Request Parameters

ParameterTypeRequiredDefaultDescription
start_datestringOptional—Start Date
end_datestringOptional—End Date
symbolstringOptional—
limitintegerOptional200

cURL Example

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

Python Example

import requests

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

GET /v1/markets/ivix

ETF Options iVIX (R3)

Implied volatility is backed out from ETF option Black-Scholes pricing, approximating a Chinese version of the VIX fear index.

Request Parameters

ParameterTypeRequiredDefaultDescription
underlyingstringOptional—Underlying (e.g. etf_option)
start_datestringOptional—Start date (YYYY-MM-DD)
end_datestringOptional—End date (YYYY-MM-DD)
limitintegerOptional30Number of rows to return

cURL Example

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

Python Example

import requests

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

GET /v1/markets/margin

Margin Trading Market Summary

Request Parameters

ParameterTypeRequiredDefaultDescription
start_datestringOptional—Start Date
end_datestringOptional—End Date
limitintegerOptional100

cURL Example

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

Python Example

import requests

url = "https://tickerlab.org/v1/markets/margin"
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/markets/margin-detail

Per-Stock Margin Detail

Request Parameters

ParameterTypeRequiredDefaultDescription
start_datestringOptional—Start Date
end_datestringOptional—End Date
exchangestringOptional—
symbolstringOptional—
limitintegerOptional300

cURL Example

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

Python Example

import requests

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

GET /v1/markets/options/snapshot

Options Quote Snapshot

Get quote snapshot data for the options market (including call/put type, strike price, expiration date, latest price, settlement price, and more).

Request Parameters

ParameterTypeRequiredDefaultDescription
underlyingstringOptional—Underlying security name (e.g. etf_option) (optional)
contract_codestringOptional—Option contract code (optional)
datestringOptional—Specific date (YYYY-MM-DD) (optional)
limitintegerOptional500Number of rows to return

cURL Example

curl -X GET "https://tickerlab.org/v1/markets/options/snapshot?date=2026-06-18&limit=10" \
  -H "X-API-Key: $TICKERLAB_API_KEY"

Python Example

import requests

url = "https://tickerlab.org/v1/markets/options/snapshot"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
    "underlying": "value",
    "contract_code": "value",
    "date": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())

GET /v1/markets/suspend-resume-events

Trading Halt & Resumption Events

Request Parameters

ParameterTypeRequiredDefaultDescription
start_datestringOptional—Start Date
end_datestringOptional—End Date
symbolstringOptional—
marketstringOptional—
limitintegerOptional300

cURL Example

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

Python Example

import requests

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