charton API / @chart-on/core / index / OhlcvDataSourceOptions
Interface: OhlcvDataSourceOptions
Defined in: packages/core/src/data/ohlcv.ts:63
Options for createOhlcvDataSource: request size, poll period, reconnect backoff, how to read price precision, and a hook to adjust symbols.
Properties
maxBarsPerRequest?
optionalmaxBarsPerRequest?:number
Defined in: packages/core/src/data/ohlcv.ts:65
Most rows to ask for in one history request (default 500). Venues capping lower are paged anyway.
pollMs?
optionalpollMs?:number
Defined in: packages/core/src/data/ohlcv.ts:67
Poll period in ms when the exchange has no stream (default 5000).
pricePrecision?
optionalpricePrecision?:"tickSize"|"decimals"
Defined in: packages/core/src/data/ohlcv.ts:75
What market.precision.price holds: a count of 'decimals', or a 'tickSize'. When unset, a fraction is taken as a tick size and a whole number as decimals; set it for a venue that quotes whole tick sizes.
reconnect?
optionalreconnect?:object
Defined in: packages/core/src/data/ohlcv.ts:69
Backoff bounds in ms after a failed stream read or poll (default 1000 to 30000).
maxMs
maxMs:
number
minMs
minMs:
number
Methods
symbolInfo()?
optionalsymbolInfo(market,info):SymbolInfo
Defined in: packages/core/src/data/ohlcv.ts:77
Adjust the symbol built from a market, e.g. to add a timezone or another label.