Asset Classes & Symbol Naming Conventions
| Asset Class | Sample Symbols | Naming Convention | Supported Data Types |
|---|---|---|---|
| HK Stocks (HKEX) | 700.HK, 9988.HK, 5.HK | Digits without leading zero + .HK | Latest trade, tick details, order book, multi-period K-lines |
| US Stocks (US) | AAPL.US, TSLA.US, NVDA.US | Ticker letters + .US | Latest trade, tick details, order book, multi-period K-lines |
| China A-Shares (SH/SZ) | 600519.SH, 000001.SZ | 6-digit code + .SH / .SZ | Latest trade, tick details, order book, multi-period K-lines |
| Forex (FX) | EURUSD, USDJPY, GBPUSD | 6-letter base/quote uppercase | Real-time quotes, tick details, live spreads, K-lines |
| Metals & Commodities | GOLD, Silver, XAUUSD, USOIL | Official standard symbol (case-sensitive) | Benchmark quotes, ticks, spot & futures K-lines |
| Global Indices | HSI, SPX, DJI, .IXIC.US | Standard index code | Real-time index levels, change pct, historical K-lines |
Endpoint Prefixes & Protocol Routing
| Business Domain | REST Endpoint Prefix | WebSocket URL | Recommended Use Case |
|---|---|---|---|
| Equities (HK, US, A-Shares) | https://quote.alltick.co/quote-stock-b-api | wss://quote.alltick.co/quote-stock-b-ws-api | Stock quotes, market depth, and equity K-lines |
| Forex / Commodities / Indices | https://quote.alltick.co/quote-b-api | wss://quote.alltick.co/quote-b-ws-api | High-frequency FX spreads, bullion, and commodity ticks |
Note: Stock endpoints use a different URL prefix from Forex and Commodities. Always format symbol parameters strictly according to the target market specification.
Important Exchange Rules & Pitfalls to Avoid
Trading Hours & Market Closures
Exchanges operate in different timezones and observe specific holidays. During closed sessions, endpoints remain online but no new trade ticks will stream.
HKEX Lunch Break Sessions
Hong Kong stocks observe a midday break (12:00 - 13:00 HKT). HKEX introduced severe-weather trading on 23 September 2024, so do not assume a typhoon warning means early closure; verify the current exchange announcement and product session.
K-Line Pagination Limit (500 Bars)
Official HTTP specs dictate that /kline returns a maximum of 500 bars per request. Timestamp pagination is supported for FX, metals, and crypto, not stock codes; verify total history by asset and plan.
Case Sensitivity & Suffixes
Symbols are strictly case-sensitive (.US, .HK, .SH, .SZ must be uppercase). Avoid guessing unverified ticker representations.