# Polygon.io Polygon.io provides real-time and historical market data APIs for stocks, options, forex, and cryptocurrencies, enabling developers to build financial applications with ease. - **Category:** analytics - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 64 - **Triggers:** 0 - **Slug:** `POLYGON_IO` - **Version:** 20260312_00 ## Tools ### Get All Tickers **Slug:** `POLYGON_IO_GET_ALL_TICKERS` Tool to retrieve a comprehensive list of supported ticker symbols across all asset classes. Use when you need to list all tickers with details like symbol, name, market, and status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cik` | string | No | Filter by CIK identifier. | | `date` | string | No | Filter tickers as of a specific date, format YYYY-MM-DD. | | `sort` | string | No | Field name to sort by (e.g., 'ticker', 'name', 'market', 'primary_exchange', 'last_updated_utc'). | | `type` | string | No | Filter by asset type (e.g., 'CS' for common stock, 'ETF', etc.). | | `cusip` | string | No | Filter by CUSIP identifier. | | `limit` | integer | No | Maximum number of results to return (1-1000). | | `order` | string ("asc" | "desc") | No | Sort order direction: 'asc' or 'desc'. | | `active` | boolean | No | If true, only return symbols that are currently active. | | `cursor` | string | No | Pagination cursor to fetch next page of results. Pass the 'cursor' value from a previous response. | | `market` | string | No | Filter by market (e.g., 'stocks', 'crypto', 'fx', 'options'). | | `search` | string | No | Partial text search on ticker symbol or company name. | | `ticker` | string | No | Exact match filter on a single ticker symbol. | | `exchange` | string | No | Filter by specific exchange code (e.g., 'XNAS', 'XNYS'). | #### 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 Condition Codes **Slug:** `POLYGON_IO_GET_CONDITION_CODES` Tool to retrieve a unified list of trade and quote condition codes and their definitions. Use when needing to decode condition identifiers after fetching market data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | No | Filter by specific condition code ID (integer). | | `sort` | string | No | Field used to sort results, e.g., 'name', 'asset_class', 'id'. | | `limit` | integer | No | Maximum number of results to return (server default: 10). | | `order` | string ("asc" | "desc") | No | Order of results: 'asc' (ascending) or 'desc' (descending). | | `data_type` | string ("trade" | "quote") | No | Filter by data type: 'trade' or 'quote'. | | `asset_class` | string | No | Filter by asset class, e.g., 'stocks', 'crypto', 'fx'. | #### 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 EMA **Slug:** `POLYGON_IO_GET_CRYPTO_EMA` Tool to calculate Exponential Moving Average (EMA) technical indicator for a crypto ticker. Use when you need trend analysis or moving average calculations for cryptocurrency pairs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned. Defaults to 10. Maximum is 5000. | | `order` | string ("asc" | "desc") | No | The order in which to return the results, ordered by timestamp. Defaults to 'desc'. | | `window` | integer | No | The window size used to calculate the exponential moving average (EMA). For example, a window size of 10 with daily aggregates would result in a 10 day moving average. Defaults to 50. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the EMA are adjusted for splits. Defaults to True. | | `timespan` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | No | The size of the aggregate time window. Defaults to 'day'. | | `timestamp` | string | No | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate the exponential moving average. Defaults to 'close'. | | `timestamp.gt` | string | No | Filter for timestamps greater than the specified value. | | `timestamp.lt` | string | No | Filter for timestamps less than the specified value. | | `crypto_ticker` | string | Yes | The cryptocurrency ticker symbol in the format X:BTCUSD, X:ETHBTC, etc. Must include the 'X:' prefix for cryptocurrency pairs. | | `timestamp.gte` | string | No | Filter for timestamps greater than or equal to the specified value. | | `timestamp.lte` | string | No | Filter for timestamps less than or equal to the specified value. | | `expand_underlying` | boolean | No | Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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 Crypto MACD **Slug:** `POLYGON_IO_GET_CRYPTO_MACD` Tool to calculate Moving Average Convergence/Divergence (MACD) technical indicator for a crypto ticker. Use when you need momentum analysis, trend identification, or trading signal generation for cryptocurrency pairs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned. Must be between 1 and 5000. Defaults to 10. | | `order` | string ("asc" | "desc") | No | Order of results by timestamp. 'asc' returns oldest first, 'desc' returns newest first. Defaults to 'desc'. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the MACD are adjusted for splits. Defaults to True. | | `timespan` | string | No | The size of the aggregate time window. Options: minute, hour, day, week, month, quarter, year. Defaults to 'day'. | | `timestamp` | string | No | Query by timestamp. Either a date with format YYYY-MM-DD or a millisecond timestamp. | | `long_window` | integer | Yes | The long window size (number of periods) used to calculate MACD data. Traditional value: 26. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate MACD. Options: open, high, low, close. Defaults to 'close'. | | `short_window` | integer | Yes | The short window size (number of periods) used to calculate MACD data. Traditional value: 12. | | `crypto_ticker` | string | Yes | The crypto ticker symbol in format X:FROMTO (e.g., 'X:BTCUSD', 'X:ETHUSD'). Must include the 'X:' prefix for cryptocurrency pairs. | | `signal_window` | integer | Yes | The window size (number of periods) used to calculate the MACD signal line. Traditional value: 9. | | `expand_underlying` | boolean | No | Whether to include the aggregates used to calculate this indicator in the response. Defaults to 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 Crypto Open/Close **Slug:** `POLYGON_IO_GET_CRYPTO_OPEN_CLOSE` Tool to get the open, close, high, low, and volume for a cryptocurrency pair on a specific date. Use when you need historical daily OHLC data for crypto pairs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to` | string | Yes | The "to" symbol of the cryptocurrency pair (e.g., USD, EUR). | | `date` | string | Yes | The date of the requested open/close in the format YYYY-MM-DD. | | `from` | string | Yes | The "from" symbol of the cryptocurrency pair (e.g., BTC, ETH). | | `adjusted` | boolean | No | Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. | #### 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 RSI **Slug:** `POLYGON_IO_GET_CRYPTO_RSI` Tool to calculate the Relative Strength Index (RSI) for a cryptocurrency ticker. Use when you need to analyze momentum or identify overbought/oversold conditions for crypto assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned. Default: 5000. Max: 5000. | | `order` | string ("asc" | "desc") | No | The order in which to return the results, ordered by timestamp. Defaults to 'desc'. | | `window` | integer | No | The window size used to calculate the relative strength index (RSI). Defaults to 14. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the RSI are adjusted for splits. Defaults to True. | | `timespan` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | No | The size of the aggregate time window. Defaults to 'day'. | | `timestamp` | string | No | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate the relative strength index. Defaults to 'close'. | | `timestamp.gt` | string | No | Filter for timestamps greater than the specified value. | | `timestamp.lt` | string | No | Filter for timestamps less than the specified value. | | `crypto_ticker` | string | Yes | The cryptocurrency ticker symbol in the format X:BTCUSD, X:ETHBTC, etc. | | `timestamp.gte` | string | No | Filter for timestamps greater than or equal to the specified value. | | `timestamp.lte` | string | No | Filter for timestamps less than or equal to the specified value. | | `expand_underlying` | boolean | No | Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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 Crypto SMA **Slug:** `POLYGON_IO_GET_CRYPTO_SMA` Tool to calculate Simple Moving Average (SMA) technical indicator for a cryptocurrency ticker. Use when you need trend analysis, support/resistance levels, or trading signal generation for crypto pairs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of base aggregates queried to create the aggregate results. Min: 1, Max: 50000. Defaults to 5000. | | `order` | string ("asc" | "desc") | No | The order in which to return the results, ordered by timestamp. 'asc' returns oldest first, 'desc' returns newest first. Defaults to 'desc'. | | `window` | integer | Yes | The window size (number of periods) used to calculate the SMA. For example, 50 for a 50-period moving average. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the SMA are adjusted for splits. Defaults to True. | | `timespan` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | Yes | The size of the aggregate time window. Options: minute, hour, day, week, month, quarter, year. | | `timestamp` | string | No | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate the SMA. Options: open, high, low, close. Defaults to 'close'. | | `timestamp.gt` | string | No | Filter for timestamps greater than the specified value. | | `timestamp.lt` | string | No | Filter for timestamps less than the specified value. | | `crypto_ticker` | string | Yes | The cryptocurrency ticker symbol in the format X:BTCUSD, X:ETHUSD, etc. Must include the 'X:' prefix for cryptocurrency pairs. | | `timestamp.gte` | string | No | Filter for timestamps greater than or equal to the specified value. | | `timestamp.lte` | string | No | Filter for timestamps less than or equal to the specified value. | | `expand_underlying` | boolean | No | Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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 Daily Open/Close **Slug:** `POLYGON_IO_GET_DAILY_OPEN_CLOSE` Tool to get the daily open, close, after-hours, and pre-market prices for a stock on a specific date. Use when you need historical OHLC data for a specific trading day, including pre-market and after-hours information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | The date of the requested open/close in the format YYYY-MM-DD (e.g., '2023-03-10', '2026-02-13'). | | `adjusted` | boolean | No | Whether or not the results are adjusted for splits. Default is true. | | `stocks_ticker` | string | Yes | The ticker symbol of the stock (e.g., 'AAPL', 'TSLA', 'MSFT'). Must be a valid stock ticker. | #### 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 Dividends **Slug:** `POLYGON_IO_GET_DIVIDENDS` Tool to retrieve a historical record of cash dividend distributions for a given ticker. Use when analyzing dividend payments by date, amount, and frequency. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field to sort by; only 'ex_dividend_date' is supported. | | `limit` | integer | No | Limit number of results (1-1000). | | `order` | string ("asc" | "desc") | No | Order of sorting: 'asc' or 'desc'. | | `ticker` | string | No | Case-sensitive ticker symbol, e.g., 'AAPL'. | | `pay_date` | string | No | Filter by payment date (YYYY-MM-DD). | | `frequency` | integer ("0" | "1" | "2" | "4" | "12" | "24" | "52") | No | Number of dividend payments per year. 0=one-time, 1=annually, 2=bi-annually, 4=quarterly, 12=monthly, 24=bi-monthly, 52=weekly. | | `cash_amount` | number | No | Filter by cash amount of the dividend per share. | | `record_date` | string | No | Filter by record date (YYYY-MM-DD). | | `dividend_type` | string ("CD" | "SC" | "LT" | "ST") | No | Type of dividend: 'CD' for consistent cash, 'SC' for special cash, 'LT' for long-term capital gain, 'ST' for short-term capital gain. | | `declaration_date` | string | No | Filter by declaration date (YYYY-MM-DD). | | `ex_dividend_date` | string | No | Filter by ex-dividend date (YYYY-MM-DD). | #### 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 Economy Inflation Indicators (Enhanced) **Slug:** `POLYGON_IO_GET_ECONOMY_INFLATION2` Tool to retrieve key indicators of realized inflation including CPI and PCE price indexes with comprehensive date filtering. Use when analyzing inflation trends with specific date ranges, economic conditions, or historical price changes going back to 1947. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Specific observation date in YYYY-MM-DD format. If not provided, returns recent observations. | | `sort` | string | No | Sort order for results. Use 'date.asc' for ascending or 'date.desc' for descending. Defaults to 'date.asc'. | | `limit` | integer | No | Maximum results to return. Defaults to 100, maximum is 50,000. | | `date.gt` | string | No | Filter for dates greater than the specified date in YYYY-MM-DD format | | `date.lt` | string | No | Filter for dates less than the specified date in YYYY-MM-DD format | | `date.gte` | string | No | Filter for dates greater than or equal to the specified date in YYYY-MM-DD format | | `date.lte` | string | No | Filter for dates less than or equal to the specified date in YYYY-MM-DD format | | `date.any_of` | string | No | Match multiple comma-separated dates, e.g., '2024-01-01,2024-02-01' | #### 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 Exponential Moving Average **Slug:** `POLYGON_IO_GET_EMA` Tool to retrieve the Exponential Moving Average for a stock ticker. Use when you need EMA values across a specific timespan with optional underlying data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of results to return (1-5000). Defaults to 100. | | `order` | string ("asc" | "desc") | No | Sort order for results. Defaults to 'desc'. | | `window` | integer | Yes | Number of periods to calculate the EMA (must be ≥1). | | `adjusted` | boolean | No | Whether to adjust results for splits/dividends. Defaults to True. | | `timespan` | string | Yes | The timespan for each period (e.g., 'day', 'minute', 'hour'). | | `series_type` | string ("open" | "high" | "low" | "close") | No | Price series to use. Defaults to 'close'. | | `stock_ticker` | string | Yes | The stock ticker symbol. | | `expand_underlying` | boolean | No | Include underlying price data. Defaults to 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 SEC Filing **Slug:** `POLYGON_IO_GET_FILING` Tool to retrieve detailed information about a specific SEC filing by filing ID. Use when you need to access full filing details including accession number, filing type, dates, source URLs, and associated entities. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filing_id` | string | Yes | The unique filing ID (accession number format: XXXXXXXXXX-XX-XXXXXX). Example: '0002057381-26-000010' | #### 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 Filing File **Slug:** `POLYGON_IO_GET_FILING_FILE` Tool to download a specific file from an SEC filing. Use when you need to access individual documents from a company's SEC filings, such as 10-Q, 10-K, or other submission files. Returns the raw file content (HTML, XML, XBRL, etc.). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | The unique identifier for the file within the filing, e.g., 'readvantage10q_12312025.htm' or 'ex31.htm'. Use the filename from the LIST_FILING_FILES action. | | `filing_id` | string | Yes | The unique identifier for the SEC filing, e.g., '0002057381-26-000010'. This is the filing accession number. | #### 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 EMA **Slug:** `POLYGON_IO_GET_FOREX_EMA` Tool to calculate Exponential Moving Average (EMA) technical indicator for a forex pair. Use when you need trend analysis or moving average calculations for currency pairs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned. Defaults to 10. Maximum is 5000. | | `order` | string ("asc" | "desc") | No | The order in which to return the results, ordered by timestamp. 'asc' for ascending/oldest first, 'desc' for descending/newest first. Defaults to 'desc'. | | `window` | integer | No | The window size used to calculate the exponential moving average (EMA). For example, a window size of 10 with daily aggregates would result in a 10 day moving average. Defaults to 50. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. Defaults to True. | | `timespan` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | No | The size of the aggregate time window. Defaults to 'day'. | | `timestamp` | string | No | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate the exponential moving average. Defaults to 'close'. | | `forex_ticker` | string | Yes | The forex ticker symbol in format C:FROMTO (e.g., 'C:EURUSD', 'C:GBPJPY'). Must include the 'C:' prefix for forex currency pairs. | | `expand_underlying` | boolean | No | Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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 Forex MACD **Slug:** `POLYGON_IO_GET_FOREX_MACD` Tool to calculate Moving Average Convergence/Divergence (MACD) technical indicator for a forex pair. Use when you need momentum analysis, trend identification, or trading signal generation for currency pairs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of results to return. Must be between 1 and 5000. Defaults to 10. | | `order` | string ("asc" | "desc") | No | The order in which to return results, ordered by timestamp. 'asc' returns oldest first, 'desc' returns newest first. Defaults to 'desc'. | | `adjusted` | boolean | No | Whether the aggregates used to calculate MACD are adjusted for splits. Defaults to True. | | `timespan` | string | Yes | The size of the aggregate time window (e.g., 'day', 'hour', 'minute'). | | `timestamp` | string | No | Filter by timestamp. Can be a date in YYYY-MM-DD format or a millisecond timestamp. | | `long_window` | integer | Yes | The long window size (number of periods) used to calculate MACD data. Typically 26. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price field in the aggregate which will be used to calculate MACD. Defaults to 'close'. | | `forex_ticker` | string | Yes | The forex ticker symbol in format C:FROMTO (e.g., 'C:EURUSD', 'C:GBPJPY'). Must include the 'C:' prefix for forex currency pairs. | | `short_window` | integer | Yes | The short window size (number of periods) used to calculate MACD data. Typically 12. | | `timestamp_gt` | string | No | Range filter - only include results where timestamp is greater than this value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_lt` | string | No | Range filter - only include results where timestamp is less than this value. Format: YYYY-MM-DD or millisecond timestamp. | | `signal_window` | integer | Yes | The window size (number of periods) used to calculate the MACD signal line. Typically 9. | | `timestamp_gte` | string | No | Range filter - only include results where timestamp is greater than or equal to this value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_lte` | string | No | Range filter - only include results where timestamp is less than or equal to this value. Format: YYYY-MM-DD or millisecond timestamp. | | `expand_underlying` | boolean | No | Whether to include the underlying aggregates used to calculate this indicator in the response. Defaults to 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 Forex Real-Time Currency Conversion **Slug:** `POLYGON_IO_GET_FOREX_REAL_TIME_CURRENCY_CONVERSION` Tool to convert amounts between currency pairs using real-time forex rates. Use when you need to perform currency conversions with the latest market rates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `amount` | number | No | The amount to convert with decimal precision. If not provided, defaults to 1. | | `precision` | integer | No | The decimal precision of the conversion result. Defaults to 2 decimal places. | | `to_currency` | string | Yes | The 'to' currency symbol to convert to (e.g., 'EUR', 'USD', 'JPY'). | | `from_currency` | string | Yes | The 'from' currency symbol to convert from (e.g., 'USD', 'EUR', 'GBP'). | #### 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 RSI **Slug:** `POLYGON_IO_GET_FOREX_RSI` Tool to calculate the Relative Strength Index (RSI) technical indicator for a forex pair. Use when you need momentum analysis or want to identify overbought/oversold conditions for currency pairs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned. Default: 5000. Max: 5000. | | `order` | string ("asc" | "desc") | No | The order in which to return the results, ordered by timestamp. 'asc' returns oldest first, 'desc' returns newest first. Defaults to 'desc'. | | `window` | integer | Yes | The window size used to calculate the Relative Strength Index (RSI). Typically 14 for standard RSI calculation. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the RSI are adjusted for splits. Defaults to True. | | `timespan` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | Yes | The size of the aggregate time window. Required parameter to define the period for RSI calculation. | | `timestamp` | string | No | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate the RSI. Defaults to 'close'. | | `forex_ticker` | string | Yes | The forex ticker symbol in format C:FROMTO (e.g., 'C:EURUSD', 'C:GBPJPY'). Must include the 'C:' prefix for forex currency pairs. | | `timestamp_gt` | string | No | Filter for timestamps greater than the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_lt` | string | No | Filter for timestamps less than the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_gte` | string | No | Filter for timestamps greater than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_lte` | string | No | Filter for timestamps less than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `expand_underlying` | boolean | No | Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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 Forex SMA **Slug:** `POLYGON_IO_GET_FOREX_SMA` Tool to calculate Simple Moving Average (SMA) technical indicator for a forex pair. Use when you need trend analysis or moving average calculations for currency pairs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned. Defaults to 10. Maximum is 5000. | | `order` | string ("asc" | "desc") | No | The order in which to return the results, ordered by timestamp. 'asc' for ascending/oldest first, 'desc' for descending/newest first. Defaults to 'desc'. | | `window` | integer | No | The window size used to calculate the SMA. For example, a window of 10 with daily aggregates equals a 10-day moving average. Defaults to 50. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the SMA are adjusted for splits. Defaults to True. | | `timespan` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | No | The size of the aggregate time window. Defaults to 'day'. | | `timestamp` | string | No | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate the SMA. Defaults to 'close'. | | `forex_ticker` | string | Yes | The forex ticker symbol in format C:FROMTO (e.g., 'C:EURUSD', 'C:GBPJPY'). Must include the 'C:' prefix for forex currency pairs. | | `timestamp.gt` | string | No | Filter for timestamps greater than the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp.lt` | string | No | Filter for timestamps less than the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp.gte` | string | No | Filter for timestamps greater than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp.lte` | string | No | Filter for timestamps less than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `expand_underlying` | boolean | No | Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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 Futures Quotes **Slug:** `POLYGON_IO_GET_FUTURES_QUOTES` Tool to get real-time quote information for futures contracts with bid/ask prices, sizes, and timestamps. Use when you need to analyze current or historical quote data for futures trading decisions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Sort field used for ordering results. Use dotted notation (e.g., 'timestamp', 'ticker'). | | `limit` | integer | No | Limit the number of results returned per page. Default: 1000, Maximum: 50000. | | `order` | string ("asc" | "desc") | No | Order results based on the sort field. 'asc' for ascending, 'desc' for descending. | | `timestamp` | string | No | Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. | | `futures_ticker` | string | Yes | The futures contract ticker symbol including base symbol and contract expiration (e.g., 'GCJ25' for Gold April 2025, 'ESZ5' for E-mini S&P 500 December 2025). | #### 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 Grouped Daily Market Summary **Slug:** `POLYGON_IO_GET_GROUPED_DAILY` Tool to retrieve daily OHLCV data for the entire market for a given date. Use when you need grouped daily aggregate bars for all tickers in a specific market (stocks, crypto, or fx) and locale. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | The date to get aggregate bars for in YYYY-MM-DD format (e.g., '2026-02-13'). | | `locale` | string ("us" | "global") | Yes | The locale of the aggregates. Specify 'us' for US market or 'global' for global markets. | | `market` | string ("stocks" | "crypto" | "fx") | Yes | The market type. Options are 'stocks', 'crypto', or 'fx'. | | `adjusted` | boolean | No | Whether results are adjusted for splits. Set to false for unadjusted results. Defaults to 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 Historic Forex Ticks **Slug:** `POLYGON_IO_GET_HISTORIC_FOREX_TICKS` Tool to get historic ticks for a currency pair on a specific date. Use when you need historical forex tick-level data (ask/bid prices with timestamps) for a given day. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | The specific day for which to retrieve historical tick data in YYYY-MM-DD or YYYY-M-D format (e.g., '2017-6-22', '2024-01-15'). | | `limit` | integer | No | Controls response size; defaults to 100, maximum of 10,000 entries. | | `offset` | integer | No | Pagination mechanism using timestamp offset to fetch the next set of results. | | `to_currency` | string | Yes | The 'to' currency symbol (quote currency) in the pair (e.g., 'JPY', 'USD', 'EUR'). | | `from_currency` | string | Yes | The 'from' currency symbol (base currency) in the pair (e.g., 'USD', 'EUR', 'GBP'). | #### 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 Inflation Expectations **Slug:** `POLYGON_IO_GET_INFLATION_EXPECTATIONS` Tool to retrieve inflation expectations data from the Federal Reserve, including market-based rates and Cleveland Fed model estimates. Use when analyzing inflation forecasts across different time horizons (1, 5, 10, and 30 years). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Filter by specific observation date (YYYY-MM-DD format). | | `sort` | string | No | Comma-separated list of sort columns with .asc or .desc suffix (e.g., 'date.asc'). | | `limit` | integer | No | Maximum number of results to return (1-50000). Default: 100. | | `date_gt` | string | No | Filter for dates after this value (YYYY-MM-DD format). | | `date_lt` | string | No | Filter for dates before this value (YYYY-MM-DD format). | | `date_gte` | string | No | Filter for dates on or after this value (YYYY-MM-DD format). | | `date_lte` | string | No | Filter for dates on or before this value (YYYY-MM-DD format). | | `date_any_of` | string | No | Match any of the comma-separated date values (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 IPO Data **Slug:** `POLYGON_IO_GET_IPO_DATA` Tool to retrieve comprehensive information on Initial Public Offerings (IPOs), including upcoming and historical events. Use when analyzing IPO listing data by date range, ticker, or identifier. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `isin` | string | No | Filter by ISIN (International Securities Identification Number). | | `sort` | string | No | Field to sort by (e.g., 'listing_date', 'ticker'). Default: 'listing_date'. | | `limit` | integer | No | Limit the number of results returned (1-1000). Default: 10, Max: 1000. | | `order` | string ("asc" | "desc") | No | Sort order direction: 'asc' for ascending or 'desc' for descending. Default: 'desc'. | | `ticker` | string | No | Filter by ticker symbol. | | `us_code` | string | No | Filter by US code (ISIN identifier). | | `listing_date` | string | No | Filter by exact listing date (format: YYYY-MM-DD). | | `listing_date_gte` | string | No | Filter for IPOs listed on or after this date (format: YYYY-MM-DD). | | `listing_date_lte` | string | No | Filter for IPOs listed on or before this date (format: YYYY-MM-DD). | #### 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 Labor Market Data **Slug:** `POLYGON_IO_GET_LABOR_MARKET` Tool to retrieve labor market data including unemployment rate, labor force participation rate, average hourly earnings, and job openings. Use when analyzing employment trends, economic conditions, or workforce statistics. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Specific observation date in YYYY-MM-DD format. If not provided, returns recent observations. | | `sort` | string | No | Sort order for results. Comma-separated columns with .asc/.desc direction suffix, e.g., 'date.asc' or 'date.desc' | | `limit` | integer | No | Maximum results to return. Defaults to 100, maximum is 50,000. | | `date.gt` | string | No | Filter for dates greater than the specified date in YYYY-MM-DD format | | `date.lt` | string | No | Filter for dates less than the specified date in YYYY-MM-DD format | | `date.gte` | string | No | Filter for dates greater than or equal to the specified date in YYYY-MM-DD format | | `date.lte` | string | No | Filter for dates less than or equal to the specified date in YYYY-MM-DD format | | `date.any_of` | string | No | Match multiple comma-separated dates, e.g., '2024-01-01,2024-02-01' | #### 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 MACD **Slug:** `POLYGON_IO_GET_MACD` Tool to retrieve the Moving Average Convergence/Divergence (MACD) for a stock ticker. Use when you need momentum analysis or signal generation over a specified timeframe. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of results to return (1-5000). Defaults to 10. | | `order` | string ("asc" | "desc") | No | The order of results by timestamp. Defaults to 'desc'. | | `adjusted` | boolean | No | Whether to use split-adjusted aggregates. Defaults to True. | | `timespan` | string | Yes | The size of the aggregate time window (e.g., 'day'). | | `timestamp` | string | No | Filter by timestamp (YYYY-MM-DD or millisecond timestamp). | | `long_window` | integer | Yes | The number of periods for the long EMA window (e.g., 26). | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price field to use for calculations. Defaults to 'close'. | | `short_window` | integer | Yes | The number of periods for the short EMA window (e.g., 12). | | `stock_ticker` | string | Yes | The case-sensitive ticker symbol for which to get MACD data (e.g., 'AAPL'). | | `signal_window` | integer | Yes | The number of periods for the signal line EMA window (e.g., 9). | | `expand_underlying` | boolean | No | Whether to include the underlying aggregates data. Defaults to 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 Market Holidays **Slug:** `POLYGON_IO_GET_MARKET_HOLIDAYS` Tool to retrieve upcoming market holidays and their corresponding open/close times. Use when planning around market schedules before trading. #### 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 Market Status **Slug:** `POLYGON_IO_GET_MARKET_STATUS` Tool to retrieve the current trading status across major exchanges and currency markets. Use for real-time monitoring, scheduling, or UI updates. #### 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 News **Slug:** `POLYGON_IO_GET_NEWS` Tool to retrieve the most recent news articles for a specified ticker. Use when you need summaries, source details, and sentiment analysis for market news. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field to sort by; only 'published_utc' is supported | | `limit` | integer | No | Limit the number of results (1-1000). Defaults to 10 if not provided. | | `order` | string ("asc" | "desc") | No | Order of results by published_utc: 'asc' or 'desc' | | `cursor` | string | No | Cursor for pagination. Use the 'next_url' or cursor value from previous response. | | `ticker` | string | No | Only return news articles for this ticker symbol, e.g., 'AAPL' | | `published_utc.gte` | string | No | Return articles published on or after this UTC date/time (ISO-8601), e.g., '2022-01-01T00:00:00Z' | | `published_utc.lte` | string | No | Return articles published on or before this UTC date/time (ISO-8601), e.g., '2022-01-31T23:59:59Z' | #### 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 Options Contract Overview **Slug:** `POLYGON_IO_GET_OPTIONS_CONTRACT_OVERVIEW` Tool to retrieve comprehensive details about a specific options contract including contract type, exercise style, expiration date, strike price, and underlying ticker. Use when you need specifications for options contract analysis or strategy development. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `as_of` | string | No | Specify a point in time for the contract as of this date. Format: YYYY-MM-DD. Defaults to today's date. | | `options_ticker` | string | Yes | The options contract identifier following standard options ticker format (e.g., O:SPY241220C00450000, O:AAPL251219C00010000). | #### 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 Options EMA **Slug:** `POLYGON_IO_GET_OPTIONS_EMA` Tool to calculate Exponential Moving Average (EMA) technical indicator for an options ticker. Use when you need trend analysis or moving average calculations for options contracts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned. Must be between 1 and 5000. Defaults to 10. | | `order` | string ("asc" | "desc") | No | The order in which to return the results, ordered by timestamp. 'asc' returns oldest first, 'desc' returns newest first. Defaults to 'desc'. | | `window` | integer | Yes | The window size used to calculate the exponential moving average (EMA). For example, a window size of 10 with daily aggregates would result in a 10 day moving average. Required parameter. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the EMA are adjusted for splits. Defaults to True. | | `timespan` | string | Yes | The size of the aggregate time window. Options: minute, hour, day, week, month, quarter, year. Required parameter. | | `timestamp` | string | No | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate the exponential moving average. Defaults to 'close'. | | `timestamp.gt` | string | No | Filter for timestamps greater than the specified value. | | `timestamp.lt` | string | No | Filter for timestamps less than the specified value. | | `timestamp.gte` | string | No | Filter for timestamps greater than or equal to the specified value. | | `timestamp.lte` | string | No | Filter for timestamps less than or equal to the specified value. | | `options_ticker` | string | Yes | The options ticker symbol in format O:UNDERLYINGYYMMDDCOOOOOOOOO (e.g., 'O:AAPL250117C00250000'). Must include the 'O:' prefix for options contracts. | | `expand_underlying` | boolean | No | Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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 Options MACD **Slug:** `POLYGON_IO_GET_OPTIONS_MACD` Tool to calculate Moving Average Convergence/Divergence (MACD) technical indicator for an options ticker. Use when you need momentum analysis, trend identification, or trading signal generation for options contracts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned. Must be between 1 and 5000. Defaults to 10. | | `order` | string ("asc" | "desc") | No | Order of results by timestamp. 'asc' returns oldest first, 'desc' returns newest first. Defaults to 'desc'. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the MACD are adjusted for splits. Defaults to True. | | `timespan` | string | Yes | The size of the aggregate time window. Options: minute, hour, day, week, month, quarter, year. Required parameter. | | `timestamp` | string | Yes | Query by timestamp. Either a date with format YYYY-MM-DD or a millisecond timestamp. Required parameter. | | `long_window` | integer | Yes | The long window size (number of periods) used to calculate MACD data. Traditional value: 26. Required parameter. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate MACD. Options: open, high, low, close. Defaults to 'close'. | | `short_window` | integer | Yes | The short window size (number of periods) used to calculate MACD data. Traditional value: 12. Required parameter. | | `signal_window` | integer | Yes | The window size (number of periods) used to calculate the MACD signal line. Traditional value: 9. Required parameter. | | `options_ticker` | string | Yes | The options ticker symbol in format O:UNDERLYINGYYMMDDCOOOOOOOOO (e.g., 'O:AAPL251219C00150000'). Must include the 'O:' prefix for options contracts. | | `expand_underlying` | boolean | No | Whether to include the aggregates used to calculate this indicator in the response. Defaults to 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 Options RSI **Slug:** `POLYGON_IO_GET_OPTIONS_RSI` Tool to calculate Relative Strength Index (RSI) technical indicator for an options ticker. Use when you need momentum analysis or want to identify overbought/oversold conditions for options contracts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of base aggregates queried to create the aggregate results. Default: 5000. Max: 50000. | | `order` | string ("asc" | "desc") | No | The order in which to return the results, ordered by timestamp. 'asc' returns oldest first, 'desc' returns newest first. Defaults to 'desc'. | | `window` | integer | No | The window size used to calculate the Relative Strength Index (RSI). Typically 14 for standard RSI calculation. Defaults to 14. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the RSI are adjusted for splits. Defaults to True. | | `timespan` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | Yes | The size of the aggregate time window. Required parameter to define the period for RSI calculation. | | `timestamp` | string | No | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate the RSI. Defaults to 'close'. | | `timestamp_gt` | string | No | Filter for timestamps greater than the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_lt` | string | No | Filter for timestamps less than the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_gte` | string | No | Filter for timestamps greater than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_lte` | string | No | Filter for timestamps less than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `options_ticker` | string | Yes | The options ticker symbol in format O:UNDERLYINGYYMMDDCOOOOOOOOO (e.g., 'O:AAPL250117C00250000'). Must include the 'O:' prefix for options contracts. | | `expand_underlying` | boolean | No | Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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 Options SMA **Slug:** `POLYGON_IO_GET_OPTIONS_SMA` Tool to calculate Simple Moving Average (SMA) technical indicator for an options ticker. Use when you need trend analysis or smoothed price data for options contracts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Limit the number of results returned. Must be between 1 and 5000. Defaults to 10. | | `order` | string ("asc" | "desc") | No | The order in which to return the results, ordered by timestamp. 'asc' returns oldest first, 'desc' returns newest first. Defaults to 'asc'. | | `cursor` | string | No | Cursor value for pagination to fetch the next page of data. | | `window` | integer | Yes | The window size used to calculate the simple moving average (SMA). For example, a window of 10 with daily aggregates results in a 10-day moving average. Required parameter. | | `adjusted` | boolean | No | Whether or not the aggregates used to calculate the SMA are adjusted for splits. Defaults to True. | | `timespan` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | Yes | The size of the aggregate time window. Required parameter to define the period for SMA calculation. | | `timestamp` | string | No | Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. | | `series_type` | string ("open" | "high" | "low" | "close") | No | The price in the aggregate which will be used to calculate the SMA. Defaults to 'close'. | | `timestamp_gt` | string | No | Filter for timestamps greater than the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_lt` | string | No | Filter for timestamps less than the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_gte` | string | No | Filter for timestamps greater than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `timestamp_lte` | string | No | Filter for timestamps less than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp. | | `options_ticker` | string | Yes | The options ticker symbol in format O:UNDERLYINGYYMMDDCOOOOOOOOO (e.g., 'O:SPY241220C00580000'). Must include the 'O:' prefix for options contracts. | | `expand_underlying` | boolean | No | Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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 Related Companies **Slug:** `POLYGON_IO_GET_RELATED_COMPANIES` Tool to retrieve tickers related to a given ticker based on similar business or market characteristics. Use when you need to find companies similar to a specific ticker. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ticker` | string | Yes | The ticker symbol to find related companies for, e.g., 'AAPL'. | #### 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 RSI **Slug:** `POLYGON_IO_GET_RSI` Tool to retrieve the Relative Strength Index (RSI) for a stock ticker. Use after confirming ticker symbol and timespan to analyze momentum over a period. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of results to return (1-5000). Defaults to 5000. | | `order` | string ("asc" | "desc") | No | Sort order of results. Defaults to 'desc'. | | `window` | integer | No | Lookback window for RSI calculation (must be 1). Defaults to 14. | | `adjusted` | boolean | No | Whether to use adjusted values (splits/dividends). Defaults to True. | | `timespan` | string | Yes | The size of the time window (e.g., 'day', 'minute', 'hour'). | | `timestamp` | integer | No | Return results before this timestamp (ms since epoch). | | `series_type` | string ("open" | "high" | "low" | "close") | No | Price field to use for calculation. Defaults to 'close'. | | `stock_ticker` | string | Yes | The stock ticker symbol (e.g., 'AAPL'). | | `timestampLimit` | integer | No | Return results after this timestamp (ms since epoch). | #### 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 Simple Moving Average **Slug:** `POLYGON_IO_GET_SMA` Tool to retrieve the Simple Moving Average (SMA) for any ticker (stocks, forex, crypto). Use when you need SMA values over a specified timespan with optional underlying data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of results to return (1-1000). Defaults to 250. | | `order` | string ("asc" | "desc") | No | Sort order for results. Defaults to 'desc'. | | `window` | integer | Yes | Number of periods to calculate the SMA (must be ≥1). | | `adjusted` | boolean | No | Whether to adjust results for splits/dividends. Defaults to True. | | `timespan` | string | Yes | The timespan for each period (e.g., 'minute', 'hour', 'day'). | | `fx_ticker` | string | Yes | The ticker symbol. Use 'C:EURUSD' for forex, 'AAPL' for stocks, 'X:BTCUSD' for crypto. | | `timestamp` | integer | No | Millisecond UNIX timestamp to anchor the indicator. Defaults to most recent. | | `series_type` | string ("open" | "high" | "low" | "close") | No | Price series to use. Defaults to 'close'. | | `expand_underlying` | boolean | No | Include underlying aggregate data. Defaults to 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 Splits **Slug:** `POLYGON_IO_GET_SPLITS` Tool to retrieve historical stock split events for a given ticker. Use after identifying the ticker to fetch split history including ratio, ex-date, and record dates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field to sort by; only 'execution_date' is supported. | | `limit` | integer | No | Limit number of results (1-1000). | | `order` | string ("asc" | "desc") | No | Sort order direction: 'asc' or 'desc'. | | `cursor` | string | No | Pagination cursor to fetch next page of results. Pass a previous 'cursor' value. | | `ticker` | string | No | Case-sensitive ticker symbol, e.g., 'AAPL'. | | `asset_class` | string | No | Filter by asset class, e.g., 'stocks', 'crypto'. | | `reverse_split` | boolean | No | Query for reverse stock splits. A split ratio where split_from is greater than split_to represents a reverse split. | | `execution_date` | string | No | Filter by execution date (YYYY-MM-DD). | | `execution_type` | string | No | Filter by execution type (e.g., 'Market', 'Limit'). | #### 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 Stocks Custom Bars **Slug:** `POLYGON_IO_GET_STOCKS_CUSTOM_BARS` Tool to retrieve aggregated historical OHLC and volume data for a stock over custom date ranges with configurable time windows. Use when you need aggregate bars for stock price analysis, backtesting, or charting. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("asc" | "desc") | No | Sort results by timestamp. 'asc' for ascending (oldest first), 'desc' for descending (newest first). | | `limit` | integer | No | Limits the number of base aggregates queried. Maximum: 50000, Default: 5000. | | `to_date` | string | Yes | The end of the aggregate time window. Can be in YYYY-MM-DD format or Unix millisecond timestamp. | | `adjusted` | boolean | No | Whether results are adjusted for splits. Set to false to get results that are NOT adjusted for splits. Defaults to true. | | `timespan` | string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year") | Yes | The size of the time window for each aggregate bar. | | `from_date` | string | Yes | The start of the aggregate time window. Can be in YYYY-MM-DD format or Unix millisecond timestamp. | | `multiplier` | integer | Yes | The size of the timespan multiplier. Must be a positive integer. Used to customize the time window size. | | `stocks_ticker` | string | Yes | The ticker symbol of the stock/equity (e.g., 'AAPL', 'TSLA', 'MSFT'). Must be a valid stock ticker. | #### 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 Stocks Daily Market Summary **Slug:** `POLYGON_IO_GET_STOCKS_DAILY_MARKET_SUMMARY` Tool to retrieve daily OHLC, volume, and VWAP data for all U.S. stocks on a specified trading date. Use when you need to get grouped daily aggregate bars for all US stocks for a specific date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | The date to get aggregate bars for in YYYY-MM-DD format (e.g., '2024-12-13') | | `adjusted` | boolean | No | Whether results are adjusted for splits. Set to false for unadjusted results. Defaults to true. | | `include_otc` | boolean | No | Include OTC (Over-The-Counter) securities in response. Defaults to 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 Stocks Filings Risk Factors **Slug:** `POLYGON_IO_GET_STOCKS_FILINGS_RISK_FACTORS` Tool to retrieve risk factors identified in companies' 10K filings. Use when analyzing company risks, regulatory disclosures, or compliance requirements. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cik` | string | No | SEC Central Index Key (10 digits, zero-padded). | | `sort` | string | No | A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'filing_date' if not specified. The sort order defaults to 'desc' if not specified. | | `limit` | integer | No | Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '49999'. | | `cik.gt` | string | No | Filter greater than the value. | | `cik.lt` | string | No | Filter less than the value. | | `ticker` | string | No | Stock ticker symbol for the company. | | `cik.gte` | string | No | Filter greater than or equal to the value. | | `cik.lte` | string | No | Filter less than or equal to the value. | | `ticker.gt` | string | No | Filter greater than the value. | | `ticker.lt` | string | No | Filter less than the value. | | `cik.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `ticker.gte` | string | No | Filter greater than or equal to the value. | | `ticker.lte` | string | No | Filter less than or equal to the value. | | `filing_date` | string | No | Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). | | `ticker.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `filing_date.gt` | string | No | Filter greater than the value. | | `filing_date.lt` | string | No | Filter less than the value. | | `filing_date.gte` | string | No | Filter greater than or equal to the value. | | `filing_date.lte` | string | No | Filter less than or equal to the value. | | `filing_date.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | #### 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 Stocks Filings Sections **Slug:** `POLYGON_IO_GET_STOCKS_FILINGS_SECTIONS` Tool to retrieve raw text content from specific sections of SEC filings (10-K, 10-Q, etc.). Use when you need detailed textual information from SEC documents like business descriptions or risk factors. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cik` | string | No | SEC Central Index Key (10 digits, zero-padded). Filter by exact CIK value. | | `sort` | string | No | Comma-separated list of sort columns. Append '.asc' or '.desc' to specify direction. Defaults to 'period_end.desc'. | | `limit` | integer | No | Limit the maximum number of results returned. Defaults to 100. Maximum allowed is 9999. | | `cik.gt` | string | No | Filter CIK greater than the specified value. | | `cik.lt` | string | No | Filter CIK less than the specified value. | | `ticker` | string | No | Stock ticker symbol for the company. Filter by exact ticker value. | | `cik.gte` | string | No | Filter CIK greater than or equal to the specified value. | | `cik.lte` | string | No | Filter CIK less than or equal to the specified value. | | `section` | string ("business" | "risk_factors") | No | Standardized section identifiers from SEC filings. | | `ticker.gt` | string | No | Filter ticker greater than the specified value (alphabetically). | | `ticker.lt` | string | No | Filter ticker less than the specified value (alphabetically). | | `cik.any_of` | string | No | Filter CIK equal to any of the values. Comma-separated list of CIK values. | | `period_end` | string | No | Period end date that the filing relates to (YYYY-MM-DD format). Filter by exact period end date. | | `ticker.gte` | string | No | Filter ticker greater than or equal to the specified value (alphabetically). | | `ticker.lte` | string | No | Filter ticker less than or equal to the specified value (alphabetically). | | `filing_date` | string | No | Date when the filing was submitted to the SEC (YYYY-MM-DD format). Filter by exact filing date. | | `period_end.gt` | string | No | Filter period end date greater than the specified value (YYYY-MM-DD format). | | `period_end.lt` | string | No | Filter period end date less than the specified value (YYYY-MM-DD format). | | `ticker.any_of` | string | No | Filter ticker equal to any of the values. Comma-separated list of ticker symbols. | | `filing_date.gt` | string | No | Filter filing date greater than the specified value (YYYY-MM-DD format). | | `filing_date.lt` | string | No | Filter filing date less than the specified value (YYYY-MM-DD format). | | `period_end.gte` | string | No | Filter period end date greater than or equal to the specified value (YYYY-MM-DD format). | | `period_end.lte` | string | No | Filter period end date less than or equal to the specified value (YYYY-MM-DD format). | | `section.any_of` | string | No | Filter section equal to any of the values. Comma-separated list of section identifiers. | | `filing_date.gte` | string | No | Filter filing date greater than or equal to the specified value (YYYY-MM-DD format). | | `filing_date.lte` | string | No | Filter filing date less than or equal to the specified value (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 Stocks Free Float **Slug:** `POLYGON_IO_GET_STOCKS_FREE_FLOAT` Tool to retrieve free float data for US-listed securities showing the most recent available number of shares available for public trading and the percentage of total shares outstanding. Use when analyzing stock liquidity, ownership structure, or available trading shares. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified. | | `limit` | integer | No | Limit the maximum number of results returned. Defaults to 100 if not specified. The maximum allowed limit is 5000. | | `ticker` | string | No | The primary ticker symbol for the stock. Filter for an exact match. | | `ticker.gt` | string | No | Filter for tickers greater than the specified value. | | `ticker.lt` | string | No | Filter for tickers less than the specified value. | | `ticker.gte` | string | No | Filter for tickers greater than or equal to the specified value. | | `ticker.lte` | string | No | Filter for tickers less than or equal to the specified value. | | `ticker.any_of` | string | No | Filter equal to any of the ticker values. Multiple values can be specified by using a comma separated list. | | `free_float_percent` | number | No | Percentage of total shares outstanding that are available for public trading, rounded to two decimal places. Filter for an exact match. | | `free_float_percent.gt` | number | No | Filter for free float percentage greater than the specified value. | | `free_float_percent.lt` | number | No | Filter for free float percentage less than the specified value. | | `free_float_percent.gte` | number | No | Filter for free float percentage greater than or equal to the specified value. | | `free_float_percent.lte` | number | No | Filter for free float percentage less than or equal to the specified value. | #### 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 Stocks Full Market Snapshot **Slug:** `POLYGON_IO_GET_STOCKS_FULL_MARKET_SNAPSHOT` Tool to retrieve a comprehensive snapshot of the entire U.S. stock market covering 10,000+ actively traded tickers. Use when you need current market-wide data including pricing, volume, and trade activity. Data is cleared daily at 3:30 AM EST and repopulates as exchanges report new data starting around 4:00 AM EST. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tickers` | string | No | A case-sensitive comma separated list of tickers to get snapshots for (e.g., AAPL,TSLA,GOOG). If not specified, returns all tickers. | | `include_otc` | boolean | No | Include OTC securities in the response. Defaults to 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 Stocks Income Statements **Slug:** `POLYGON_IO_GET_STOCKS_INCOME_STATEMENTS` Tool to retrieve comprehensive income statement data including revenue, expenses, and net income from company SEC filings. Use when analyzing profitability, revenue trends, or operational performance. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cik` | string | No | The company's Central Index Key (CIK), a unique identifier assigned by the SEC | | `sic` | string | No | Query by Standard Industrial Classification (SIC) code | | `sort` | string | No | The sort field used for ordering. Default: 'filing_date' | | `limit` | integer | No | Limit the number of results returned (1-100). Default: 10 | | `order` | string ("asc" | "desc") | No | Order results based on the sort field. Default: 'asc' | | `ticker` | string | No | Query by company ticker symbol, e.g., 'AAPL' | | `timeframe` | string ("quarterly" | "annual" | "ttm") | No | The timeframe of the report. Annual financials originate from 10-K filings, quarterly from 10-Q filings, TTM is trailing twelve months | | `filing_date` | string | No | Query by the date when the filing was filed (YYYY-MM-DD format) | | `company_name` | string | No | Query by exact company name | | `filing_date_gt` | string | No | Filing date greater than (YYYY-MM-DD) | | `filing_date_lt` | string | No | Filing date less than (YYYY-MM-DD) | | `filing_date_gte` | string | No | Filing date greater than or equal (YYYY-MM-DD) | | `filing_date_lte` | string | No | Filing date less than or equal (YYYY-MM-DD) | | `include_sources` | boolean | No | Whether to include the xpath and formula attributes for each financial data point for traceability | | `company_name_search` | string | No | Search by partial company name | | `period_of_report_date` | string | No | The period of report for the filing (YYYY-MM-DD format) | | `period_of_report_date_gt` | string | No | Period of report date greater than (YYYY-MM-DD) | | `period_of_report_date_lt` | string | No | Period of report date less than (YYYY-MM-DD) | | `period_of_report_date_gte` | string | No | Period of report date greater than or equal (YYYY-MM-DD) | | `period_of_report_date_lte` | string | No | Period of report date less than or equal (YYYY-MM-DD) | #### 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 Stocks Previous Day Bar **Slug:** `POLYGON_IO_GET_STOCKS_PREVIOUS_DAY_BAR` Tool to retrieve the previous trading day's open, high, low, close (OHLC), and volume data for a stock ticker. Use when you need the most recent completed trading day's aggregate data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `adjusted` | boolean | No | Whether or not the results are adjusted for splits. By default, results are adjusted (true). Set this to false to get results that are NOT adjusted for splits. | | `stocks_ticker` | string | Yes | The ticker symbol of the stock (e.g., 'AAPL', 'TSLA', 'MSFT'). Must be case-sensitive and valid. | #### 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 Stocks Risk Factor Taxonomies **Slug:** `POLYGON_IO_GET_STOCKS_RISK_FACTOR_TAXONOMIES` Tool to retrieve the complete list of risk factor classifications used in the risk factors endpoint. Use when you need to understand available risk categories or filter by specific risk classifications. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'taxonomy' if not specified. The sort order defaults to 'desc' if not specified. | | `limit` | integer | No | Limit the maximum number of results returned. Defaults to 200 if not specified. The maximum allowed limit is 999. | | `taxonomy` | number | No | Version identifier (e.g., 1.0, 1.1) for the taxonomy. Value must be a floating point number. | | `taxonomy_gt` | number | No | Filter greater than the value. Value must be a floating point number. | | `taxonomy_lt` | number | No | Filter less than the value. Value must be a floating point number. | | `taxonomy_gte` | number | No | Filter greater than or equal to the value. Value must be a floating point number. | | `taxonomy_lte` | number | No | Filter less than or equal to the value. Value must be a floating point number. | | `primary_category` | string | No | Top-level risk category. | | `tertiary_category` | string | No | Most specific risk classification. | | `secondary_category` | string | No | Mid-level risk category. | | `primary_category_gt` | string | No | Filter greater than the value. | | `primary_category_lt` | string | No | Filter less than the value. | | `primary_category_gte` | string | No | Filter greater than or equal to the value. | | `primary_category_lte` | string | No | Filter less than or equal to the value. | | `tertiary_category_gt` | string | No | Filter greater than the value. | | `tertiary_category_lt` | string | No | Filter less than the value. | | `secondary_category_gt` | string | No | Filter greater than the value. | | `secondary_category_lt` | string | No | Filter less than the value. | | `tertiary_category_gte` | string | No | Filter greater than or equal to the value. | | `tertiary_category_lte` | string | No | Filter less than or equal to the value. | | `secondary_category_gte` | string | No | Filter greater than or equal to the value. | | `secondary_category_lte` | string | No | Filter less than or equal to the value. | | `primary_category_any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `tertiary_category_any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `secondary_category_any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | #### 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 Stocks V1 Dividends **Slug:** `POLYGON_IO_GET_STOCKS_V1_DIVIDENDS` Tool to retrieve historical dividend payment records for US stocks with split-adjusted amounts and historical adjustment factors. Use when analyzing dividend history with price normalization data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified. | | `limit` | integer | No | Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'. | | `ticker` | string | No | Stock symbol for the company issuing the dividend, e.g., 'AAPL'. | | `frequency` | integer | No | How many times per year this dividend is expected to occur. A value of 0 means the distribution is non-recurring or irregular (e.g., special, supplemental, or a one-off dividend). Other possible values include 1 (annual), 2 (semi-annual), 3 (trimester), 4 (quarterly), 12 (monthly), 24 (bi-monthly), 52 (weekly), 104 (bi-weekly), and 365 (daily) depending on the issuer's declared or inferred payout cadence. | | `ticker.gt` | string | No | Filter greater than the value. | | `ticker.lt` | string | No | Filter less than the value. | | `ticker.gte` | string | No | Filter greater than or equal to the value. | | `ticker.lte` | string | No | Filter less than or equal to the value. | | `frequency.gt` | integer | No | Filter greater than the value. | | `frequency.lt` | integer | No | Filter less than the value. | | `frequency.gte` | integer | No | Filter greater than or equal to the value. | | `frequency.lte` | integer | No | Filter less than or equal to the value. | | `ticker.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `ex_dividend_date` | string | No | Date when the stock begins trading without the dividend value. Value must be formatted 'yyyy-mm-dd'. | | `distribution_type` | string ("recurring" | "special" | "supplemental" | "irregular" | "unknown") | No | Classification describing the nature of dividend's recurrence pattern. | | `ex_dividend_date.gt` | string | No | Filter greater than the value. Value must be formatted 'yyyy-mm-dd'. | | `ex_dividend_date.lt` | string | No | Filter less than the value. Value must be formatted 'yyyy-mm-dd'. | | `ex_dividend_date.gte` | string | No | Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'. | | `ex_dividend_date.lte` | string | No | Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'. | | `distribution_type.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list (e.g., 'recurring,special'). | #### 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 Short Interest Data **Slug:** `POLYGON_IO_GET_STOCKS_V1_SHORT_INTEREST` Tool to retrieve comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. Use when analyzing short positions, days to cover, and average daily volume for stocks. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified. | | `limit` | integer | No | Limit the maximum number of results returned. Defaults to 10 if not specified. The maximum allowed limit is 50000. | | `ticker` | string | No | The primary ticker symbol for the stock. | | `ticker_gt` | string | No | Filter greater than the value. | | `ticker_lt` | string | No | Filter less than the value. | | `ticker_gte` | string | No | Filter greater than or equal to the value. | | `ticker_lte` | string | No | Filter less than or equal to the value. | | `days_to_cover` | number | No | Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. | | `ticker_any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `settlement_date` | string | No | The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules. | | `avg_daily_volume` | integer | No | The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. | | `days_to_cover_gt` | number | No | Filter greater than the value. | | `days_to_cover_lt` | number | No | Filter less than the value. | | `days_to_cover_gte` | number | No | Filter greater than or equal to the value. | | `days_to_cover_lte` | number | No | Filter less than or equal to the value. | | `settlement_date_gt` | string | No | Filter greater than the value. | | `settlement_date_lt` | string | No | Filter less than the value. | | `avg_daily_volume_gt` | integer | No | Filter greater than the value. | | `avg_daily_volume_lt` | integer | No | Filter less than the value. | | `settlement_date_gte` | string | No | Filter greater than or equal to the value. | | `settlement_date_lte` | string | No | Filter less than or equal to the value. | | `avg_daily_volume_gte` | integer | No | Filter greater than or equal to the value. | | `avg_daily_volume_lte` | integer | No | Filter less than or equal to the value. | | `days_to_cover_any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `settlement_date_any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `avg_daily_volume_any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | #### 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 Short Volume Data **Slug:** `POLYGON_IO_GET_STOCKS_V1_SHORT_VOLUME` Tool to retrieve short selling volume data for stock tickers. Use when analyzing short sale activity including total trading volume, short sale details, and breakdown by different trading platforms. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | The date of trade activity reported in the format YYYY-MM-DD | | `sort` | string | No | A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. Defaults to 'ticker.asc' if not specified. | | `limit` | integer | No | Limit the maximum number of results returned. Defaults to 10 if not specified. The maximum allowed limit is 50000. | | `ticker` | string | No | The primary ticker symbol for the stock. | | `date.gt` | string | No | Filter greater than the value. | | `date.lt` | string | No | Filter less than the value. | | `date.gte` | string | No | Filter greater than or equal to the value. | | `date.lte` | string | No | Filter less than or equal to the value. | | `ticker.gt` | string | No | Filter greater than the value. | | `ticker.lt` | string | No | Filter less than the value. | | `ticker.gte` | string | No | Filter greater than or equal to the value. | | `ticker.lte` | string | No | Filter less than or equal to the value. | | `date.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `total_volume` | integer | No | Total reported volume across all venues for the ticker on the given date. | | `ticker.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `total_volume.gt` | integer | No | Filter greater than the value. | | `total_volume.lt` | integer | No | Filter less than the value. | | `total_volume.gte` | integer | No | Filter greater than or equal to the value. | | `total_volume.lte` | integer | No | Filter less than or equal to the value. | | `short_volume_ratio` | number | No | The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. | | `total_volume.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `short_volume_ratio.gt` | number | No | Filter greater than the value. | | `short_volume_ratio.lt` | number | No | Filter less than the value. | | `short_volume_ratio.gte` | number | No | Filter greater than or equal to the value. | | `short_volume_ratio.lte` | number | No | Filter less than or equal to the value. | | `short_volume_ratio.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | #### 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 Stocks V1 Splits **Slug:** `POLYGON_IO_GET_STOCKS_V1_SPLITS` Tool to retrieve historical stock split and reverse split events for US equities with historical adjustment factors for price normalization. Use when analyzing stock split history including forward splits, reverse splits, and stock dividends. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'execution_date' if not specified. The sort order defaults to 'desc' if not specified. | | `limit` | integer | No | Limit the maximum number of results returned. Defaults to 100 if not specified. The maximum allowed limit is 5000. | | `ticker` | string | No | Stock symbol for the company that executed the split. Case-sensitive ticker symbol (e.g., 'AAPL'). | | `ticker.gt` | string | No | Filter greater than the value. | | `ticker.lt` | string | No | Filter less than the value. | | `ticker.gte` | string | No | Filter greater than or equal to the value. | | `ticker.lte` | string | No | Filter less than or equal to the value. | | `ticker.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. | | `execution_date` | string | No | Date when the stock split was applied and shares adjusted. Value must be formatted 'yyyy-mm-dd'. | | `adjustment_type` | string ("forward_split" | "reverse_split" | "stock_dividend") | No | Classification of the share-change event. | | `execution_date.gt` | string | No | Filter greater than the value. Value must be formatted 'yyyy-mm-dd'. | | `execution_date.lt` | string | No | Filter less than the value. Value must be formatted 'yyyy-mm-dd'. | | `execution_date.gte` | string | No | Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'. | | `execution_date.lte` | string | No | Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'. | | `adjustment_type.any_of` | string | No | Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Valid values: forward_split, reverse_split, stock_dividend. | #### 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 Ticker Events **Slug:** `POLYGON_IO_GET_TICKER_EVENTS` Tool to retrieve timeline of ticker change events such as symbol renaming or rebranding. Use when tracking ticker history to maintain continuity in records and analyses. This is an experimental endpoint. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g., 'AAPL' for Apple Inc, 'META' for Meta). When provided a ticker, events for the entity currently represented by that ticker are returned. | | `types` | string | No | A comma-separated list of the types of event to include. Currently 'ticker_change' is the only supported event type. Leave blank to return all supported event types. | #### 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 Ticker Overview **Slug:** `POLYGON_IO_GET_TICKER_OVERVIEW` Tool to retrieve comprehensive details for a single ticker, including identifiers, industry, and branding assets. Use after confirming the exact ticker symbol. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ticker` | string | Yes | Ticker symbol to look up, e.g., 'AAPL'. Must be uppercase alphanumeric. | #### 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 Ticker Types **Slug:** `POLYGON_IO_GET_TICKER_TYPES` Tool to retrieve a list of all ticker types supported by Polygon.io. Use when you need to enumerate valid ticker types for filtering or validation. #### 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 Treasury Yields **Slug:** `POLYGON_IO_GET_TREASURY_YIELDS` Tool to retrieve daily market yields for US Treasury securities across standard maturities (1-month to 30-year). Use when analyzing interest rate trends, yield curve analysis, or economic indicators. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Specific observation date in YYYY-MM-DD format. If not provided, returns recent observations. | | `sort` | string | No | Sort by columns with .asc/.desc direction. Example: 'date.asc' or 'date.desc'. | | `limit` | integer | No | Maximum number of results to return. Defaults to 100, maximum is 50,000. | | `date_gt` | string | No | Filter dates greater than value (YYYY-MM-DD). | | `date_lt` | string | No | Filter dates less than value (YYYY-MM-DD). | | `date_gte` | string | No | Filter dates greater than or equal to value (YYYY-MM-DD). | | `date_lte` | string | No | Filter dates less than or equal to value (YYYY-MM-DD). | | `date_any_of` | string | No | Match any values in comma-separated list of dates (YYYY-MM-DD). | #### 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 Exchanges **Slug:** `POLYGON_IO_LIST_EXCHANGES` Tool to retrieve all exchanges supported by Polygon.io with details about asset class and locale. Use when you need to list available exchanges for filtering market data or understanding trading venues. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `locale` | string ("us" | "global") | No | Enum for locale filter options. | | `asset_class` | string ("stocks" | "options" | "crypto" | "fx" | "futures") | No | Enum for asset class filter options. | #### 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 Filing Files **Slug:** `POLYGON_IO_LIST_FILING_FILES` Tool to retrieve files associated with an SEC filing by filing ID. Use when you need to list all documents, exhibits, and data files included in a specific SEC filing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("sequence" | "filename") | No | Sort field used for ordering: 'sequence' or 'filename'. Defaults to 'sequence'. | | `limit` | integer | No | Limit the number of results returned (1-1000). Defaults to 10. | | `order` | string ("asc" | "desc") | No | Order results based on the sort field: 'asc' (ascending) or 'desc' (descending). | | `filename` | string | No | Query by exact file name. | | `sequence` | integer | No | Query by exact file sequence number. | | `filing_id` | string | Yes | The filing ID to retrieve files for (e.g., '0001300514-21-000058'). This is required. | | `filename.gt` | string | No | Filter for filenames strictly greater than this value (lexicographical). | | `filename.lt` | string | No | Filter for filenames strictly less than this value (lexicographical). | | `sequence.gt` | integer | No | Filter for sequence numbers strictly greater than this value. | | `sequence.lt` | integer | No | Filter for sequence numbers strictly less than this value. | | `filename.gte` | string | No | Filter for filenames greater than or equal to this value (lexicographical). | | `filename.lte` | string | No | Filter for filenames less than or equal to this value (lexicographical). | | `sequence.gte` | integer | No | Filter for sequence numbers greater than or equal to this value. | | `sequence.lte` | integer | No | Filter for sequence numbers less than or equal to this value. | #### 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 SEC Filings **Slug:** `POLYGON_IO_LIST_FILINGS` Tool to retrieve SEC filings from the Polygon.io reference data API. Use when you need to search for 10-K, 10-Q, and other SEC filings by date, company, or filing type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("filing_date" | "period_of_report_date") | No | Enum for sort field. | | `type` | string ("10-K" | "10-Q") | No | Enum for SEC filing types. | | `limit` | integer | No | Limit the number of results returned, default is 10 and max is 1000 | | `order` | string ("asc" | "desc") | No | Enum for sort order. | | `has_xbrl` | boolean | No | Filter by XBRL availability: true for filings with XBRL instance file, false for filings without XBRL, omit to include both | | `filing_date` | string | No | Query by exact filing date in YYYYMMDD format | | `filing_date.gt` | string | No | Filter for filing dates greater than this date in YYYYMMDD format | | `filing_date.lt` | string | No | Filter for filing dates less than this date in YYYYMMDD format | | `filing_date.gte` | string | No | Filter for filing dates greater than or equal to this date in YYYYMMDD format | | `filing_date.lte` | string | No | Filter for filing dates less than or equal to this date in YYYYMMDD format | | `period_of_report_date` | string | No | Query by period of report date in YYYYMMDD format | | `period_of_report_date.gt` | string | No | Filter for period of report dates greater than this date in YYYYMMDD format | | `period_of_report_date.lt` | string | No | Filter for period of report dates less than this date in YYYYMMDD format | | `entities.company_data.cik` | string | No | Filter by entity company CIK (Central Index Key) | | `entities.company_data.sic` | string | No | Filter by entity company SIC (Standard Industrial Classification) code | | `period_of_report_date.gte` | string | No | Filter for period of report dates greater than or equal to this date in YYYYMMDD format | | `period_of_report_date.lte` | string | No | Filter for period of report dates less than or equal to this date in YYYYMMDD format | | `entities.company_data.name` | string | No | Filter by entity company name | | `entities.company_data.ticker` | string | No | Filter by entity company ticker symbol | | `entities.company_data.name.search` | string | No | Search for company names containing this text (case-insensitive partial match) | #### 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 Options Contracts **Slug:** `POLYGON_IO_LIST_OPTIONS_CONTRACTS` Tool to list and filter options contracts by underlying ticker, type, expiration, strike, and more. Use when you need to enumerate an options chain or find specific contracts matching criteria. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort by (e.g., 'expiration_date', 'strike_price', 'ticker'). | | `as_of` | string | No | Specify a point in time for contracts as of this date (YYYY-MM-DD). Defaults to today. | | `limit` | integer | No | Maximum number of results to return per page (1-1000). Defaults to 10. | | `order` | string ("asc" | "desc") | No | Sort order direction: 'asc' (ascending) or 'desc' (descending). | | `expired` | boolean | No | Query expired contracts. Set to true to include expired contracts. | | `strike_price` | number | No | Filter by exact strike price value. | | `contract_type` | string ("call" | "put") | No | Filter by contract type: 'call' or 'put'. | | `expiration_date` | string | No | Filter by exact expiration date in YYYY-MM-DD format. | | `strike_price_gt` | number | No | Filter for strike prices strictly greater than this value. | | `strike_price_lt` | number | No | Filter for strike prices strictly less than this value. | | `strike_price_gte` | number | No | Filter for strike prices greater than or equal to this value. | | `strike_price_lte` | number | No | Filter for strike prices less than or equal to this value. | | `underlying_ticker` | string | No | Query for contracts relating to an underlying stock ticker (e.g., 'AAPL', 'SPY'). | | `expiration_date_gt` | string | No | Filter for expiration dates strictly greater than this date (YYYY-MM-DD). | | `expiration_date_lt` | string | No | Filter for expiration dates strictly less than this date (YYYY-MM-DD). | | `expiration_date_gte` | string | No | Filter for expiration dates greater than or equal to this date (YYYY-MM-DD). | | `expiration_date_lte` | string | No | Filter for expiration dates less than or equal to this date (YYYY-MM-DD). | #### 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 | ### Last Quote for a Symbol **Slug:** `POLYGON_IO_POLYGON_LAST_QUOTE_FOR_A_SYMBOL` Tool to retrieve the last quote tick for a given stock symbol. Use when you need the most recent bid/ask prices, sizes, and exchange information for a stock. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `symbol` | string | Yes | Symbol of the stock to get the last quote for (e.g., AAPL, MSFT). Must be uppercase. | #### 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 | ### Last Trade for a Currency Pair **Slug:** `POLYGON_IO_POLYGON_LAST_TRADE_FOR_A_CURRENCY_PAIR` Tool to retrieve the last trade tick for a currency pair in the forex market. Use when you need the most recent trade price, exchange, and timestamp for a specific currency pair. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to_currency` | string | Yes | The 'to' currency symbol (quote currency) in the pair (e.g., 'USD', 'JPY', 'EUR'). | | `from_currency` | string | Yes | The 'from' currency symbol (base currency) in the pair (e.g., 'EUR', 'USD', 'GBP'). | #### 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 |