API Reference
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, futures info, option volatility and exercise probability.
- Market Screening — Stock screen, warrant screen, option screen with multi-dimensional filters.
- IPO — IPO lists for HK, US, A-share, MY, SG markets.
- 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.
- 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.
See Also
- Getting Started - Learn the API Host, choose an authentication method, and make your first request.
- Rate Limit - Quotas and back-off behavior.