Skip to Content
Symmio Trading-SDK — the SDK surface for builders on Arbitrum
CoreCandlesCandle

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 is base-asset volume over the bar, and 0 when the source cannot report volume — the case for any source that folds a price-tick stream into bars.

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.

marketNamestring

Market name as SYMMIO names it (e.g. "BTCUSDT").

sourceSymbolstring

The same instrument in the source’s own namespace (e.g. the Binance symbol).

descriptionstring

Human-readable description for a chart’s symbol header.

pricePrecisionnumber

Decimal places prices should be rendered at.

volumePrecisionnumber

Decimal places volume should be rendered at.

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.

ValueThe bars areMatches 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
Last updated on
ResolutionsCandleSource