Market Data
Provides stock, futures, options, fund, and warrant market data queries. All methods are asynchronous QuoteClient methods returning Promise. Create a client with QuoteClient.fromConfig(config). Source: openapi-typescript-sdk.
| Page | Description |
|---|---|
| Common | Market state, trading calendar, permissions, bar quota |
| Stocks | Real-time/delayed quotes, bars, timeline, ticks, depth, brokers, capital flow, short interest, rankings |
| Options | Expirations, chain, quotes, bars, timeline, ticks, depth, analysis |
| Futures | Exchanges, contracts, quotes, bars, ticks, depth, trading hours |
| Funds and Warrants | Fund symbols, contracts, NAV, historical NAV, warrant quotes and filters |
| Stock Screener | Multi-condition screening, tag queries |
API List
Common
| API | Description |
|---|---|
| Get Market State | Market trading status |
| Get Trading Calendar | Trading calendar |
| Grab Quote Permission | Claim permissions |
| Get Quote Permission | Permission details |
| Get Kline Quota | Historical bar quota |
Stocks
| API | Description |
|---|---|
| Get Symbols | Full symbol universe |
| Get Symbol Names | Symbols with names |
| Get Trade Metas | Lot size, min tick, etc. |
| Get Real-Time Quote | Real-time snapshot |
| Get Delayed Quote | Delayed snapshot |
| Get Kline | Stock bars |
| Get Kline By Page | Client-side pagination |
| Get Timeline | Intraday timeline |
| Get Timeline History | Historical timeline |
| Get Trade Tick | Stock ticks |
| Get Quote Depth | Order book |
| Get Stock Broker | HK broker queue |
| Get Capital Flow | Capital flow |
| Get Capital Distribution | Big/mid/small order breakdown |
| Get Trade Rank | Market rankings |
| Get Short Interest | Short interest |
Options
| API | Description |
|---|---|
| Get Option Expiration | Expiration dates |
| Get Option Chain | Option chain |
| Get Option Quote | Option snapshot |
| Get Option Kline | Option bars |
| Get Option Trade Ticks | Option ticks |
| Get Option Timeline | Option timeline |
| Get Option Depth | Option order book |
| Get Option Symbols | HK option codes |
| Get Option Analysis | IV/HV/ratio metrics |
Futures
| API | Description |
|---|---|
| Get Future Exchange | Supported exchanges |
| Get Future Contracts | Contracts by exchange |
| Get Future Contract | Contract by code |
| Get All Future Contracts | All contracts by type |
| Get Current Future Contract | Current main contract |
| Get Future Continuous Contracts | Continuous contracts |
| Get Future History Main Contract | Historical main contracts |
| Get Future Real-Time Quote | Futures snapshot |
| Get Future Kline | Futures bars |
| Get Future Kline By Page | Client pagination |
| Get Future Trade Ticks | Futures ticks |
| Get Future Depth | Futures order book |
| Get Future Trading Times | Trading sessions |
Funds and Warrants
| API | Description |
|---|---|
| Get Fund Symbols | Fund codes |
| Get Fund Contracts | Contract info |
| Get Fund Quote | Latest NAV |
| Get Fund History Quote | Historical NAV |
| Get Warrant Quote | Warrant snapshot |
| Warrant Filter | Conditional filter |
Stock Screener
| API | Description |
|---|---|
| Market Scanner | Multi-condition screening |
| Get Market Scanner Tags | Tag list |
Updated about 13 hours ago
Did this page help you?