API Guide

Browse endpoints, inspect parameters, and copy ready-to-run requests.

Categories

• Real-time Quote — Market snapshot, stock quote, order book, current K-line, time-sharing data, tick-by-tick trades.
• Basic Data — Stock basic info, trading days, rehabilitation factor, owner plate, history K-line, market state.
• Capital Flow — Intraday and historical capital flow, capital distribution by order size.
• Plate / Sector — Plate list and plate constituent stocks.
• Derivatives — Reference futures, option expiration dates, option chain, combo option strategy/spread/quote, futures info, option volatility and exercise probability.
• Market Screening — Stock screen, warrant screen, option screen with multi-dimensional filters.
• IPO — IPO lists by market: HK, US, SG, MY, CN, and JP.
• Watchlist — User security list, security groups, add/remove watchlist.
• Stock Deep Data — Financials (earnings, statements, revenue breakdown), research (analyst consensus, ratings, Morningstar), valuation, corporate actions (dividends, buybacks, splits), shareholders, company profile and executives.
• Short Selling — Daily short volume and short interest data.
• Calendar — Dividend calendar and earnings calendar.
• Rankings — Pre-market, after-hours, movers, heat, short selling, dividends, and earnings beats.
• ARK — ARK holdings, trades, and return.
• Institutions — Institution list, profile, holdings, and industry mix.
• Industry Chain — Chains, plates, and heatmap.
• Macro — Indicators, history, and FedWatch.
• Crypto — Fear-and-greed, market overview, and institutional holdings.
• Event Contracts — Categories, contracts, and combo quotes.
• Quote Push — WebSocket quote push: auth, subscribe, heartbeat, data format, error codes and rate limits.
• Account & Positions — Authorized trading accounts, account funds, position list.
• Trading — Place order, modify order, cancel order, order confirm, max trade quantity.
• Orders — Open orders, history orders, order details.
• Deals — Today's deals, history deals.
• Trade Event Push — Real-time push for trade events, including order placement, modification, cancellation, and fills.
• Simulated Trading — Simulated accounts, funds, positions, place/modify/cancel orders, orders, history orders, max buy/sell quantity.
• Crypto Account & Positions — Authorized trading accounts, total balance.
• Crypto Trading — Place order, modify order, cancel order, get maximum buy/sell quantity.
• Crypto Orders — Active orders, order history, order details.
• Crypto Deals — Fill details, fill history.
• Crypto Trade Event Push — WebSocket real-time push: auth, subscription, event handling, data format, error codes.

See Also

• Getting Started - Learn the API Host, choose an authentication method, and make your first request.
• Rate Limit - Quotas and back-off behavior.