Market Data
Provides stock, cryptocurrency, 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 | Stock real-time/delayed quotes, candlestick bars, timelines, trade ticks, market depth, brokers, capital flow, short interest, and rankings |
| Cryptocurrency | Cryptocurrency candlestick bars, paginated candlestick bars, and current timeline data |
| Options | Expirations, chain, quotes, candlestick bars, timeline data, trade ticks, market depth, analysis |
| Futures | Exchanges, contracts, quotes, candlestick bars, trade ticks, market depth, trading hours |
| Funds and Warrants | Fund symbols, contracts, NAV, historical NAV, warrant quote snapshots and filters |
| Stock Screener | Multi-condition screening, tag queries |
API List
Common
| API | Description |
|---|---|
| Get Market State | Market State |
| Get Trading Calendar | Trading calendar |
| Claim Market Data Device Access | Switch device access to the current device |
| Get Market Data Permissions | Market data permission entries |
| 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 Quotes | Real-time quote snapshot |
| Get Delayed Quotes | Delayed quote snapshot |
| Get K-Line Data | Stock candlestick bars |
| Get K-Line Data By Page | Stock client-side pagination |
| Get Timeline | Current stock timeline |
| Get Timeline History | Historical stock timeline data |
| Get Trade Ticks | Stock trade ticks |
| Get Market 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 |
Cryptocurrency
| API | Description |
|---|---|
| Get Cryptocurrency K-Line Data | Cryptocurrency candlestick bars |
| Get Cryptocurrency K-Line Data By Page | Cryptocurrency client-side pagination |
| Get Cryptocurrency Timeline | Current cryptocurrency timeline |
Options
| API | Description |
|---|---|
| Get Option Expiration | Expiration dates |
| Get Option Chain | Option chain |
| Get Option Quote Snapshot | Option quote snapshot |
| Get Option K-Line Data | Option candlestick bars |
| Get Option Trade Ticks | Option trade ticks |
| Get Option Timeline | Option timeline (intraday data) |
| Get Option Market 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 Futures Real-Time Quotes | Real-time futures quote snapshot |
| Get Futures K-Line Data | Futures candlestick bars |
| Get Futures K-Line Data By Page | Client pagination |
| Get Future Trade Ticks | Futures trade ticks |
| Get Futures Market 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 quote snapshot |
| Warrant Filter | Conditional filter |
Stock Screener
| API | Description |
|---|---|
| Market Scanner | Multi-condition screening |
| Get Market Scanner Tags | Tag list |
Updated about 1 month ago
Did this page help you?