Skip to main content

​
tickers()

tickers(params?: { exchange?: string }): Promise<ApiResponse>
Get list of available market indices.
​
params.exchange
string
Filter by exchange code

​
Example

const tickers = await client.indices.tickers();

​
ticker()

ticker(ticker: string): Promise<ApiResponse>
Get detailed information for a specific index.
​
ticker
string
required
Index symbol (e.g., “SPX”)

​
Example

const info = await client.indices.ticker('SPX');

​
prices()

prices(ticker: string, params?: { from?: string, to?: string, frame?: string }): Promise<ApiResponse>
Get historical values for a market index.
​
ticker
string
required
Index symbol
​
params.from
string
Start date for index history
​
params.to
string
End date for index history
​
params.frame
string
Time frame (e.g., “1d”, “1h”)

​
Example

const values = await client.indices.prices('SPX', {
  from: '2024-01-01',
  frame: '1d'
});