Quote API Overview
Quote APIs provide real-time and historical market data covering Hong Kong, US, A-share, Singapore, Japan, Australia, Canada, Malaysia 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, 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, modify watchlist.
- Stock Deep Data — Financials, research, valuation, corporate actions, 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.
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 |
Pagination Convention
All list-based endpoints follow a unified pagination convention.
Request parameters:
| Parameter | Type | Description |
|---|---|---|
next_key | string | Pagination cursor. Leave empty "" for the first page. Pass back the pagination.next_key from the previous response to fetch the next page. |
limit | int | Page size (each endpoint has its own default and maximum). |
Response: Pagination info is placed in the top-level pagination object:
| Field | Type | Description |
|---|---|---|
has_more | bool | Whether there is a next page. Use has_more=false as the only signal to stop paginating. |
next_key | string | Next page cursor; "-1" when no more pages. |
total | int | Total count of matching items (optional, only returned when the backend can provide it). |
The next_key cursor is opaque to callers — do not parse or construct it manually.
Exceptions: A few endpoints that fetch by date range (get_capital_flow_history, request_history_kline) use pagination.has_more to indicate whether earlier data exists. Callers paginate backward by adjusting the date range rather than using next_key.
Reference
- Naming Dictionary — Enum value lookup table for all enumeration types used across quote APIs.