Quote API Overview
Quote APIs provide real-time and historical market data covering Hong Kong, US, A-share, Singapore, Japan, Australia, Canada, Malaysia, Korea and more.
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.
- Plate / Sector — Plate list, 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, modify watchlist.
- Stock Deep Data — Financials, research, valuation, corporate actions, 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.
Security Code Format
All quote APIs use a unified security code format: {MARKET}.{CODE}
| Market | Prefix | Example |
|---|---|---|
| Hong Kong | HK | HK.00700, HK.09988 |
| US | US | US.AAPL, US.TSLA |
| Shanghai | SH | SH.600519 |
| Shenzhen | SZ | SZ.000001 |
| Singapore | SG | SG.D05 |
| Japan | JP | JP.9984 |
| Australia | AU | AU.BHP |
| Canada | CA | CA.SHOP |
| Malaysia | BMS | BMS.1155 |
| Korea | KR | KR.005930 |
Pagination and responses
Existing endpoints use next_key/limit/has_more or page_flag/page_size/completed; historical K-lines also support page_token. Follow pagination and the endpoint’s contract instead of mixing parameter names.
Most endpoints use ret_code/ret_msg/data; some published endpoints use code/message/data. Error envelopes also vary by endpoint. Business failures generally still return HTTP 200, so inspect the business code.
Some pass-through fields return null when no value is available. This differs from an omitted field, an empty array or numeric zero. OpenAPI marks nullable fields with nullable: true; preserve these distinctions.
Quotas
Standard history, option-chain history and subscription usage are counted separately.
Reference
- Naming Dictionary — Enum value lookup table for all enumeration types used across quote APIs.