Market Data
Market data queries for stocks, futures, options, funds, crypto, and warrants/CBBCs, plus real-time market data subscriptions.
| Page | Description |
|---|---|
| Common | Market status, trading calendar, contract basic info |
| Stocks | US/HK real-time quotes, bars, trade ticks, depth |
| Futures | Futures contract quotes and bars |
| Options | Option chains and option quotes |
| Crypto | Cryptocurrency quotes with decimal volume for bars and current timelines |
| Funds | Fund NAV and quotes |
| Warrants & CBBCs | HK derivative quotes |
| Market Scanner | Multi-condition stock screening |
| Streaming Market Data | Real-time market data subscriptions over TLS/Protobuf by default |
API List
Common
| Method | Description |
|---|---|
| grab_quote_permission | Claim market data device access |
| get_quote_permission | Query market data permissions |
| get_kline_quota | Historical quote quota |
Stocks
| Method | Description |
|---|---|
| get_market_status | Get Market State |
| get_trading_calendar | Get market trading calendar |
| get_symbols | Get all symbols |
| get_symbol_names | Get codes and names list |
| get_stock_briefs | Get real-time stock quotes |
| get_depth_quote | Get market depth (order book) |
| get_trade_ticks | Get trade ticks |
| get_bars | Get candlestick bars |
| get_bars_by_page | Get candlestick bars with pagination |
| get_timeline | Get latest trading day timeline |
| get_timeline_history | Get historical timeline data |
| get_stock_delay_briefs | Get delayed stock quotes |
| get_trade_metas | Get stock trading information |
| get_capital_flow | Get stock capital flow data |
| get_capital_distribution | Get stock capital distribution |
| get_stock_broker | Get HK broker buy/sell seats |
| get_broker_hold | Get HK broker holding market cap |
| get_trade_rank | Hot trading rankings |
Futures
| Method | Description |
|---|---|
| get_future_exchanges | Get futures exchange list |
| get_future_contracts | Get tradable contracts by exchange |
| get_future_contract | Get contract by code |
| get_current_future_contract | Get current main contract for a product |
| get_all_future_contracts | Get all contracts for a product |
| get_future_continuous_contracts | Get continuous contracts for a product |
| get_future_trading_times | Get trading hours for a contract |
| get_future_brief | Get latest futures quotes |
| get_future_depth | Get futures market depth (order book) |
| get_future_trade_ticks | Get futures trade ticks |
| get_future_bars | Get futures bars |
| get_future_bars_by_page | Get futures bars with pagination |
Options
| Method | Description |
|---|---|
| get_option_expirations | Get option expiration dates |
| get_option_briefs | Get real-time option quotes |
| get_option_chain | Get option chain |
| get_option_depth | Get option market depth (order book) |
| get_option_trade_ticks | Get option trade ticks |
| get_option_bars | Get option candlestick bars |
| get_option_timeline | Get option timeline data |
| get_option_symbols | Get HK option codes |
| get_option_analysis | Get option analysis metrics |
Crypto
| Method | Description |
|---|---|
| get_symbols | Get cryptocurrency codes |
| get_cc_briefs | Get real-time crypto quotes |
| get_bars | Get crypto bars with decimal volume_decimal |
| get_timeline | Get current crypto timeline with decimal volume_decimal |
Funds
| Method | Description |
|---|---|
| get_fund_symbols | Get fund codes |
| get_fund_contracts | Get fund contract information |
| get_fund_quote | Get latest fund quotes |
| get_fund_history_quote | Get historical fund quotes |
Market Scanner
| Method | Description |
|---|---|
| market_scanner | Multi-condition stock screening |
Updated about 1 month ago
Did this page help you?