SymbolInfo

Documentation

Documentation / @elitechart/core / SymbolInfo

Defined in: data/types.ts:127

Minimal symbol metadata needed to render a chart. Derived priceScale (decimals) is precomputed from tickSize so the renderer doesn't pay Math.log10 per paint.

Example

code

import { asTickSize, type SymbolInfo } from '@elitechart/core';
const sym: SymbolInfo = {
  id: 'BINANCE:BTCUSDT',
  ticker: 'BTC/USDT',
  description: 'Bitcoin / USDT',
  exchange: 'BINANCE',
  type: 'crypto',
  currency: 'USDT',
  tickSize: asTickSize(0.01),
  priceScale: 2,
};

Properties

currency?

code

readonly optional currency?: string;

Defined in: data/types.ts:133

description

code

readonly description: string;

Defined in: data/types.ts:130

exchange?

code

readonly optional exchange?: string;

Defined in: data/types.ts:131

id

code

readonly id: string;

Defined in: data/types.ts:128

priceScale

code

readonly priceScale: number;

Defined in: data/types.ts:136

Digits after the decimal point for display, derived from tickSize.

ticker

code

readonly ticker: string;

Defined in: data/types.ts:129

tickSize

code

readonly tickSize: TickSize;

Defined in: data/types.ts:134

type

code

readonly type: InstrumentType;

Defined in: data/types.ts:132