Skip to main content

​
tickers()

tickers(params?: { country?: string, exchange?: string }): Promise<ApiResponse>
Get list of available forex pairs.
​
params.country
string
Filter by country code
​
params.exchange
string
Filter by exchange code

​
Example

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

​
ticker()

ticker(ticker: string): Promise<ApiResponse>
Get detailed information for a specific forex pair.
​
ticker
string
required
Forex pair symbol (e.g., “EUR/USD”)

​
Example

const info = await client.forex.ticker('EUR/USD');

​
prices()

prices(ticker: string, params?: { from?: string, to?: string, frame?: string }): Promise<ApiResponse>
Get historical exchange rate data for a forex pair.
​
ticker
string
required
Forex pair symbol
​
params.from
string
Start date for rate history
​
params.to
string
End date for rate history
​
params.frame
string
Time frame (e.g., “1d”, “1h”)

​
Example

const rates = await client.forex.prices('EUR/USD', {
  from: '2024-01-01',
  frame: '1d'
});