# Overview
| Module | Interface Name | Function Description | |
|---|---|---|---|
| Real-time Data | Subscription | subscribe | Subscribe real-time market data |
| unsubscribe | Unsubscribe subscriptions | ||
| unsubscribe_all | Unsubscribe all subscriptions | ||
| query_subscription | Get subscription information | ||
| Push and Callback | StockQuoteHandlerBase | Real-time quote callback | |
| OrderBookHandlerBase | Real-time order book callback | ||
| CurKlineHandlerBase | Real-time candlestick callback | ||
| TickerHandlerBase | Real-time tick-by-tick callback | ||
| RTDataHandlerBase | Real-time time frame callback | ||
| BrokerHandlerBase | Real-time broker queue callback | ||
| Get | get_market_snapshot | Get market snapshot | |
| get_stock_quote | Get real-time quote | ||
| get_order_book | Get real-time order book | ||
| get_cur_kline | Get real-time candlestick | ||
| get_rt_data | Get real-time time frame data | ||
| get_rt_ticker | Get real-time tick-by-tick | ||
| get_broker_queue | Get real-time broker queue | ||
| Basic Data | get_market_state | Get market status of securities | |
| get_capital_flow | Get capital flow | ||
| get_capital_distribution | Get capital distribution | ||
| get_owner_plate | Get the stock ownership plate | ||
| request_history_kline | Get historical candlesticks | ||
| get_rehab | Get the stock adjustment factor | ||
| get_financials_earnings_price_move | Get Earnings Price Move | ||
| get_financials_earnings_price_history | Get Earnings Price History | ||
| get_financials_statements | Get Financial Statements | ||
| get_financials_revenue_breakdown | Get Revenue Breakdown | ||
| get_research_analyst_consensus | Get Research Analyst Consensus | ||
| get_research_rating_summary | Get Research Rating Summary | ||
| get_research_morningstar_report | Get Morningstar Research Report | ||
| get_valuation_detail | Get Valuation Detail | ||
| get_valuation_plate_stock_list | Get Valuation Plate Stock List | ||
| get_corporate_actions_dividends | Get Corporate Actions - Dividends | ||
| get_corporate_actions_buybacks | Get Corporate Actions - Buybacks | ||
| get_corporate_actions_stock_splits | Get Corporate Actions - Stock Splits | ||
| get_shareholders_overview | Get Shareholders Overview | ||
| get_shareholders_holding_changes | Get Shareholders Holding Changes | ||
| get_shareholders_holder_detail | Get Shareholders Holder Detail | ||
| get_shareholders_institutional | Get Institutional Holdings | ||
| get_insider_holder_list | Get Insider Holder List | ||
| get_insider_trade_list | Get Insider Trade List | ||
| get_company_profile | Get Company Profile | ||
| get_company_executives | Get Company Executives | ||
| get_company_executive_background | Get Company Executive Background | ||
| get_company_operational_efficiency | Get Company Operational Efficiency | ||
| get_top_ten_buy_sell_brokers | Get Top Ten Buy/Sell Brokers | ||
| get_daily_short_volume | Get Daily Short Volume | ||
| get_short_interest | Get Short Interest | ||
| Related Derivatives | get_option_expiration_date | Query all expiration dates of option chains through the underlying stock. | |
| get_option_chain | Get the option chain from an underlying stock | ||
| get_warrant | Get filtered warrant (for HK market only) | ||
| get_referencestock_list | Get related data of securities | ||
| get_future_info | Get futures contract information | ||
| get_option_volatility | Get Option Volatility | ||
| get_option_exercise_probability | Get Option Exercise Probability | ||
| Market Filter | get_stock_filter | Filter stocks by condition | |
| get_plate_stock | Get the list of stocks in the plate | ||
| get_plate_list | Get plate list | ||
| get_stock_basicinfo | Get stock basic information | ||
| get_ipo_list | Get IPO information of a specific market | ||
| get_global_state | Get global status | ||
| request_trading_days | Get trading calendar | ||
| Customization | get_history_kl_quota | Get usage details of historical candlestick quota | |
| set_price_reminder | Add, delete, modify, enable, and disable price reminders for specified stocks | ||
| get_price_reminder | Get a list of price reminders set for the specified stock or market | ||
| get_user_security_group | Get a list of groups from the user watchlist | ||
| get_user_security | Get a list of a specified group from watchlist | ||
| modify_user_security | Modify the specific group from the watchlist | ||
| PriceReminderHandlerBase | The price reminder notification callback | ||