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

EndpointMethodKey ParametersDescriptionGuide
/v1/markets/block-trade-dailyGETstart_date, end_date, limitBlock-Trade Market StatisticsMarket Data
/v1/markets/block-trade-detailGETsymbol, date, limitBlock-Trade DetailMarket Data
/v1/markets/board-summaryGETexchange, date, item, limitSector Trading SummaryMarket Data
/v1/markets/bond/profileGETsymbol, limitGet comprehensive bond information summary data (DWS).Market Data
/v1/markets/calendarGETexchange, start_date, end_date, is_trading_day, page, page_sizeTrade calendar query (with trading-day determination)Market Data
/v1/markets/finance/analyst-consensusGETsymbol, date, start_date, end_date, limitGet analyst consensus estimate summary data (DWS).Market Data
/v1/markets/finance/forecast-summaryGETsymbol, date, start_date, end_date, limitGet earnings forecast and express report summary data (DWS).Market Data
/v1/markets/finance/growthGETsymbol, date, start_date, end_date, limitGet financial growth indicator data (DWS).Market Data
/v1/markets/historyGETsymbol, interval, start_date, end_date, adjustGet raw OHLCV data export.Market Data
/v1/markets/hsgt-stock-statisticsGETstart_date, end_date, symbol, limitNorthbound Holdings StatisticsMarket Data
/v1/markets/ivixGETunderlying, start_date, end_date, limitETF Options iVIX (R3)Market Data
/v1/markets/marginGETstart_date, end_date, limitMargin Trading Market SummaryMarket Data
/v1/markets/margin-detailGETstart_date, end_date, exchange, symbol, limitPer-Stock Margin DetailMarket Data
/v1/markets/options/snapshotGETunderlying, contract_code, date, limitOptions Quote SnapshotMarket Data
/v1/markets/suspend-resume-eventsGETstart_date, end_date, symbol, market, limitTrading Halt & Resumption EventsMarket Data

Chart Generation

EndpointMethodKey ParametersDescriptionGuide
/v1/markets/chart/batchPOST—Batch-generate multiple charts.Chart Generation
/v1/markets/chart/storagePOST—Generate K-line chart compatible with chart-img.comChart Generation

Market Intelligence & Aggregation

EndpointMethodKey ParametersDescriptionGuide
/v1/markets/macro/dashboardGETstart_date, end_date, indicators, limitGet macroeconomic dashboard summary data (DWS).Market Intelligence & Aggregation
/v1/markets/market-breadthGETdate, start_time, end_time, limitGet intraday market breadth summary.Market Intelligence & Aggregation
/v1/markets/market/dragon-tiger-statsGETsymbol, date, start_date, end_date, limitGet Dragon-Tiger list statistics summary data (DWS).Market Intelligence & Aggregation
/v1/markets/market/hot-stock-trendGETsymbol, date, start_date, end_date, limitGet hot stock trend summary.Market Intelligence & Aggregation
/v1/markets/market/hsgt-summaryGETstart_date, end_date, market_type, limitGet Stock Connect flow summary data (DWS).Market Intelligence & Aggregation
/v1/markets/market/limit-statsGETsymbol, date, start_date, end_date, limitGet limit-up/limit-down statistics summary data (DWS).Market Intelligence & Aggregation
/v1/markets/market/margin-summaryGETstart_date, end_date, limitGet margin trading & short selling summary data (DWS).Market Intelligence & Aggregation
/v1/markets/market/regimeGETdateGet market regime summary.Market Intelligence & Aggregation
/v1/markets/market/sentimentGETdateGet market sentiment summary.Market Intelligence & Aggregation
/v1/markets/momentumGETsymbol, date, start_time, end_time, limitGet intraday momentum summary.Market Intelligence & Aggregation
/v1/markets/opportunity/watchlistGETdate, watch_action, limitGet opportunity watchlist summary.Market Intelligence & Aggregation
/v1/markets/risk/invalidationGETsymbol, logic_type, date, limitGet risk invalidation/revocation logic summary.Market Intelligence & Aggregation
/v1/markets/sector-pulseGETsector_name, date, start_time, end_time, limitGet intraday sector pulse summary.Market Intelligence & Aggregation
/v1/markets/sector/breadthGETdate, sector_type, limitGet sector breadth summary.Market Intelligence & Aggregation
/v1/markets/sector/concept-heatGETplate_code, date, start_date, end_date, limitGet concept heat summary.Market Intelligence & Aggregation
/v1/markets/sector/rotationGETdate, sector_type, limitGet sector rotation summary.Market Intelligence & Aggregation
/v1/markets/stock/event-timelineGETsymbol, start_date, end_date, limitGet single-stock event timeline summary.Market Intelligence & Aggregation
/v1/markets/stock/pledge-riskGETsymbol, date, start_date, end_date, limitGet stock pledge risk summary data (DWS).Market Intelligence & Aggregation
/v1/markets/stock/profileGETsymbol, limitGet stock profile summary data (DWS).Market Intelligence & Aggregation
/v1/markets/stock/shareholder-activityGETsymbol, date, start_date, end_date, limitGet shareholder activity summary data (DWS).Market Intelligence & Aggregation
/v1/markets/stock/snapshotGETsymbol, dateGet single-stock snapshot summary.Market Intelligence & Aggregation

Securities (Stocks, Indices, Funds, Bonds)

EndpointMethodKey ParametersDescriptionGuide
/v1/bonds/detailGETsymbol, limitBond DetailsSecurities
/v1/bonds/historyGETsymbol, interval, start_date, end_date, limitBond Historical QuotesSecurities
/v1/bonds/infoGETpage, page_size, keyword, exchange, security_typeGet Bond ListSecurities
/v1/funds/historyGETsymbol, interval, start_date, end_date, limitFund Historical QuotesSecurities
/v1/funds/infoGETpage, page_size, keyword, exchange, security_typeFund ListSecurities
/v1/indices/historyGETsymbol, interval, start_date, end_date, limitIndex Historical QuotesSecurities
/v1/indices/infoGETpage, page_size, keyword, exchangeGet Index ListSecurities
/v1/stocks/adjust-factorGETsymbol, start_date, end_date, limitData querySecurities
/v1/stocks/daily-basicGETsymbol, date, start_date, end_date, sort_by, order, page, page_sizeDaily Per-Stock Indicator Master TableSecurities
/v1/stocks/delistedGETexchange, start_date, end_date, limitDelisted Stock ListSecurities
/v1/stocks/esg-ratingGETsymbol, dateStock ESG RatingSecurities
/v1/stocks/index-constituentsGETindex_codeIndex Constituents (R19)Securities
/v1/stocks/infoGETpage, page_size, keyword, exchange, security_typeGet Stock ListSecurities
/v1/stocks/ipoGETstart_date, end_date, limitIPO Stock ListSecurities
/v1/stocks/listGETpage, page_size, keyword, exchange, security_typeGet Stock ListSecurities
/v1/stocks/name-historyGETsymbol, limitStock Former-Name HistorySecurities
/v1/stocks/profileGETsymbolStock Basic Info/ProfileSecurities
/v1/stocks/risk-boardGETlimitRisk Warning Board/ST StocksSecurities
/v1/stocks/searchGETq, limitStock SearchSecurities

Technical Indicators

EndpointMethodKey ParametersDescriptionGuide
/v1/indicators/adxGETsymbol, start_date, end_date, timeperiod, limitGet Average Directional Index (ADX).Technical Indicators
/v1/indicators/atrGETsymbol, start_date, end_date, timeperiod, limitGet Average True Range (ATR).Technical Indicators
/v1/indicators/bbandsGETsymbol, start_date, end_date, timeperiod, stds, limitGet Bollinger Bands indicatorTechnical Indicators
/v1/indicators/emaGETsymbol, start_date, end_date, timeperiod, series_type, limitData queryTechnical Indicators
/v1/indicators/kdjGETsymbol, start_date, end_date, fastk_period, slowk_period, slowd_period, limitData queryTechnical Indicators
/v1/indicators/maGETsymbol, start_date, end_date, timeperiod, series_type, limitData queryTechnical Indicators
/v1/indicators/macdGETsymbol, start_date, end_date, fastperiod, slowperiod, signalperiod, limitGet MACD indicator data.Technical Indicators
/v1/indicators/obvGETsymbol, start_date, end_date, limitGet On-Balance Volume (OBV) indicator.Technical Indicators
/v1/indicators/rsiGETsymbol, start_date, end_date, timeperiod, limitGet RSI indicator data.Technical Indicators
/v1/indicators/stochGETsymbol, start_date, end_date, fastk_period, slowk_period, slowd_period, limitGet Stochastic Oscillator.Technical Indicators
/v1/indicators/ticker_infoGETsymbolGet stock basic information. Requires API key authentication.Technical Indicators
/v1/indicators/time_seriesGETsymbol, start_date, end_date, adjust, limitGet K-line (candlestick) data and technical indicators (with TA)Technical Indicators
/v1/indicators/vwapGETsymbol, start_date, end_date, limitGet Volume-Weighted Average Price (VWAP).Technical Indicators

Financial Statements & Fundamentals

EndpointMethodKey ParametersDescriptionGuide
/v1/finance/balanceGETsymbol, date, start_date, end_date, limitBalance SheetFinancial Statements & Fundamentals
/v1/finance/cash-flowGETsymbol, date, start_date, end_date, limitCash Flow StatementFinancial Statements & Fundamentals
/v1/finance/core-indexGETsymbol, date, start_date, end_date, limitCore Financial IndicatorsFinancial Statements & Fundamentals
/v1/finance/dividendGETsymbol, date, start_date, end_date, ex_dividend_start, ex_dividend_end, limitDividend DataFinancial Statements & Fundamentals
/v1/finance/event-calendarGETsymbol, start_date, end_date, limitEvent Calendar (R17)Financial Statements & Fundamentals
/v1/finance/event-confidenceGETsymbol, start_date, end_date, limitEvent Confidence (R7)Financial Statements & Fundamentals
/v1/finance/forecastGETsymbol, date, start_date, end_date, limitEarnings ForecastFinancial Statements & Fundamentals
/v1/finance/holder-structureGETsymbol, report_date, limitShareholder Structure (R14)Financial Statements & Fundamentals
/v1/finance/incomeGETsymbol, date, start_date, end_date, limitIncome StatementFinancial Statements & Fundamentals
/v1/finance/institute-recommendGETstart_date, end_date, symbol, rating_type, limitInstitutional RatingsFinancial Statements & Fundamentals
/v1/finance/liftingGETsymbol, start_date, end_date, limitRestricted Share UnlocksFinancial Statements & Fundamentals
/v1/finance/ratiosGETsymbol, date, start_date, end_date, limitDerived Financial Ratios (R9)Financial Statements & Fundamentals
/v1/finance/research-reportsGETsymbol, start_date, end_date, limitResearch Report Data (R8)Financial Statements & Fundamentals
/v1/finance/restricted-release-detailGETstart_date, end_date, symbol, limitRestricted Share Unlock DetailsFinancial Statements & Fundamentals
/v1/finance/restricted-release-queueGETstart_date, end_date, symbol, limitRestricted Share Unlock BatchesFinancial Statements & Fundamentals
/v1/finance/restricted-release-stockholderGETstart_date, end_date, symbol, shareholder_name, limitRestricted Share Unlock Shareholder DetailsFinancial Statements & Fundamentals
/v1/finance/restricted-release-summaryGETstart_date, end_date, limitRestricted Share Unlock SummaryFinancial Statements & Fundamentals
/v1/finance/sharesGETsymbol, start_date, end_date, limitShare Capital ChangesFinancial Statements & Fundamentals
/v1/finance/stock-repurchaseGETstart_date, end_date, symbol, progress, limitStock RepurchasesFinancial Statements & Fundamentals
/v1/finance/summaryGETsymbol, date, start_date, end_date, limitFinancial SummaryFinancial Statements & Fundamentals

Macroeconomic Indicators

EndpointMethodKey ParametersDescriptionGuide
/v1/macro/commodity-dailyGETstart_date, end_date, symbol, limitGet international commodity daily-frequency data.Macroeconomic Indicators
/v1/macro/consumer-confidenceGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/cpiGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/crypto-dailyGETstart_date, end_date, symbol, limitGet crypto asset daily-frequency data.Macroeconomic Indicators
/v1/macro/deposit-rateGETstart_date, end_date, limitGet benchmark deposit rates.Macroeconomic Indicators
/v1/macro/energy-inventoryGETstart_date, end_date, indicator, item, limitGet US crude oil inventory macro indicators.Macroeconomic Indicators
/v1/macro/enterprise-boomGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/epu-indexGETstart_date, end_date, country, limitGet economic policy uncertainty index (monthly).Macroeconomic Indicators
/v1/macro/fdiGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/fixed-investmentGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/forex-dailyGETstart_date, end_date, symbol, limitGet forex daily-frequency data.Macroeconomic Indicators
/v1/macro/fx-reservesGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/fx-spotGETstart_date, end_date, pair_name, limitGet forex spot quote snapshots (retained daily).Macroeconomic Indicators
/v1/macro/gdpGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/global-index-dailyGETstart_date, end_date, symbol, limitGet historical daily data for global core indices.Macroeconomic Indicators
/v1/macro/global-index-spotGETstart_date, end_date, index_name, limitGet global index real-time snapshots (retained daily).Macroeconomic Indicators
/v1/macro/global-risk-factorGETstart_date, end_date, factor_name, limitGet global risk factors (daily).Macroeconomic Indicators
/v1/macro/industrial-productionGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/lprGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/migration-areaGETstart_date, end_date, area, indicator, city_name, limitGet China migration city distribution details (daily).Macroeconomic Indicators
/v1/macro/migration-scaleGETstart_date, end_date, area, indicator, limitGet China migration scale index (daily).Macroeconomic Indicators
/v1/macro/money-supplyGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/new-house-priceGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/new-loansGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/oil-price-adjustmentGETstart_date, end_date, limitGet China refined oil price adjustment history.Macroeconomic Indicators
/v1/macro/oil-price-regionGETstart_date, end_date, province, limitGet China oil price details by region.Macroeconomic Indicators
/v1/macro/passenger-load-factorGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/pmiGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/ppiGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/real-estateGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/retail-salesGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/rrrGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/shiborGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/social-financeGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/society-electricityGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/trade-balanceGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/traffic-volumeGETstart_date, end_date, limitData queryMacroeconomic Indicators
/v1/macro/urban-unemploymentGETstart_date, end_date, limitData queryMacroeconomic Indicators

Capital & Money Flow

EndpointMethodKey ParametersDescriptionGuide
/v1/money-flow/capital-flowGETsymbol, start_date, end_date, limitPer-stock fund flowCapital & Money Flow
/v1/money-flow/capital-flow-detailGETsymbol, start_date, end_date, limitFund flow breakdown (R12)Capital & Money Flow
/v1/money-flow/north-flowGETstart_date, end_date, limitNorthbound fundsCapital & Money Flow
/v1/money-flow/south-flowGETstart_date, end_date, limitSouthbound fundsCapital & Money Flow

Industry & Concept Sectors

EndpointMethodKey ParametersDescriptionGuide
/v1/sectors/conceptGETlimitConcept ListIndustry & Concept Sectors
/v1/sectors/concept-codeGETlimitConcept Code TableIndustry & Concept Sectors
/v1/sectors/concept-thsGETconcept_code, symbol, limitTHS Concept ConstituentsIndustry & Concept Sectors
/v1/sectors/concept/constituentsGETconcept_code, symbol, limitConcept ConstituentsIndustry & Concept Sectors
/v1/sectors/industryGETpage, page_size, keyword, exchange, industry_classificationGet Stock Industry ClassificationIndustry & Concept Sectors
/v1/sectors/industry-swGETindustry_code, symbol, limitShenwan (SW) IndustryIndustry & Concept Sectors
/v1/sectors/plateGETlimitIndustry BoardsIndustry & Concept Sectors

Market Rankings & Pools

EndpointMethodKey ParametersDescriptionGuide
/v1/rankings/dragon-tigerGETsymbol, date, limitDragon-Tiger ListMarket Rankings & Pools
/v1/rankings/dt-poolGETdate, limitLimit-Down PoolMarket Rankings & Pools
/v1/rankings/hot-conceptGETlimit, dateHot Concepts RankingMarket Rankings & Pools
/v1/rankings/hot-stockGETlimit, dateTonghuashun (THS) Hot Stocks RankingMarket Rankings & Pools
/v1/rankings/hsgt-hold-rankGETstart_date, end_date, market, indicator, symbol, limitStock Connect Holdings RankingMarket Rankings & Pools
/v1/rankings/pop-stockGETlimit, dateEast Money Popularity RankingMarket Rankings & Pools
/v1/rankings/risk-scanGETsymbol, limit, dateRisk Screening DataMarket Rankings & Pools
/v1/rankings/strong-poolGETdate, limitStrong Stocks PoolMarket Rankings & Pools
/v1/rankings/zb-poolGETdate, limitBroken Limit PoolMarket Rankings & Pools
/v1/rankings/zt-poolGETdate, limitLimit-Up PoolMarket Rankings & Pools
/v1/rankings/zt-previousGETdate, limitPrevious Day Limit-Up PoolMarket Rankings & Pools

Multi-Factor Analytics & Screening

EndpointMethodKey ParametersDescriptionGuide
/v1/factors/backtest-dataGETsymbol, date, start_date, end_date, limitExport backtest factor wide-table data (quotes + standardized factors + forward returns + market regime).Multi-Factor Analytics & Screening
/v1/factors/industriesGET—Factor Library Industry ListMulti-Factor Analytics & Screening
/v1/factors/libraryGETsymbol, date, start_date, end_date, industry, fields, limitGet multi-factor standardized library data (7 dimensions: value/quality/momentum/capital/risk/expectation/governance + composite score).Multi-Factor Analytics & Screening
/v1/factors/performanceGETstart_date, end_date, factorFactor Performance Statistics (IC/IR)Multi-Factor Analytics & Screening
/v1/factors/rankingGETfactor, date, industry, top_n, limit, order, neutralizeGet the top-N stocks by cross-sectional ranking on the specified factor.Multi-Factor Analytics & Screening
/v1/stocks/compareGETsymbols, date, fieldsMulti-Stock ComparisonMulti-Factor Analytics & Screening
/v1/stocks/screenGETpe_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, limitMulti-Condition Stock ScreeningMulti-Factor Analytics & Screening

Futures Contracts

EndpointMethodKey ParametersDescriptionGuide
/v1/futures/commodity/historyGETsymbol, start_date, end_date, limitCommodity Futures K-line (R4)Futures Contracts
/v1/futures/index/historyGETsymbol, start_date, end_date, limitStock Index Futures K-line (R1)Futures Contracts
/v1/futures/index/snapshotGETsymbol, dateStock Index Futures Snapshot (R2)Futures Contracts
/v1/futures/symbolsGET—Futures Products ListFutures Contracts

News & Corporate Events

EndpointMethodKey ParametersDescriptionGuide
/v1/news/articlesGETsymbol, category, news_type, start_date, end_date, limitNews aggregation (R6)News & Corporate Events

Data Export

EndpointMethodKey ParametersDescriptionGuide
/v1/export/historyGETsymbol, start_date, end_date, interval, formatExport Historical DataData 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.