Some Category

Polygon io

Learn how to use Polygon io with Composio

Overview

SLUG: POLYGON_IO

Description

Template description for Polygon_io

Authentication Details

api_key
stringRequired

Connecting to Polygon io

Create an auth config

Use the dashboard to create an auth config for the Polygon io toolkit. This allows you to connect multiple Polygon io accounts to Composio for agents to use.

1

Select App

Navigate to [Polygon io](https://platform.composio.dev/marketplace/Polygon io).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Polygon io Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4polygon_io_auth_config_id = "ac_YOUR_POLYGON_IO_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Polygon io for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, polygon_io_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Polygon io toolkit’s playground](https://app.composio.dev/app/Polygon io)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["POLYGON_IO"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get All Tickers

Description

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.

Action Parameters

active
boolean
cik
string
cursor
string
cusip
string
date
string
exchange
string
limit
integer
market
string
order
string
search
string
sort
string
ticker
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Dividends

Description

Tool to retrieve a historical record of cash dividend distributions for a given ticker. use when analyzing dividend payments by date, amount, and frequency.

Action Parameters

cash_amount
number
declaration_date
string
dividend_type
string
ex_dividend_date
string
frequency
integer
limit
integer
order
string
pay_date
string
record_date
string
sort
string
ticker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Exponential Moving Average

Description

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.

Action Parameters

adjusted
booleanDefaults to True
expand_underlying
boolean
limit
integerDefaults to 100
order
stringDefaults to desc
series_type
stringDefaults to close
stock_ticker
stringRequired
timespan
stringRequired
window
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get MACD

Description

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.

Action Parameters

adjusted
booleanDefaults to True
expand_underlying
boolean
limit
integerDefaults to 10
long_window
integerRequired
order
stringDefaults to desc
series_type
stringDefaults to close
short_window
integerRequired
signal_window
integerRequired
stock_ticker
stringRequired
timespan
stringRequired
timestamp
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Market Status

Description

Tool to retrieve the current trading status across major exchanges and currency markets. use for real-time monitoring, scheduling, or ui updates.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get RSI

Description

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.

Action Parameters

adjusted
booleanDefaults to True
limit
integerDefaults to 5000
order
stringDefaults to desc
series_type
stringDefaults to close
stock_ticker
stringRequired
timespan
stringRequired
timestamp
integer
timestampLimit
integer
window
integerDefaults to 14

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Simple Moving Average

Description

Tool to retrieve the simple moving average (sma) for a forex ticker. use when you need sma values over a specified timespan with optional underlying data.

Action Parameters

adjusted
booleanDefaults to True
expand_underlying
boolean
fx_ticker
stringRequired
limit
integerDefaults to 250
order
stringDefaults to desc
series_type
stringDefaults to close
timespan
stringRequired
timestamp
integer
window
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Splits

Description

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.

Action Parameters

asset_class
string
cursor
string
ex_date
string
execution_type
string
limit
integer
order
string
sort
string
ticker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Ticker Overview

Description

Tool to retrieve comprehensive details for a single ticker, including identifiers, industry, and branding assets. use after confirming the exact ticker symbol.

Action Parameters

ticker
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Condition Codes

Description

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.

Action Parameters

asset_class
string
data_type
string
id
string
limit
integer
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Daily Ticker Summary

Description

Tool to retrieve daily aggregate summary for a specific stock ticker. uses previous day aggregates from v2 api.

Action Parameters

adjusted
booleanDefaults to True
date
stringRequired
stocks_ticker
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Market Holidays

Description

Tool to retrieve upcoming market holidays and their corresponding open/close times. use when planning around market schedules before trading.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get News

Description

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.

Action Parameters

cursor
string
limit
integer
order
string
published_utc.gte
string
published_utc.lte
string
sort
string
ticker
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Ticker Types

Description

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired