DOCUMENTATION
Data Endpoint Reference
Complete reference for all public data endpoints, key parameters, and response types.
Data Endpoint Reference
This page provides a comprehensive reference of all 164 public data API endpoints available on TickerLab. Each section links to the corresponding detailed guide for authentication, full schema details, and code examples.
Unless noted otherwise, all endpoints use GET, require X-API-Key authentication in the request header, and return standard JSON payloads.
Market Data
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/markets/block-trade-daily | GET | start_date, end_date, limit | Block-Trade Market Statistics | Market Data |
/v1/markets/block-trade-detail | GET | symbol, date, limit | Block-Trade Detail | Market Data |
/v1/markets/board-summary | GET | exchange, date, item, limit | Sector Trading Summary | Market Data |
/v1/markets/bond/profile | GET | symbol, limit | Get comprehensive bond information summary data (DWS). | Market Data |
/v1/markets/calendar | GET | exchange, start_date, end_date, is_trading_day, page, page_size | Trade calendar query (with trading-day determination) | Market Data |
/v1/markets/finance/analyst-consensus | GET | symbol, date, start_date, end_date, limit | Get analyst consensus estimate summary data (DWS). | Market Data |
/v1/markets/finance/forecast-summary | GET | symbol, date, start_date, end_date, limit | Get earnings forecast and express report summary data (DWS). | Market Data |
/v1/markets/finance/growth | GET | symbol, date, start_date, end_date, limit | Get financial growth indicator data (DWS). | Market Data |
/v1/markets/history | GET | symbol, interval, start_date, end_date, adjust | Get raw OHLCV data export. | Market Data |
/v1/markets/hsgt-stock-statistics | GET | start_date, end_date, symbol, limit | Northbound Holdings Statistics | Market Data |
/v1/markets/ivix | GET | underlying, start_date, end_date, limit | ETF Options iVIX (R3) | Market Data |
/v1/markets/margin | GET | start_date, end_date, limit | Margin Trading Market Summary | Market Data |
/v1/markets/margin-detail | GET | start_date, end_date, exchange, symbol, limit | Per-Stock Margin Detail | Market Data |
/v1/markets/options/snapshot | GET | underlying, contract_code, date, limit | Options Quote Snapshot | Market Data |
/v1/markets/suspend-resume-events | GET | start_date, end_date, symbol, market, limit | Trading Halt & Resumption Events | Market Data |
Chart Generation
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/markets/chart/batch | POST | — | Batch-generate multiple charts. | Chart Generation |
/v1/markets/chart/storage | POST | — | Generate K-line chart compatible with chart-img.com | Chart Generation |
Market Intelligence & Aggregation
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/markets/macro/dashboard | GET | start_date, end_date, indicators, limit | Get macroeconomic dashboard summary data (DWS). | Market Intelligence & Aggregation |
/v1/markets/market-breadth | GET | date, start_time, end_time, limit | Get intraday market breadth summary. | Market Intelligence & Aggregation |
/v1/markets/market/dragon-tiger-stats | GET | symbol, date, start_date, end_date, limit | Get Dragon-Tiger list statistics summary data (DWS). | Market Intelligence & Aggregation |
/v1/markets/market/hot-stock-trend | GET | symbol, date, start_date, end_date, limit | Get hot stock trend summary. | Market Intelligence & Aggregation |
/v1/markets/market/hsgt-summary | GET | start_date, end_date, market_type, limit | Get Stock Connect flow summary data (DWS). | Market Intelligence & Aggregation |
/v1/markets/market/limit-stats | GET | symbol, date, start_date, end_date, limit | Get limit-up/limit-down statistics summary data (DWS). | Market Intelligence & Aggregation |
/v1/markets/market/margin-summary | GET | start_date, end_date, limit | Get margin trading & short selling summary data (DWS). | Market Intelligence & Aggregation |
/v1/markets/market/regime | GET | date | Get market regime summary. | Market Intelligence & Aggregation |
/v1/markets/market/sentiment | GET | date | Get market sentiment summary. | Market Intelligence & Aggregation |
/v1/markets/momentum | GET | symbol, date, start_time, end_time, limit | Get intraday momentum summary. | Market Intelligence & Aggregation |
/v1/markets/opportunity/watchlist | GET | date, watch_action, limit | Get opportunity watchlist summary. | Market Intelligence & Aggregation |
/v1/markets/risk/invalidation | GET | symbol, logic_type, date, limit | Get risk invalidation/revocation logic summary. | Market Intelligence & Aggregation |
/v1/markets/sector-pulse | GET | sector_name, date, start_time, end_time, limit | Get intraday sector pulse summary. | Market Intelligence & Aggregation |
/v1/markets/sector/breadth | GET | date, sector_type, limit | Get sector breadth summary. | Market Intelligence & Aggregation |
/v1/markets/sector/concept-heat | GET | plate_code, date, start_date, end_date, limit | Get concept heat summary. | Market Intelligence & Aggregation |
/v1/markets/sector/rotation | GET | date, sector_type, limit | Get sector rotation summary. | Market Intelligence & Aggregation |
/v1/markets/stock/event-timeline | GET | symbol, start_date, end_date, limit | Get single-stock event timeline summary. | Market Intelligence & Aggregation |
/v1/markets/stock/pledge-risk | GET | symbol, date, start_date, end_date, limit | Get stock pledge risk summary data (DWS). | Market Intelligence & Aggregation |
/v1/markets/stock/profile | GET | symbol, limit | Get stock profile summary data (DWS). | Market Intelligence & Aggregation |
/v1/markets/stock/shareholder-activity | GET | symbol, date, start_date, end_date, limit | Get shareholder activity summary data (DWS). | Market Intelligence & Aggregation |
/v1/markets/stock/snapshot | GET | symbol, date | Get single-stock snapshot summary. | Market Intelligence & Aggregation |
Securities (Stocks, Indices, Funds, Bonds)
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/bonds/detail | GET | symbol, limit | Bond Details | Securities |
/v1/bonds/history | GET | symbol, interval, start_date, end_date, limit | Bond Historical Quotes | Securities |
/v1/bonds/info | GET | page, page_size, keyword, exchange, security_type | Get Bond List | Securities |
/v1/funds/history | GET | symbol, interval, start_date, end_date, limit | Fund Historical Quotes | Securities |
/v1/funds/info | GET | page, page_size, keyword, exchange, security_type | Fund List | Securities |
/v1/indices/history | GET | symbol, interval, start_date, end_date, limit | Index Historical Quotes | Securities |
/v1/indices/info | GET | page, page_size, keyword, exchange | Get Index List | Securities |
/v1/stocks/adjust-factor | GET | symbol, start_date, end_date, limit | Data query | Securities |
/v1/stocks/daily-basic | GET | symbol, date, start_date, end_date, sort_by, order, page, page_size | Daily Per-Stock Indicator Master Table | Securities |
/v1/stocks/delisted | GET | exchange, start_date, end_date, limit | Delisted Stock List | Securities |
/v1/stocks/esg-rating | GET | symbol, date | Stock ESG Rating | Securities |
/v1/stocks/index-constituents | GET | index_code | Index Constituents (R19) | Securities |
/v1/stocks/info | GET | page, page_size, keyword, exchange, security_type | Get Stock List | Securities |
/v1/stocks/ipo | GET | start_date, end_date, limit | IPO Stock List | Securities |
/v1/stocks/list | GET | page, page_size, keyword, exchange, security_type | Get Stock List | Securities |
/v1/stocks/name-history | GET | symbol, limit | Stock Former-Name History | Securities |
/v1/stocks/profile | GET | symbol | Stock Basic Info/Profile | Securities |
/v1/stocks/risk-board | GET | limit | Risk Warning Board/ST Stocks | Securities |
/v1/stocks/search | GET | q, limit | Stock Search | Securities |
Technical Indicators
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/indicators/adx | GET | symbol, start_date, end_date, timeperiod, limit | Get Average Directional Index (ADX). | Technical Indicators |
/v1/indicators/atr | GET | symbol, start_date, end_date, timeperiod, limit | Get Average True Range (ATR). | Technical Indicators |
/v1/indicators/bbands | GET | symbol, start_date, end_date, timeperiod, stds, limit | Get Bollinger Bands indicator | Technical Indicators |
/v1/indicators/ema | GET | symbol, start_date, end_date, timeperiod, series_type, limit | Data query | Technical Indicators |
/v1/indicators/kdj | GET | symbol, start_date, end_date, fastk_period, slowk_period, slowd_period, limit | Data query | Technical Indicators |
/v1/indicators/ma | GET | symbol, start_date, end_date, timeperiod, series_type, limit | Data query | Technical Indicators |
/v1/indicators/macd | GET | symbol, start_date, end_date, fastperiod, slowperiod, signalperiod, limit | Get MACD indicator data. | Technical Indicators |
/v1/indicators/obv | GET | symbol, start_date, end_date, limit | Get On-Balance Volume (OBV) indicator. | Technical Indicators |
/v1/indicators/rsi | GET | symbol, start_date, end_date, timeperiod, limit | Get RSI indicator data. | Technical Indicators |
/v1/indicators/stoch | GET | symbol, start_date, end_date, fastk_period, slowk_period, slowd_period, limit | Get Stochastic Oscillator. | Technical Indicators |
/v1/indicators/ticker_info | GET | symbol | Get stock basic information. Requires API key authentication. | Technical Indicators |
/v1/indicators/time_series | GET | symbol, start_date, end_date, adjust, limit | Get K-line (candlestick) data and technical indicators (with TA) | Technical Indicators |
/v1/indicators/vwap | GET | symbol, start_date, end_date, limit | Get Volume-Weighted Average Price (VWAP). | Technical Indicators |
Financial Statements & Fundamentals
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/finance/balance | GET | symbol, date, start_date, end_date, limit | Balance Sheet | Financial Statements & Fundamentals |
/v1/finance/cash-flow | GET | symbol, date, start_date, end_date, limit | Cash Flow Statement | Financial Statements & Fundamentals |
/v1/finance/core-index | GET | symbol, date, start_date, end_date, limit | Core Financial Indicators | Financial Statements & Fundamentals |
/v1/finance/dividend | GET | symbol, date, start_date, end_date, ex_dividend_start, ex_dividend_end, limit | Dividend Data | Financial Statements & Fundamentals |
/v1/finance/event-calendar | GET | symbol, start_date, end_date, limit | Event Calendar (R17) | Financial Statements & Fundamentals |
/v1/finance/event-confidence | GET | symbol, start_date, end_date, limit | Event Confidence (R7) | Financial Statements & Fundamentals |
/v1/finance/forecast | GET | symbol, date, start_date, end_date, limit | Earnings Forecast | Financial Statements & Fundamentals |
/v1/finance/holder-structure | GET | symbol, report_date, limit | Shareholder Structure (R14) | Financial Statements & Fundamentals |
/v1/finance/income | GET | symbol, date, start_date, end_date, limit | Income Statement | Financial Statements & Fundamentals |
/v1/finance/institute-recommend | GET | start_date, end_date, symbol, rating_type, limit | Institutional Ratings | Financial Statements & Fundamentals |
/v1/finance/lifting | GET | symbol, start_date, end_date, limit | Restricted Share Unlocks | Financial Statements & Fundamentals |
/v1/finance/ratios | GET | symbol, date, start_date, end_date, limit | Derived Financial Ratios (R9) | Financial Statements & Fundamentals |
/v1/finance/research-reports | GET | symbol, start_date, end_date, limit | Research Report Data (R8) | Financial Statements & Fundamentals |
/v1/finance/restricted-release-detail | GET | start_date, end_date, symbol, limit | Restricted Share Unlock Details | Financial Statements & Fundamentals |
/v1/finance/restricted-release-queue | GET | start_date, end_date, symbol, limit | Restricted Share Unlock Batches | Financial Statements & Fundamentals |
/v1/finance/restricted-release-stockholder | GET | start_date, end_date, symbol, shareholder_name, limit | Restricted Share Unlock Shareholder Details | Financial Statements & Fundamentals |
/v1/finance/restricted-release-summary | GET | start_date, end_date, limit | Restricted Share Unlock Summary | Financial Statements & Fundamentals |
/v1/finance/shares | GET | symbol, start_date, end_date, limit | Share Capital Changes | Financial Statements & Fundamentals |
/v1/finance/stock-repurchase | GET | start_date, end_date, symbol, progress, limit | Stock Repurchases | Financial Statements & Fundamentals |
/v1/finance/summary | GET | symbol, date, start_date, end_date, limit | Financial Summary | Financial Statements & Fundamentals |
Macroeconomic Indicators
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/macro/commodity-daily | GET | start_date, end_date, symbol, limit | Get international commodity daily-frequency data. | Macroeconomic Indicators |
/v1/macro/consumer-confidence | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/cpi | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/crypto-daily | GET | start_date, end_date, symbol, limit | Get crypto asset daily-frequency data. | Macroeconomic Indicators |
/v1/macro/deposit-rate | GET | start_date, end_date, limit | Get benchmark deposit rates. | Macroeconomic Indicators |
/v1/macro/energy-inventory | GET | start_date, end_date, indicator, item, limit | Get US crude oil inventory macro indicators. | Macroeconomic Indicators |
/v1/macro/enterprise-boom | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/epu-index | GET | start_date, end_date, country, limit | Get economic policy uncertainty index (monthly). | Macroeconomic Indicators |
/v1/macro/fdi | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/fixed-investment | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/forex-daily | GET | start_date, end_date, symbol, limit | Get forex daily-frequency data. | Macroeconomic Indicators |
/v1/macro/fx-reserves | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/fx-spot | GET | start_date, end_date, pair_name, limit | Get forex spot quote snapshots (retained daily). | Macroeconomic Indicators |
/v1/macro/gdp | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/global-index-daily | GET | start_date, end_date, symbol, limit | Get historical daily data for global core indices. | Macroeconomic Indicators |
/v1/macro/global-index-spot | GET | start_date, end_date, index_name, limit | Get global index real-time snapshots (retained daily). | Macroeconomic Indicators |
/v1/macro/global-risk-factor | GET | start_date, end_date, factor_name, limit | Get global risk factors (daily). | Macroeconomic Indicators |
/v1/macro/industrial-production | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/lpr | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/migration-area | GET | start_date, end_date, area, indicator, city_name, limit | Get China migration city distribution details (daily). | Macroeconomic Indicators |
/v1/macro/migration-scale | GET | start_date, end_date, area, indicator, limit | Get China migration scale index (daily). | Macroeconomic Indicators |
/v1/macro/money-supply | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/new-house-price | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/new-loans | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/oil-price-adjustment | GET | start_date, end_date, limit | Get China refined oil price adjustment history. | Macroeconomic Indicators |
/v1/macro/oil-price-region | GET | start_date, end_date, province, limit | Get China oil price details by region. | Macroeconomic Indicators |
/v1/macro/passenger-load-factor | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/pmi | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/ppi | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/real-estate | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/retail-sales | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/rrr | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/shibor | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/social-finance | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/society-electricity | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/trade-balance | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/traffic-volume | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
/v1/macro/urban-unemployment | GET | start_date, end_date, limit | Data query | Macroeconomic Indicators |
Capital & Money Flow
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/money-flow/capital-flow | GET | symbol, start_date, end_date, limit | Per-stock fund flow | Capital & Money Flow |
/v1/money-flow/capital-flow-detail | GET | symbol, start_date, end_date, limit | Fund flow breakdown (R12) | Capital & Money Flow |
/v1/money-flow/north-flow | GET | start_date, end_date, limit | Northbound funds | Capital & Money Flow |
/v1/money-flow/south-flow | GET | start_date, end_date, limit | Southbound funds | Capital & Money Flow |
Industry & Concept Sectors
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/sectors/concept | GET | limit | Concept List | Industry & Concept Sectors |
/v1/sectors/concept-code | GET | limit | Concept Code Table | Industry & Concept Sectors |
/v1/sectors/concept-ths | GET | concept_code, symbol, limit | THS Concept Constituents | Industry & Concept Sectors |
/v1/sectors/concept/constituents | GET | concept_code, symbol, limit | Concept Constituents | Industry & Concept Sectors |
/v1/sectors/industry | GET | page, page_size, keyword, exchange, industry_classification | Get Stock Industry Classification | Industry & Concept Sectors |
/v1/sectors/industry-sw | GET | industry_code, symbol, limit | Shenwan (SW) Industry | Industry & Concept Sectors |
/v1/sectors/plate | GET | limit | Industry Boards | Industry & Concept Sectors |
Market Rankings & Pools
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/rankings/dragon-tiger | GET | symbol, date, limit | Dragon-Tiger List | Market Rankings & Pools |
/v1/rankings/dt-pool | GET | date, limit | Limit-Down Pool | Market Rankings & Pools |
/v1/rankings/hot-concept | GET | limit, date | Hot Concepts Ranking | Market Rankings & Pools |
/v1/rankings/hot-stock | GET | limit, date | Tonghuashun (THS) Hot Stocks Ranking | Market Rankings & Pools |
/v1/rankings/hsgt-hold-rank | GET | start_date, end_date, market, indicator, symbol, limit | Stock Connect Holdings Ranking | Market Rankings & Pools |
/v1/rankings/pop-stock | GET | limit, date | East Money Popularity Ranking | Market Rankings & Pools |
/v1/rankings/risk-scan | GET | symbol, limit, date | Risk Screening Data | Market Rankings & Pools |
/v1/rankings/strong-pool | GET | date, limit | Strong Stocks Pool | Market Rankings & Pools |
/v1/rankings/zb-pool | GET | date, limit | Broken Limit Pool | Market Rankings & Pools |
/v1/rankings/zt-pool | GET | date, limit | Limit-Up Pool | Market Rankings & Pools |
/v1/rankings/zt-previous | GET | date, limit | Previous Day Limit-Up Pool | Market Rankings & Pools |
Multi-Factor Analytics & Screening
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/factors/backtest-data | GET | symbol, date, start_date, end_date, limit | Export backtest factor wide-table data (quotes + standardized factors + forward returns + market regime). | Multi-Factor Analytics & Screening |
/v1/factors/industries | GET | — | Factor Library Industry List | Multi-Factor Analytics & Screening |
/v1/factors/library | GET | symbol, date, start_date, end_date, industry, fields, limit | Get multi-factor standardized library data (7 dimensions: value/quality/momentum/capital/risk/expectation/governance + composite score). | Multi-Factor Analytics & Screening |
/v1/factors/performance | GET | start_date, end_date, factor | Factor Performance Statistics (IC/IR) | Multi-Factor Analytics & Screening |
/v1/factors/ranking | GET | factor, date, industry, top_n, limit, order, neutralize | Get the top-N stocks by cross-sectional ranking on the specified factor. | Multi-Factor Analytics & Screening |
/v1/stocks/compare | GET | symbols, date, fields | Multi-Stock Comparison | Multi-Factor Analytics & Screening |
/v1/stocks/screen | GET | pe_rank_max, pb_rank_max, roic_rank_min, roe_rank_min, momentum_1m_min, momentum_12m_min, beta_rank_max, composite_score_min, industry, sort, date, fields, weights, limit | Multi-Condition Stock Screening | Multi-Factor Analytics & Screening |
Futures Contracts
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/futures/commodity/history | GET | symbol, start_date, end_date, limit | Commodity Futures K-line (R4) | Futures Contracts |
/v1/futures/index/history | GET | symbol, start_date, end_date, limit | Stock Index Futures K-line (R1) | Futures Contracts |
/v1/futures/index/snapshot | GET | symbol, date | Stock Index Futures Snapshot (R2) | Futures Contracts |
/v1/futures/symbols | GET | — | Futures Products List | Futures Contracts |
News & Corporate Events
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/news/articles | GET | symbol, category, news_type, start_date, end_date, limit | News aggregation (R6) | News & Corporate Events |
Data Export
| Endpoint | Method | Key Parameters | Description | Guide |
|---|---|---|---|---|
/v1/export/history | GET | symbol, start_date, end_date, interval, format | Export Historical Data | Data Export |
Symbol Formats
Documentation examples use the canonical database-style format:
- Shenzhen A-Shares:
sz.000001 - Shanghai A-Shares:
sh.600519 - Beijing Exchange:
bj.830799 - Index Codes:
sh.000300(CSI 300),sz.399001(SZSE Component) - Futures Contracts:
IF(CSI 300 Index Futures),RB(Rebar)
Other accepted formats may be normalized by the API, but SDKs and integration scripts should use the canonical dotted format consistently.