> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/polygon.md).

# Polygon

A tool for accessing stock market data through Polygon.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Polygon   | API Key        |

#### Polygon

Connect to Polygon to access stock market data.

**Set up in Polygon**

1. Sign in to your Polygon.io account.
2. Open the Dashboard and go to the API Keys section.
3. Copy your API key value.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Polygon**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                        |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your Polygon.io API key from your account dashboard. [Provider instructions](https://polygon.io/dashboard/api-keys). |

**Provider documentation:** [Setup reference](https://polygon.io/docs).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Polygon** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Stock Ticker Info

Get detailed information about a stock using its ticker symbol from Polygon API

**Inputs**

| Field        | Type   | Required | Description                         |
| ------------ | ------ | -------- | ----------------------------------- |
| Stock Symbol | string | Yes      | The stock ticker symbol to look up. |

**Outputs**

| Field                 | Type   | Description                                     |
| --------------------- | ------ | ----------------------------------------------- |
| Symbol                | string | The stock ticker symbol.                        |
| Short Name            | string | The short name of the stock.                    |
| Long Name             | string | The long name of the stock.                     |
| Address First Line    | string | The first line of the stock's address.          |
| City                  | string | The city of the stock's address.                |
| State                 | string | The state of the stock's address.               |
| Zip                   | string | The zip code of the stock's address.            |
| Phone                 | string | The phone number of the stock.                  |
| Website               | string | The website of the stock.                       |
| Long Business Summary | string | The long business summary of the stock.         |
| Full Time Employees   | number | The number of full time employees of the stock. |
| Market Cap            | number | The market cap of the stock.                    |

#### Financial Snapshot

Get the current price and volume of a stock using its ticker symbol from Polygon API

**Inputs**

| Field        | Type   | Required | Description                         |
| ------------ | ------ | -------- | ----------------------------------- |
| Stock Symbol | string | Yes      | The stock ticker symbol to look up. |

**Outputs**

| Field                         | Type   | Description                                     |
| ----------------------------- | ------ | ----------------------------------------------- |
| Ticker Symbol                 | string | The ticker symbol of the stock.                 |
| Today's Change                | number | The change in price today.                      |
| Today's Change Percentage     | number | The change in price percentage today.           |
| Last Updated Timestamp        | string | The timestamp of the last update.               |
| Fair Market Value             | number | The fair market value of the stock.             |
| Current Open Price            | number | The open price of the stock.                    |
| Current High Price            | number | The high price of the stock.                    |
| Current Low Price             | number | The low price of the stock.                     |
| Current Close Price           | number | The close price of the stock.                   |
| Volume Weighted Average Price | number | The volume weighted average price of the stock. |
| Current Bar Timestamp         | string | The timestamp of the current bar.               |
| Current Bar Trades            | number | The number of trades in the current bar.        |
| Minute Low Price              | number | The low price of the stock.                     |
| Minute Close Price            | number | The close price of the stock.                   |
| Current Volume                | number | The volume of the stock.                        |
| Minute Open Price             | number | The open price of the stock.                    |
| Minute High Price             | number | The minute high price of the stock.             |
| Minute Volume                 | number | The volume of the stock.                        |
| Minute VWAP                   | number | The volume weighted average price of the stock. |
| Minute Bar Timestamp          | string | The timestamp of the current bar.               |
| Minute Bar Trades             | number | The number of trades in the current bar.        |
| Previous Open Price           | number | The open price of the stock.                    |
| Previous High Price           | number | The high price of the stock.                    |
| Previous Close Price          | number | The close price of the stock.                   |
| Previous Low Price            | number | The low price of the stock.                     |
| Previous Volume               | number | The volume of the stock.                        |
| Previous VWAP                 | number | The volume weighted average price of the stock. |
| Previous Bar Timestamp        | string | The timestamp of the previous bar.              |
| Previous Bar Trades           | number | The number of trades in the previous bar.       |
| Last Trade Price              | number | The price of the last trade.                    |
| Last Trade Volume             | number | The volume of the last trade.                   |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/polygon.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
