Skip to main content

Polygon.io

Type: polygon • Category: flow • Tags: polygon, financial-data, stocks, options, indices, forex, crypto, futures, api

Description​

Connect to Polygon.io for comprehensive financial market data

Parameters​

NameTypeDescriptionRequiredDefault
api_keystringYour Polygon.io API keyno
market_typestringType of market data to accessno"stocks"
operationstringPolygon.io API operation to performno
tickerstringStock ticker symbol (e.g., AAPL)no
underlying_tickerstringUnderlying asset ticker for optionsno
contract_tickerstringOptions contract ticker (O:AAPL240315C00150000)no
currency_pairstringCurrency pair (e.g., EUR/USD)no
crypto_pairstringCrypto pair (e.g., BTC/USD)no
futures_contractstringFutures contract symbolno
tickersarrayList of ticker symbols for indicesno
multipliernumberAggregate multiplier (1, 5, 15, 30)no1
timespanstringAggregate timespanno"day"
from_datestringStart date (YYYY-MM-DD)no
to_datestringEnd date (YYYY-MM-DD)no
datestringSpecific date (YYYY-MM-DD)no
timestampstringSpecific timestamp for trades/quotesno
expiration_datestringOptions expiration date (YYYY-MM-DD)no
strike_pricenumberOptions strike priceno
marketstringMarket type for ticker listingno"stocks"
typestringSecurity type (CS=Common Stock, ETF=ETF, etc.)no"CS"
limitnumberNumber of results to return (max varies by endpoint)no100

Help​

Polygon.io Financial Data Connector

Connect to Polygon.io for comprehensive financial market data across stocks, options, indices, currencies, crypto, and futures.

Security Note: Your API credentials are used only for this workflow execution and are not stored.

Available Market Types:

  • stocks: US equities and ETFs
  • options: Options contracts
  • indices: Stock market indices
  • currencies: Forex pairs
  • crypto: Cryptocurrency pairs
  • futures: Futures contracts

Stocks Operations:

  • get_aggs: Get price aggregates (candles/bars)
  • get_last_trade: Get most recent trade
  • get_last_quote: Get most recent quote
  • list_trades: Get historical trades
  • list_quotes: Get historical quotes
  • get_snapshot: Get current market snapshot
  • get_daily_open_close: Get daily open/close prices
  • get_previous_close: Get previous trading day's close
  • get_ticker_details: Get detailed ticker information
  • list_tickers: List available tickers
  • get_ticker_news: Get news for a ticker
  • get_dividends: Get dividend history
  • get_splits: Get stock split history
  • get_financials: Get financial statements

Options Operations:

  • get_snapshot_options_chain: Get options chain snapshot
  • get_snapshot_option_contract: Get option contract snapshot

Indices Operations:

  • get_snapshot_indices: Get indices snapshot
  • get_previous_close_indices: Get previous close for indices

Currencies Operations:

  • get_last_quote_currency: Get last forex quote
  • list_quotes_currency: Get forex quotes history
  • get_snapshot_currency: Get currency snapshot

Crypto Operations:

  • get_last_trade_crypto: Get last crypto trade
  • list_trades_crypto: Get crypto trades history
  • get_snapshot_crypto: Get crypto snapshot

Futures Operations:

  • get_last_quote_futures: Get last futures quote
  • list_quotes_futures: Get futures quotes history
  • get_snapshot_futures: Get futures snapshot

Examples:

  • Get AAPL daily bars: operation="get_aggs", ticker="AAPL", timespan="day", from_date="2024-01-01", to_date="2024-01-31"
  • Get last trade: operation="get_last_trade", ticker="AAPL"
  • Get options chain: operation="get_snapshot_options_chain", underlying_ticker="AAPL"
  • Get forex quote: operation="get_last_quote_currency", currency_pair="EUR/USD"
  • Get crypto trades: operation="list_trades_crypto", crypto_pair="BTC/USD"

Required Parameters:

  • api_key: Your Polygon.io API key
  • operation: Operation to perform
  • market_type: Type of market data (default: stocks)

Notes:

  • API key required for all operations
  • Rate limits vary by subscription tier
  • Historical data availability depends on your plan
  • Timestamps should be in YYYY-MM-DD format for dates
  • Limit parameter max is 50000 for most endpoints
  • Real-time data requires appropriate subscription tier