Skip to main content
Server path: /finage-forex | Type: Application | PCID required: Yes

Tools

ToolDescription
finage_forex_convert_forex_currencyConvert between currencies
finage_forex_get_aggregatesGet forex OHLCV aggregate bars
finage_forex_get_last_quoteGet last forex quote
finage_forex_get_previous_closeGet forex previous close

finage_forex_convert_forex_currency

Convert between currencies Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesSource currency code (e.g. GBP, EUR, USD)
tostringYesTarget currency code (e.g. USD, EUR)
amountnumberYesAmount to convert

finage_forex_get_aggregates

Get forex OHLCV aggregate bars Parameters:
ParameterTypeRequiredDefaultDescription
symbolstringYesForex pair symbol (e.g. GBPUSD)
multiplierintegerYesTime multiplier (e.g. 1, 5, 15)
timespanstringYesTime unit: minute, hour, day, week, or month
fromstringYesStart date in YYYY-MM-DD format
tostringYesEnd date in YYYY-MM-DD format
limitintegerNoMaximum number of results
sortstringNoSort order by timestamp: asc or desc

finage_forex_get_last_quote

Get last forex quote Parameters:
ParameterTypeRequiredDefaultDescription
symbolstringYesForex pair symbol (e.g. GBPUSD, EURUSD)

finage_forex_get_previous_close

Get forex previous close Parameters:
ParameterTypeRequiredDefaultDescription
symbolstringYesForex pair symbol (e.g. GBPUSD)