View as Markdown
Polygon icon

Polygon ACTION

Get Historical Prices

Fetches historical price data for a specified stock ticker within a date range. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Polygon account once, then configure and run Get Historical Prices from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "polygon-get-historical-prices",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    polygon: { authProvisionId: "apn_xxxxxxx" },
    stockTicker: "Stock Ticker",
    multiplier: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Historical Prices inputs
Property Type Description
stockTicker Stock Ticker string
Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.
Required Dynamic
multiplier Multiplier integer
The size of the timespan multiplier.
Required
timespan Timespan string
The size of the time window.
Required
from From Date string
The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
Required
to To Date string
The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
Required
adjusted Adjusted boolean
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.
Optional
sort Sort string
Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).
Optional
limit Limit integer
Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on Aggregate Data API Improvements.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
polygon-get-historical-prices
Version
0.0.3
App
Polygon
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes