DOCUMENTATION
Data Endpoint Reference
Quick reference for public data APIs, key parameters, and response types.
Data Endpoint Reference
Use this page to discover available datasets. Each section links to the relevant topic guide for authentication, examples, and complete request details. The machine-readable contract is available at /openapi.json.
Unless noted otherwise, endpoints use GET, require X-API-Key, and return JSON.
Market Data
| Endpoint | Key parameters | Response | Guide |
|---|---|---|---|
/v1/markets/history | symbol, interval, start_date, end_date, adjust | OHLCV time series | Market Data |
/v1/markets/calendar | exchange, date range, pagination | Trading calendar | Market Data |
/v1/markets/margin | Date range, limit | Market margin summary | Market Data |
/v1/markets/margin-detail | symbol, date range, limit | Stock-level margin records | Market Data |
/v1/markets/block-trade-daily | Date range, limit | Daily block-trade statistics | Market Data |
/v1/markets/block-trade-detail | symbol, date range, limit | Block-trade transactions | Market Data |
/v1/markets/options/snapshot | underlying, contract_code, date | Option market snapshot | Market Data |
/v1/export/history | symbol, date range, format | CSV or JSON download | Market Data |
Securities
| Endpoint | Key parameters | Response | Guide |
|---|---|---|---|
/v1/stocks/info | keyword, exchange, security_type, pagination | Stock directory | Stock Data |
/v1/stocks/profile | symbol | Company profile | Stock Data |
/v1/stocks/daily-basic | symbol, date range, pagination | Daily valuation and trading metrics | Stock Data |
/v1/stocks/screen | factor ranks, industry, weights, limit | Multi-condition stock screener | Factor Analytics |
/v1/stocks/compare | symbols, fields, date | Multi-stock factor comparison | Factor Analytics |
/v1/stocks/search | q, limit | Stock fuzzy search | Stock Data |
/v1/stocks/adjust-factor | symbol, date range | Adjustment factors | Stock Data |
/v1/stocks/name-history | symbol, limit | Historical company names | Stock Data |
/v1/stocks/ipo | Date range, limit | IPO and listing records | Stock Data |
/v1/stocks/risk-board | symbol, limit | Risk-warning securities | Stock Data |
/v1/stocks/delisted | symbol, limit | Delisted securities | Stock Data |
/v1/indices/info | keyword, exchange, pagination | Index directory | Stock Data |
/v1/indices/history | symbol, interval, date range | Index OHLCV history | Stock Data |
/v1/funds/info | keyword, exchange, pagination | Fund and ETF directory | Stock Data |
/v1/funds/history | symbol, interval, date range | Fund OHLCV history | Stock Data |
/v1/bonds/info | keyword, exchange, pagination | Bond directory | Stock Data |
/v1/bonds/detail | symbol, limit | Convertible bond details | Stock Data |
/v1/bonds/history | symbol, interval, date range | Bond OHLCV history | Stock Data |
Analytics
| Endpoint group | Common parameters | Response | Guide |
|---|---|---|---|
/v1/indicators/* | symbol, interval, date range, indicator periods | Technical indicator series | Indicators |
/v1/finance/* | symbol, report/date range, limit | Financial statements and corporate actions | Finance Data |
/v1/finance/ratios | symbol, date, limit | Derived financial ratios (ROE/ROIC/EPS/leverage) | Finance Data |
/v1/finance/holder-structure | symbol, report_date, limit | Shareholder count and top-10 free holders | Finance Data |
/v1/finance/research-reports | symbol, date range, limit | Sell-side research and institutional visits | Finance Data |
/v1/finance/event-calendar | symbol, date range, limit | Event calendar (dividend / suspend / unlock) | Finance Data |
/v1/finance/event-confidence | symbol, date range, limit | Event confidence scores | Finance Data |
/v1/money-flow/* | symbol, date range, limit | Capital-flow series | Market Flow |
/v1/money-flow/capital-flow-detail | symbol, date range, limit | Decomposed capital flow + rolling aggregates | Market Flow |
/v1/sectors/* | Sector code, symbol, pagination | Sector and constituent data | Sector Data |
/v1/rankings/* | date, symbol, limit | Rankings and market pools | Ranking |
/v1/macro/* | Date range, limit | Macro and cross-market series | Macro Data |
/v1/markets/stock/* | symbol, date range | Stock-level analytical summaries | Stock Information |
/v1/markets/market/* | Date range, limit | Market state, sentiment, and breadth | Market Data |
/v1/markets/sector/* | date, sector filters, limit | Sector rotation, heat, and breadth | Sector Data |
Factor Analytics
| Endpoint | Key parameters | Response | Guide |
|---|---|---|---|
/v1/factors/library | symbol, date, industry, fields | Multi-factor standardized library | Factor Analytics |
/v1/factors/ranking | factor, date, industry, top_n, order, neutralize | Cross-sectional ranking | Factor Analytics |
/v1/factors/industries | — | Shenwan Level-1 industry list | Factor Analytics |
/v1/factors/performance | start_date, end_date, factor | Factor IC / IC_IR / win rate | Factor Analytics |
/v1/factors/backtest-data | symbol, date range, limit | Backtest wide table with forward returns | Factor Analytics |
Futures
| Endpoint | Key parameters | Response | Guide |
|---|---|---|---|
/v1/futures/index/history | symbol (IF/IC/IM/IH), date range, limit | Stock-index futures main-contract kline | Futures Data |
/v1/futures/commodity/history | symbol (RB/SC/AU…), date range, limit | Commodity futures main-contract kline | Futures Data |
/v1/futures/index/snapshot | symbol | Latest index-futures quote and basis | Futures Data |
/v1/futures/symbols | — | Available futures contract list | Futures Data |
News
| Endpoint | Key parameters | Response | Guide |
|---|---|---|---|
/v1/news/articles | symbol, category, news_type, date range, limit | Stock and macro news aggregation | News |
Symbol Format
Documentation examples use the canonical database-style format:
- Shenzhen:
sz.000001 - Shanghai:
sh.600519
Other accepted formats may be normalized by the API, but SDKs and scripts should use this format consistently.