# Finage

Finage provides secure RESTful APIs for real-time and historical financial market data covering stocks, forex, cryptocurrencies, indices, ETFs, and commodities.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 40
- **Triggers:** 0
- **Slug:** `FINAGE`
- **Version:** 20260316_00

## Tools

### Convert Cryptocurrencies

**Slug:** `FINAGE_CONVERT_CRYPTO`

Tool to convert cryptocurrencies using real-time exchange rates from the Finage API. Use when you need to convert between different cryptocurrencies (e.g., BTC to ETH, USD to DOGE, SHIB to BTC).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | number | Yes | The amount of the source currency to convert. Must be a positive number (supports decimals like 0.5, 1.25, etc.) |
| `to_currency` | string | Yes | The target cryptocurrency or fiat currency symbol to convert to (e.g., ETH, BTC, USD, EUR, DOGE) |
| `from_currency` | string | Yes | The source cryptocurrency symbol to convert from (e.g., BTC, ETH, DOGE, SHIB, XRP, LTC) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Currency

**Slug:** `FINAGE_CONVERT_CURRENCY`

Tool to convert currencies using real-time forex exchange rates from Finage API. Use when you need to convert an amount from one currency to another with current market rates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amount` | number | Yes | The amount to convert. Must be a positive number. |
| `to_currency` | string | Yes | The target currency code (e.g., USD, EUR, GBP). Must be a valid 3-letter ISO currency code. |
| `from_currency` | string | Yes | The source currency code (e.g., USD, EUR, GBP). Must be a valid 3-letter ISO currency code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get US Treasury Bond Rate

**Slug:** `FINAGE_GET_BONDS_RATE`

Retrieve the current interest rate for a US Treasury bond by maturity. Returns the Federal Reserve's constant maturity Treasury (CMT) rate as a percentage. Useful for tracking benchmark interest rates, yield curve analysis, and financial market research.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | US Treasury bond symbol (Federal Reserve constant maturity rate). Format: DGS followed by years (e.g., DGS10 for 10-year). Available maturities: 1, 2, 3, 5, 7, 10, 20, and 30 years. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Country Details

**Slug:** `FINAGE_GET_COUNTRY_DETAIL`

Tool to retrieve detailed information about a country including currency, phone code, and flag. Use when you need country metadata for financial or geographical context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_code` | string | Yes | Country code to retrieve detailed information for (e.g., US, GB, DE, FR, JP). Use ISO 2-letter country codes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto Aggregates

**Slug:** `FINAGE_GET_CRYPTO_AGGREGATES`

Tool to retrieve aggregated OHLCV time-series data for cryptocurrency pairs over specified time periods. Use when you need historical tick bars (candlestick data) for crypto trading pairs with customizable timeframes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("asc" | "desc") | No | Sort results by timestamp. 'asc' for ascending (oldest to newest), 'desc' for descending |
| `time` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | Yes | Size of the time period |
| `limit` | integer | No | Limit of results. Default is 100, maximum 50000 |
| `symbol` | string | Yes | Cryptocurrency pair symbol (e.g., 'BTCUSD', 'ETHUSD') |
| `to_date` | string | Yes | End date in YYYY-MM-DD format |
| `multiply` | integer | Yes | Time multiplier for the aggregation period |
| `from_date` | string | Yes | Start date in YYYY-MM-DD format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto Detail

**Slug:** `FINAGE_GET_CRYPTO_DETAIL`

Tool to get detailed fundamental information about a cryptocurrency including description, developers, website, social media links, and technical details. Use when you need comprehensive background information about a cryptocurrency beyond just price data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Symbol or full name of the cryptocurrency (e.g., BTC, Bitcoin, ETH, Ethereum). Can be either the ticker symbol or the full cryptocurrency name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Detailed Crypto Information

**Slug:** `FINAGE_GET_CRYPTO_DETAILED`

This tool fetches detailed cryptocurrency information including current price, price changes, volume, market cap, and historical highs/lows for a specific cryptocurrency pair. Use when comprehensive crypto market data is needed beyond basic price quotes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Cryptocurrency pair symbol in format BASEUSD (e.g., BTCUSD, XRPUSD, LTCUSD, DOGEUSD, ADAUSD). Use uppercase letters. Only major cryptocurrencies with market cap data are supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto Last Quote

**Slug:** `FINAGE_GET_CRYPTO_LAST_QUOTE`

Tool to get the last quote with bid/ask prices in real-time for a cryptocurrency pair. Use when you need current market data for crypto trading pairs including bid/ask spreads and order sizes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | The cryptocurrency pair symbol to get quote information for (e.g., BTCUSD, ETHUSD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto Last Trade

**Slug:** `FINAGE_GET_CRYPTO_LAST_TRADE`

Tool to get the latest trade information and prices in real-time for a cryptocurrency pair. Use when you need current pricing data for cryptocurrencies like Bitcoin, Ethereum, or other digital assets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Crypto symbol name (e.g., BTCUSD, ETHUSD). The symbol should be the cryptocurrency pair without any separators. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto News

**Slug:** `FINAGE_GET_CRYPTO_NEWS`

Tool to retrieve real-time and historical news for cryptocurrency markets with fast In-Memory Cache Engine. Use when you need crypto market news, updates on cryptocurrencies, or research on crypto trends for a specific symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of news articles to retrieve. Default is 10, maximum allowed is 30. |
| `symbol` | string | Yes | Cryptocurrency symbol for which to retrieve news (e.g., BTC, ETH, DOGE) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto Previous Close Data

**Slug:** `FINAGE_GET_CRYPTO_PREVIOUS_CLOSE`

Tool to get the previous day's closing data for a cryptocurrency pair. Use when you need historical end-of-day data including opening price, highest price, lowest price, closing price, trading volume, and timestamp for crypto pairs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Cryptocurrency pair symbol (e.g., BTCUSD, ETHUSD, LTCUSD). The symbol should be the cryptocurrency pair without any separators. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crypto Snapshot

**Slug:** `FINAGE_GET_CRYPTO_SNAPSHOT`

Tool to get a comprehensive snapshot of cryptocurrency market data with latest quotes and trades in one request. Use when you need broad crypto market coverage or real-time data for multiple cryptocurrency pairs simultaneously.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quotes` | boolean | No | Include latest quotes in the response. Default is True. |
| `trades` | boolean | No | Include latest trades in the response. Default is True. |
| `symbols` | string | No | Comma-separated list of cryptocurrency pair symbols to filter results (e.g., 'BTCUSD,ETHUSD,DOGEUSD'). If not provided, data for all available crypto pairs will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Currency Detail

**Slug:** `FINAGE_GET_CURRENCY_DETAIL`

Tool to get detailed information about a forex currency pair including currency codes and country flags. Use when you need to retrieve metadata about a specific currency pair such as the base and quote currencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | The forex currency pair symbol to get detailed information for (e.g., GBPUSD, EURUSD, USDJPY) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Forex Last Quote

**Slug:** `FINAGE_GET_FOREX_LAST_QUOTE`

Tool to get the latest real-time bid/ask quote for a forex pair or metal (e.g., GBPUSD, XAUUSD). Use when you need current market data for forex trading pairs or commodities including bid/ask spreads.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | The forex/CFD/metal symbol to get quote information for (e.g., GBPUSD, EURUSD, XAUUSD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Forex Last Trade

**Slug:** `FINAGE_GET_FOREX_LAST_TRADE`

Tool to get the last trade information for a forex currency pair. Use when you need current price data for forex trading pairs like EURUSD or GBPUSD.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Forex symbol that you want to get the last trade price for (e.g., EURUSD, GBPUSD, USDJPY) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Forex Market Aggregates

**Slug:** `FINAGE_GET_FOREX_MARKET_AGGREGATES`

Tool to retrieve aggregated OHLCV (Open, High, Low, Close, Volume) data for forex and metal pairs over specified time periods. Use when you need historical or intraday bars for forex pairs (e.g., GBPUSD, EURUSD) or metals (e.g., XAUUSD for gold). Supports multiple timeframes from minute-level to yearly aggregations for trends, highs/lows, and backtesting use cases.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `et` | string | No | End time in UTC (e.g., '17:45') |
| `st` | string | No | Start time in UTC (e.g., '17:30') |
| `sort` | string ("asc" | "desc") | No | Sort results by timestamp. 'asc' for ascending (oldest to newest), 'desc' for descending |
| `time` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | Yes | Size of the time period |
| `limit` | integer | No | Limit of results. Maximum 50000 |
| `symbol` | string | Yes | Forex or metal pair symbol (e.g., 'GBPUSD', 'EURUSD', 'XAUUSD') |
| `to_date` | string | Yes | End date in YYYY-MM-DD format |
| `multiply` | integer | Yes | Time multiplier for the aggregation period (e.g., 1, 5, 15) |
| `from_date` | string | Yes | Start date in YYYY-MM-DD format |
| `dbt_filter` | boolean | No | Daily-based time filter |
| `date_format` | string ("ts" | "dt") | No | Date format for timestamps. 'ts' for timestamp in milliseconds, 'dt' for datetime string |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Forex News

**Slug:** `FINAGE_GET_FOREX_NEWS`

Tool to retrieve real-time and historical news for forex markets from Finage's API. Use when you need forex market news, currency updates, or research on forex trends for a specific currency symbol.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Currency symbol for which to retrieve news (e.g., EUR, USD, GBP, JPY) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Forex Previous Close Data

**Slug:** `FINAGE_GET_FOREX_PREVIOUS_CLOSE`

Tool to get the previous day's closing data for a forex currency pair. Use when you need historical end-of-day data including opening price, highest price, lowest price, closing price, trading volume, and timestamp for forex pairs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Forex pair symbol (e.g., EURUSD, GBPUSD, USDJPY) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Forex Snapshot

**Slug:** `FINAGE_GET_FOREX_SNAPSHOT`

Tool to get a comprehensive snapshot of forex market data with latest quotes and trades in one request. Use when you need broad forex market coverage or real-time data for multiple currency pairs simultaneously.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quotes` | boolean | No | Include latest quotes in the response. Default is True. |
| `trades` | boolean | No | Include latest trades in the response. Default is False. |
| `symbols` | string | No | Comma-separated list of forex pair symbols to filter results (e.g., 'EURUSD,GBPUSD,USDJPY'). If not provided, data for all available forex pairs will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Most Active US Stocks

**Slug:** `FINAGE_GET_MOST_ACTIVE_STOCKS`

Tool to get a list of the most actively traded US stocks. Use when you need to identify which stocks are experiencing the highest trading volume in the current market session.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SEC RSS Feed

**Slug:** `FINAGE_GET_SEC_RSS_FEED`

Tool to retrieve the SEC RSS feed for recent EDGAR filings. Use when you need information about recent SEC filings including title, date, link, CIK, form type, and ticker symbol.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sector Performance

**Slug:** `FINAGE_GET_SECTOR_PERFORMANCE`

Tool to retrieve performance metrics across US market sectors. Use when you need to analyze sector-level market trends or compare performance across different industries.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Company Details

**Slug:** `FINAGE_GET_STOCK_COMPANY_DETAILS`

Tool to retrieve detailed company information and stock fundamentals for a given ticker symbol. Use when you need comprehensive information about a company including CEO, description, industry, sector, market cap, employee count, and headquarters details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | Stock symbol/ticker for which to retrieve detailed company information and fundamentals (e.g., AAPL, TSLA, MSFT) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Historical Data (Deprecated)

**Slug:** `FINAGE_GET_STOCK_HISTORICAL_DATA`

DEPRECATED: Use FINAGE_GET_STOCK_MARKET_AGGREGATES instead. Fetches historical OHLCV (open, high, low, close, volume) data for US stocks from Finage API. Returned timestamps are UTC-aligned; non-trading days are omitted entirely — do not treat date gaps as zero values. Ensure from_date/to_date are past UTC dates to avoid partial or future bars. Requirements: - Symbols must be alphabetic US ticker symbols in English - No numeric-only symbols - No exchange prefixes or suffixes - Standard ticker format only (typically 1-5 characters) For supported symbols and complete documentation, visit: https://finage.co.uk/docs

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order for results (asc or desc) |
| `limit` | integer | No | Number of results to return (max: 50000) |
| `symbol` | string | Yes | Stock symbol to fetch historical data for. Must be a standard US ticker symbol in English  Malformed symbols return empty results with no error message.(e.g., AAPL, MSFT). Numeric-only symbols, exchange prefixes, and suffixes are not supported. For supported symbols, see: https://finage.co.uk/docs |
| `to_date` | string | Yes | End date in YYYY-MM-DD format. Must be a past date, not in the future. |
| `from_date` | string | Yes | Start date in YYYY-MM-DD format. Must be a past date, not in the future. |
| `time_unit` | string | No | Timeframe unit for the data For multi-month history, prefer 'day' with multiplier=1; mismatching granularity to the analysis horizon causes incorrect indicator calculations. |
| `multiplier` | integer | No | Time multiplier for the selected time unit |
| `unadjusted` | boolean | No | Whether to return unadjusted (raw) prices. Set to True for raw historical prices as traded. Set to False or omit for adjusted prices (accounting for dividends and stock splits). Note: If you're used to 'adjusted' parameter, use opposite logic - adjusted=true equals unadjusted=false, adjusted=false equals unadjusted=true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Last Quote

**Slug:** `FINAGE_GET_STOCK_LAST_QUOTE`

Fetches the latest single-tick quote for a stock symbol, returning a JSON object with fields: symbol, ask, bid, asize, bsize, and timestamp. Suitable for real-time trading and market analysis. During pre/post-market or closed sessions, the returned quote may be stale — always compare the timestamp field against current UTC before treating data as live. Returns only the latest tick; not a substitute for historical or charted series data. Rate-limited: throttle to 2–5 requests/second and honor Retry-After headers on HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | The stock symbol to get quote information for (e.g., AAPL, MSFT, GOOGL) Must use the correct exchange format for the target market. Coverage and symbol format for non-US equities (e.g., Chinese A-shares) may differ — verify symbol mapping before use. |
| `timestamp_type` | string ("ms" | "ns") | No | Timestamp types for stock quotes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Last Trade

**Slug:** `FINAGE_GET_STOCK_LAST_TRADE`

Tool to get the most recent trade information for a specified US stock symbol. Use when you need real-time price and volume data from the latest executed trade.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `symbol` | string | Yes | The stock symbol to get the most recent trade information for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Market Aggregates

**Slug:** `FINAGE_GET_STOCK_MARKET_AGGREGATES`

Retrieves aggregated OHLCV (Open, High, Low, Close, Volume) data for US stocks only. Supports stock symbols like AAPL, MSFT, GOOGL. Does NOT support forex pairs (EUR/USD, GBP/USD), commodities (XAU/USD for gold), or cryptocurrencies - those require separate forex/crypto endpoints. All returned timestamps are in UTC.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("asc" | "desc") | No | Sort results by timestamp. 'asc' for ascending (oldest to newest), 'desc' for descending |
| `time` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | Yes | Base time period unit for aggregation. Combines with 'multiply' to set interval (e.g., time='minute' with multiply=5 creates 5-minute bars). |
| `limit` | integer | No | Maximum number of results to return. Default is 100, maximum is 5000. If limit is too low for the requested date range and interval, older bars are silently truncated — increase limit (up to 5000) or use a coarser interval for long time windows. |
| `symbol` | string | Yes | US stock ticker symbol. Only supports stock symbols like 'AAPL', 'MSFT', 'GOOGL'. Does NOT support forex pairs (EUR/USD), commodities (XAU/USD), or crypto. For forex/commodity data, use a forex-specific API endpoint. |
| `to_date` | string | Yes | End date in YYYY-MM-DD format |
| `end_time` | string | No | End time in UTC (e.g., '17:45') |
| `multiply` | integer | Yes | Time multiplier that combines with 'time' to set the aggregation interval. For example, multiply=5 with time='minute' gives 5-minute bars; multiply=1 with time='day' gives daily bars. |
| `from_date` | string | Yes | Start date in YYYY-MM-DD format Non-trading days, weekends, and holidays are skipped — gaps in returned bars are expected and do not indicate errors or zero values. |
| `dbt_filter` | boolean | No | Daily-based time filter. Default is false |
| `start_time` | string | No | Start time in UTC (e.g., '17:30') |
| `unadjusted` | boolean | No | Unadjust the prices. Default is true |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Market News

**Slug:** `FINAGE_GET_STOCK_MARKET_NEWS`

This tool retrieves the latest market news from Finage's API. It provides comprehensive market news and updates, including news filtering by specific stock symbols, thereby supporting real-time market insights, investment decisions, and research on market trends.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of news articles to retrieve. Default is 10, maximum allowed is 30. |
| `symbol` | string | Yes | Stock symbol name for which to retrieve news (e.g., AAPL, AMZN) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Market Status

**Slug:** `FINAGE_GET_STOCK_MARKET_STATUS`

Tool to check if stock, forex, and crypto markets are open, closed, or in extended hours. Use when you need to determine current market status with optional country, holidays, and trading hours information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | Country code to check market status for. Supports 55+ countries. Use 'UK' for United Kingdom (not 'GB'). Default is 'US'. |
| `holidays` | boolean | No | Display selected country's holidays. Default is false. |
| `currencies` | boolean | No | Display or hide currencies part from the output. Default is true. |
| `trading_hours` | boolean | No | Display trading hours of the market. Default is false. |
| `extended_hours` | boolean | No | Display extended hours of the market. Default is false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Previous Close Data

**Slug:** `FINAGE_GET_STOCK_PREVIOUS_CLOSE`

This tool retrieves the previous day's closing data for a specific stock symbol. It provides essential trading information including the opening price, highest price, lowest price, closing price, trading volume, and timestamp for the previous trading day. It complements other Finage tools by offering detailed previous day data, which is useful for computing day-over-day change and informing daily trading analysis. REQUIRED PARAMETERS: - symbol: A valid stock ticker symbol (e.g., 'AAPL', 'MSFT', 'GOOGL'). You MUST provide this parameter. OPTIONAL PARAMETERS: - date: Specific date in YYYY-MM-DD format for historical data - unadjusted: Boolean to control whether prices are adjusted for splits

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Specific date in YYYY-MM-DD format to get historical data |
| `symbol` | string | Yes | REQUIRED. Stock ticker symbol (e.g., 'AAPL' for Apple, 'MSFT' for Microsoft, 'GOOGL' for Google). This parameter is mandatory and must always be provided. |
| `unadjusted` | boolean | No | Whether to return unadjusted price data. If not specified, adjusted prices are returned (default API behavior). Set to True for raw/unadjusted prices or False explicitly for split-adjusted prices. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stock Snapshot

**Slug:** `FINAGE_GET_STOCK_SNAPSHOT`

Tool to get comprehensive snapshot of all US stock market data including latest quotes and trades with one single API request. Use when you need current market data for multiple stocks efficiently.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quotes` | boolean | No | Include quotes data in the response. Default is True. |
| `trades` | boolean | No | Include trades data in the response. Default is True. |
| `symbols` | string | No | Comma-separated list of stock symbols to filter (e.g., 'AAPL,MSFT,GOOGL'). If not provided, data for all available stocks will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Technical Indicators

**Slug:** `FINAGE_GET_TECHNICAL_INDICATORS`

Tool to get technical indicators and signals for stocks from Finage API. Use when you need to analyze stock trends with technical indicators like moving averages (SMA, EMA, WMA), momentum indicators (RSI, Williams %R), or trend indicators (ADX). Returns historical OHLCV data along with calculated indicator values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | integer | No | Period for the technical indicator calculation. For example, for a 14-day RSI, use period=14. If not specified, the API will use its default period for the selected indicator type. |
| `symbol` | string | Yes | Stock symbol to get technical indicators for. Must be a standard US ticker symbol (e.g., AAPL, TSLA, GOOGL). |
| `time_interval` | string ("daily" | "1min" | "5min" | "15min" | "30min" | "1hour" | "4hour") | Yes | Time interval for the indicator calculation. Valid values: daily, 1min, 5min, 15min, 30min, 1hour, 4hour. |
| `indicator_type` | string ("sma" | "ema" | "dema" | "tema" | "wma" | "rsi" | "williams" | "adx") | Yes | Type of technical indicator. Valid values: sma (Simple Moving Average), ema (Exponential Moving Average), dema (Double Exponential Moving Average), tema (Triple Exponential Moving Average), wma (Weighted Moving Average), rsi (Relative Strength Index), williams (Williams %R), adx (Average Directional Index). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Top Gaining US Stocks

**Slug:** `FINAGE_GET_TOP_GAINERS`

Tool to get list of top gaining US stocks by percentage change. Use when you need to identify the best performing stocks in the US market. Returns symbol, price, change amount, change percentage, and company name for each stock.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Top Losing US Stocks

**Slug:** `FINAGE_GET_TOP_LOSERS`

Tool to get list of top losing US stocks by percentage change. Use when you need to identify the worst performing stocks in the US market. Returns symbol, price, change amount, change percentage, and company name for each stock.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Cryptocurrencies by Market Cap

**Slug:** `FINAGE_LIST_CRYPTOCURRENCIES`

Tool to get a list of all available cryptocurrencies ranked by market capitalization. Use when you need to discover cryptocurrencies by market cap, find top crypto assets, or browse paginated crypto data. Results can be sorted by market cap in ascending or descending order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default is 1. Use this to retrieve additional pages of results. |
| `sort` | string ("DESC" | "ASC") | No | Sort order for cryptocurrency list |
| `limit` | integer | No | Maximum number of cryptocurrencies to return. Default is 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Symbols by Market Type

**Slug:** `FINAGE_LIST_SYMBOLS`

Tool to get a paginated list of all available symbols for a specified market type (us-stock, ca-stock, in-stock, ru-stock, forex, crypto, index). Use when you need to discover available symbols for trading, search for specific symbols by name or ticker, or browse symbols by market category. Supports pagination for large result sets and optional search filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default is 1. Use this to retrieve additional pages of results. |
| `type` | string ("us-stock" | "ca-stock" | "in-stock" | "ru-stock" | "forex" | "crypto" | "index") | Yes | Market type to retrieve symbols for. Must be one of: us-stock (US stocks), ca-stock (Canadian stocks), in-stock (Indian stocks), ru-stock (Russian stocks), forex (foreign exchange), crypto (cryptocurrencies), or index (market indices). |
| `search` | string | No | Optional search query to filter symbols by symbol ticker or name. For example, 'BTC' or 'Bitcoin' for cryptocurrency symbols. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Country

**Slug:** `FINAGE_SEARCH_COUNTRY`

Tool to search for countries by name and retrieve their details including country code, currency, flag, and phone code. Use when you need to find country information based on a partial or full country name match.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Search key to find countries by name (e.g., 'united', 'france', 'germany'). The search is case-insensitive and returns partial matches. |
| `limit` | integer | No | Maximum number of results to return. Default is 5. Use this to control the number of matching countries returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Cryptocurrency

**Slug:** `FINAGE_SEARCH_CRYPTOCURRENCY`

Tool to search for cryptocurrencies by name or symbol. Use when you need to find cryptocurrency information, discover available crypto symbols, or validate cryptocurrency identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Search key or query term to find cryptocurrencies (e.g., 'BTC', 'Bitcoin', 'ETH') |
| `limit` | integer | No | Maximum number of search results to return. Default is 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Currency

**Slug:** `FINAGE_SEARCH_CURRENCY`

Tool to search for currency pairs and forex symbols by currency code or partial match. Use when you need to discover available currency pairs, find forex symbols, or search for currencies by code (e.g., USD, EUR).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Search key to find currency pairs (e.g., USD, EUR, GBP). Can be a currency code or partial match. |
| `limit` | string | No | Maximum number of results to return. Default is 5 if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Market for Stocks

**Slug:** `FINAGE_SEARCH_MARKET`

Tool to search for stocks in a specific market by company name or symbol. Use when you need to find stock symbols by partial matches, discover available stocks, or look up ticker symbols by company name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Search key/query string to find matching stocks. Can be a partial company name, ticker symbol, or other identifying text. |
| `limit` | integer | No | Maximum number of search results to return. Default is 10. |
| `market` | string | Yes | Market name (currently only "us" is supported by Finage). The market identifier determines which regional stock exchange to search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |