Candle
One OHLCV bar.
interface Candle {
time: number; // bar open time, unix ms, aligned to the resolution boundary
open: number;
high: number;
low: number;
close: number; // the latest price while the bar is still in progress
volume: number;
}time is the bar’s open time in unix milliseconds, UTC, aligned by the venue. Chart libraries disagree on
whether they want seconds or milliseconds — the SDK always speaks milliseconds and each adapter converts at its own
edge.
volume uses the unit reported by the source’s CandleSymbol.volumeUnit and volumeCurrency. It can measure the base asset or quote currency. For example, BTC volume and USD volume are different quantities; do not compare or relabel them without conversion. A zero can mean no traded volume or no available volume data.
CandleSymbol
Symbol metadata a chart needs before it can render a series: how to label the instrument and how many decimals to draw its prices at.
marketNamestringMarket name as SYMMIO names it (e.g. "BTCUSDT").
sourceSymbolstringThe same instrument in the source’s own namespace (e.g. the Binance symbol).
descriptionstringHuman-readable description for a chart’s symbol header.
pricePrecisionnumberDecimal places prices should be rendered at.
volumePrecisionnumberDecimal places volume should be rendered at.
volumeUnit"base" | "quote"optionalWhether volume measures the base asset or quote currency. An omitted value means unspecified; do not assume base-asset volume.
volumeCurrencystringoptionalCurrency of the volume values, when known: for example "BTC" for BTC volume or "USD" for dollar volume.
Binance sources report volumeUnit: "base" and the exchange’s base asset as volumeCurrency, when supplied by the exchange. The lowcap price-service source reports volumeUnit: "quote" and volumeCurrency: "USD". Its live price ticks carry no volume, so volume changes arrive through HTTP reconciliation.
const symbol = await source.getSymbol(marketName);
const volumeLabel = symbol?.volumeCurrency ? `Volume (${symbol.volumeCurrency})` : "Volume";CandlePriceBasis
What the prices in a candle series actually represent. Surfaced deliberately rather than hidden: a chart drawn from a reference exchange is not the price a SYMMIO trade settles at, and a UI that lets a user place orders off that chart should be able to tell them so.
| Value | The bars are | Matches execution? |
|---|---|---|
"reference-exchange" | Mark price of a third-party perp venue (e.g. Binance USD-M). | No |
"dex-pool" | Spot price of an on-chain liquidity pool, USD-denominated. | No |
"solver-mark" | The SYMMIO solver’s own mark price — the basis execution settles against. | Yes |
"price-service" | OHLCV from the configured price service, with provisional live-price updates. | Not guaranteed |
Price basis and volume denomination are independent. USD volume alone does not establish that a source’s prices match the solver’s mark price.
Related
CandleSource— where these types flow from.- Charts guide — the
priceBasiscaveat in full.