{
"opencollection": "1.0.0",
"info": {
"name": "Polygon API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "apikey",
"key": "apiKey",
"value": "{{apiKey}}",
"placement": "query"
}
},
"items": [
{
"info": {
"name": "benzinga",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_benzinga_v1_analyst-insights",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/benzinga/v1/analyst-insights",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "The calendar date (formatted as YYYY-MM-DD) when the rating was issued."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The stock symbol of the company being rated."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "last_updated",
"value": "",
"type": "query",
"description": "The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "firm",
"value": "",
"type": "query",
"description": "The name of the research firm or investment bank issuing the rating."
},
{
"name": "firm.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "firm.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "firm.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "firm.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "firm.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "rating_action",
"value": "",
"type": "query",
"description": "The description of the change in rating from the firm's last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved."
},
{
"name": "rating_action.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "rating_action.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "rating_action.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "rating_action.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "rating_action.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "benzinga_firm_id",
"value": "",
"type": "query",
"description": "The identifier used by Benzinga for the firm record."
},
{
"name": "benzinga_firm_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "benzinga_firm_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "benzinga_firm_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "benzinga_firm_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "benzinga_firm_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "benzinga_rating_id",
"value": "",
"type": "query",
"description": "The identifier used by Benzinga for the rating record."
},
{
"name": "benzinga_rating_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "benzinga_rating_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "benzinga_rating_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "benzinga_rating_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "benzinga_rating_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'last_updated' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "A comprehensive database of financial analyst insights and ratings for various publicly traded companies, capturing detailed information about analyst recommendations and price targets."
},
{
"info": {
"name": "get_benzinga_v1_analysts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/benzinga/v1/analysts",
"params": [
{
"name": "benzinga_id",
"value": "",
"type": "query",
"description": "The identifier used by Benzinga for this record."
},
{
"name": "benzinga_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "benzinga_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "benzinga_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "benzinga_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "benzinga_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "benzinga_firm_id",
"value": "",
"type": "query",
"description": "The unique identifier assigned by Benzinga to the research firm or investment bank."
},
{
"name": "benzinga_firm_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "benzinga_firm_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "benzinga_firm_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "benzinga_firm_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "benzinga_firm_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "firm_name",
"value": "",
"type": "query",
"description": "The name of the research firm or investment bank issuing the ratings."
},
{
"name": "firm_name.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "firm_name.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "firm_name.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "firm_name.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "firm_name.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "full_name",
"value": "",
"type": "query",
"description": "The full name of the analyst associated with the ratings."
},
{
"name": "full_name.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "full_name.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "full_name.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "full_name.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "full_name.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'full_name' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "A comprehensive database of financial analysts, containing detailed performance metrics and identification information for individual analysts across various financial firms."
},
{
"info": {
"name": "get_benzinga_v1_bulls-bears-say",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/benzinga/v1/bulls-bears-say",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The stock ticker symbol for the company associated with the bull and bear case summaries."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "benzinga_id",
"value": "",
"type": "query",
"description": "The unique identifier used by Benzinga for this bull/bear case record."
},
{
"name": "benzinga_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "benzinga_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "benzinga_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "benzinga_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "benzinga_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "last_updated",
"value": "",
"type": "query",
"description": "The timestamp (formatted as an ISO 8601 timestamp) when the bull/bear case was last updated in the system. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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 'desc' if not specified."
}
]
},
"docs": "A comprehensive database of analyst bull and bear case summaries for publicly traded companies, providing concise summaries of both bullish and bearish investment arguments to help investors see both sides of the story before making investment decisions."
},
{
"info": {
"name": "get_benzinga_v1_consensus-ratings_ticker",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/benzinga/v1/consensus-ratings/:ticker",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "The date range to aggregate analyst ratings over. For example, date.gte=2024-10-01 and date.lt=2025-01-01 for ratings published in Q4 2024. By default, all ratings are aggregated regardless of date."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "ticker",
"value": "",
"type": "path",
"description": "The requested ticker."
}
]
},
"docs": "A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights."
},
{
"info": {
"name": "get_benzinga_v1_earnings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/benzinga/v1/earnings",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The stock symbol of the company reporting earnings."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "importance",
"value": "",
"type": "query",
"description": "A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer."
},
{
"name": "importance.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer."
},
{
"name": "importance.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer."
},
{
"name": "importance.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer."
},
{
"name": "importance.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer."
},
{
"name": "importance.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer."
},
{
"name": "last_updated",
"value": "",
"type": "query",
"description": "The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "date_status",
"value": "",
"type": "query",
"description": "Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed."
},
{
"name": "date_status.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date_status.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date_status.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date_status.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date_status.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "eps_surprise_percent",
"value": "",
"type": "query",
"description": "The percentage difference between the actual and estimated EPS. Value must be a floating point number."
},
{
"name": "eps_surprise_percent.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number."
},
{
"name": "eps_surprise_percent.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "eps_surprise_percent.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "eps_surprise_percent.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "eps_surprise_percent.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "revenue_surprise_percent",
"value": "",
"type": "query",
"description": "The percentage difference between the actual and estimated revenue. Value must be a floating point number."
},
{
"name": "revenue_surprise_percent.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number."
},
{
"name": "revenue_surprise_percent.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "revenue_surprise_percent.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "revenue_surprise_percent.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "revenue_surprise_percent.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_year",
"value": "",
"type": "query",
"description": "The fiscal year in which the earnings period falls. Value must be an integer."
},
{
"name": "fiscal_year.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer."
},
{
"name": "fiscal_year.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer."
},
{
"name": "fiscal_year.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer."
},
{
"name": "fiscal_year.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer."
},
{
"name": "fiscal_year.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer."
},
{
"name": "fiscal_period",
"value": "",
"type": "query",
"description": "The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY."
},
{
"name": "fiscal_period.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "fiscal_period.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "fiscal_period.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "fiscal_period.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "fiscal_period.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'last_updated' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "This table contains earnings data from Benzinga, tracking both actual and estimated financial metrics for publicly traded companies. It includes EPS and revenue figures with surprise calculations, along with metadata like fiscal periods, company identifiers, and reporting timestamps."
},
{
"info": {
"name": "get_benzinga_v1_firms",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/benzinga/v1/firms",
"params": [
{
"name": "benzinga_id",
"value": "",
"type": "query",
"description": "The identifier used by Benzinga for this record."
},
{
"name": "benzinga_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "benzinga_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "benzinga_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "benzinga_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "benzinga_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'name' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "A comprehensive database of financial firms, tracking unique identifiers, names, and basic metadata for various financial institutions and research firms."
},
{
"info": {
"name": "get_benzinga_v1_guidance",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/benzinga/v1/guidance",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "The calendar date (formatted as YYYY-MM-DD) when the guidance was issued."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The stock symbol of the company issuing guidance."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "positioning",
"value": "",
"type": "query",
"description": "Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are 'primary' (the emphasized figure) and 'secondary' (a supporting or alternate figure)"
},
{
"name": "positioning.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "positioning.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "positioning.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "positioning.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "positioning.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "importance",
"value": "",
"type": "query",
"description": "A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer."
},
{
"name": "importance.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer."
},
{
"name": "importance.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer."
},
{
"name": "importance.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer."
},
{
"name": "importance.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer."
},
{
"name": "importance.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer."
},
{
"name": "last_updated",
"value": "",
"type": "query",
"description": "The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "fiscal_year",
"value": "",
"type": "query",
"description": "The fiscal year corresponding to the period for which the guidance is issued. Value must be an integer."
},
{
"name": "fiscal_year.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer."
},
{
"name": "fiscal_year.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer."
},
{
"name": "fiscal_year.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer."
},
{
"name": "fiscal_year.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer."
},
{
"name": "fiscal_year.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer."
},
{
"name": "fiscal_period",
"value": "",
"type": "query",
"description": "The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4."
},
{
"name": "fiscal_period.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "fiscal_period.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "fiscal_period.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "fiscal_period.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "fiscal_period.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "A comprehensive database of financial guidance and earnings estimates for various companies, capturing key metrics related to earnings per share (EPS) and revenue projections across different fiscal periods."
},
{
"info": {
"name": "get_benzinga_v1_ratings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/benzinga/v1/ratings",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "The calendar date (formatted as YYYY-MM-DD) when the rating was issued."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The stock symbol of the company being rated."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "importance",
"value": "",
"type": "query",
"description": "A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer."
},
{
"name": "importance.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer."
},
{
"name": "importance.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer."
},
{
"name": "importance.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer."
},
{
"name": "importance.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer."
},
{
"name": "last_updated",
"value": "",
"type": "query",
"description": "The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "last_updated.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "rating_action",
"value": "",
"type": "query",
"description": "The description of the change in rating from the firm's last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved."
},
{
"name": "rating_action.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "rating_action.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "rating_action.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "rating_action.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "rating_action.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "price_target_action",
"value": "",
"type": "query",
"description": "The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets."
},
{
"name": "price_target_action.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "price_target_action.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "price_target_action.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "price_target_action.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "price_target_action.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "benzinga_id",
"value": "",
"type": "query",
"description": "The identifier used by Benzinga for this record."
},
{
"name": "benzinga_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "benzinga_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "benzinga_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "benzinga_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "benzinga_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "benzinga_analyst_id",
"value": "",
"type": "query",
"description": "The identifier used by Benzinga for this analyst."
},
{
"name": "benzinga_analyst_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "benzinga_analyst_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "benzinga_analyst_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "benzinga_analyst_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "benzinga_analyst_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "benzinga_firm_id",
"value": "",
"type": "query",
"description": "The identifier used by Benzinga for this firm."
},
{
"name": "benzinga_firm_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "benzinga_firm_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "benzinga_firm_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "benzinga_firm_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "benzinga_firm_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'last_updated' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "This table contains analyst ratings and price target data from investment firms, tracking rating changes (upgrades, downgrades, initiates coverage, etc.) and price target adjustments for publicly traded companies. Each record includes the analyst details, company information, current and previous ratings/targets, and metadata like timestamps and Benzinga identifiers."
},
{
"info": {
"name": "get_benzinga_v2_news",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/benzinga/v2/news",
"params": [
{
"name": "published",
"value": "",
"type": "query",
"description": "The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "published.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "published.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "published.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "published.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in seconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "channels",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "channels.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "channels.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tags",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "tags.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tags.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "author",
"value": "",
"type": "query",
"description": "The name of the journalist or entity that authored the news article."
},
{
"name": "author.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "author.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "author.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "author.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "author.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "stocks",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "stocks.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "stocks.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "tickers.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'published' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information."
}
]
},
{
"info": {
"name": "fable",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_consumer-spending_eu_v1_merchant-aggregates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/consumer-spending/eu/v1/merchant-aggregates",
"params": [
{
"name": "transaction_date",
"value": "",
"type": "query",
"description": "The calendar date when the consumer transactions occurred. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "transaction_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "transaction_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "transaction_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "transaction_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "The merchant or entity name for this aggregate (lowercase). When type is 'merchant', this value can be used as the lookup_name in the merchant-hierarchy endpoint to retrieve full corporate hierarchy details."
},
{
"name": "name.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "name.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "name.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "name.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "name.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "user_country",
"value": "",
"type": "query",
"description": "Country of consumer's residence (ISO codes). Available countries: UK, DE, FR, ES, IT, AT. Values outside these are mapped to 'unknown'."
},
{
"name": "user_country.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "channel",
"value": "",
"type": "query",
"description": "Transaction channel. Possible values: online, offline, bnpl (buy now pay later platforms such as Scala, Klarna, Zilch)."
},
{
"name": "channel.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "consumer_type",
"value": "",
"type": "query",
"description": "The panel the account is sourced from. Possible values: consumer_credit, consumer_debit, open_banking."
},
{
"name": "consumer_type.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "parent_name",
"value": "",
"type": "query",
"description": "Merchant's parent business name (Title Case). Useful for aggregating transactions across subsidiary brands. Also available in the merchant-hierarchy endpoint for full corporate structure."
},
{
"name": "parent_name.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "parent_name.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "parent_name.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "parent_name.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "parent_name.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'transaction_date' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "Aggregated consumer transactions from European credit card panels, structured for flexible analysis and faster access to insights. Each row represents daily credit card, debit card, or open banking transactions (7-day lag from transaction date) at a tagged merchant or payment processor, split across Currency, Country, Online/Offline, and Credit/Debit dimensions. Includes ticker (Bloomberg standard) and industry mapping for ~250 US public companies across 6 European countries (UK, DE, FR, IT, ES,"
},
{
"info": {
"name": "get_consumer-spending_eu_v1_merchant-hierarchy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/consumer-spending/eu/v1/merchant-hierarchy",
"params": [
{
"name": "lookup_name",
"value": "",
"type": "query",
"description": "Lowercase merchant tag used for joining with the merchant-aggregates endpoint name field (e.g., 'asda', 'amazon')."
},
{
"name": "lookup_name.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "lookup_name.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "lookup_name.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "lookup_name.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "lookup_name.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Stock ticker associated with the merchant (~250 US public companies mapped). Uses Bloomberg standard."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "listing_status",
"value": "",
"type": "query",
"description": "Whether the merchant is a publicly listed company or private. Possible values: public, private."
},
{
"name": "listing_status.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "active_from",
"value": "",
"type": "query",
"description": "Date this merchant hierarchy mapping became applicable. A value of 0001-01-01 indicates no known start date. Use with active_to to match against transaction_date from the merchant-aggregates endpoint to perform point-in-time queries. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "active_from.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "active_from.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "active_from.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "active_from.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "active_to",
"value": "",
"type": "query",
"description": "Date after which this merchant hierarchy mapping is no longer applicable due to a corporate action. A value of 9999-12-31 indicates the mapping is currently active. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "active_to.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "active_to.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "active_to.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "active_to.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'lookup_name' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "Reference data mapping merchants to parent companies, tickers, sectors, and industries across Fable's European consumer transaction panel. Each row represents a single merchant with its corporate hierarchy and classification metadata. Weekly snapshots contain ~3,500 merchants covering ~250 US public companies. Use lookup_name to join with the name field from the merchant-aggregates endpoint, filtering by active_from and active_to to match a specific transaction_date (e.g., active_from.lte=2025-0"
}
]
},
{
"info": {
"name": "global_crypto",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_crypto_v1_exchanges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/crypto/v1/exchanges",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'."
}
]
},
"docs": "Global cryptocurrency exchanges and digital asset trading platforms, including major centralized exchanges (Coinbase, Binance, Bitfinex, etc.) that facilitate trading of cryptocurrencies and digital tokens worldwide."
}
]
},
{
"info": {
"name": "etfglobal",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_etf-global_v1_analytics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/etf-global/v1/analytics",
"params": [
{
"name": "composite_ticker",
"value": "",
"type": "query",
"description": "The stock ticker symbol used to identify this ETF product on exchanges."
},
{
"name": "composite_ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "composite_ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "composite_ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "composite_ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "composite_ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "processed_date",
"value": "",
"type": "query",
"description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date",
"value": "",
"type": "query",
"description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "risk_total_score",
"value": "",
"type": "query",
"description": "ETF Global's proprietary Red Diamond overall risk assessment score for the ETF. Value must be a floating point number."
},
{
"name": "risk_total_score.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "risk_total_score.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "risk_total_score.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "risk_total_score.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "reward_score",
"value": "",
"type": "query",
"description": "ETF Global's proprietary Green Diamond score measuring the potential reward and return prospects of the ETF. Value must be a floating point number."
},
{
"name": "reward_score.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "reward_score.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "reward_score.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "reward_score.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_total_score",
"value": "",
"type": "query",
"description": "ETF Global's comprehensive quantitative analysis score combining all quantitative factors. Value must be a floating point number."
},
{
"name": "quant_total_score.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "quant_total_score.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_total_score.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "quant_total_score.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_grade",
"value": "",
"type": "query",
"description": "Letter grade summarizing the ETF's overall quantitative assessment, where A = 71-100, B = 56-70, etc."
},
{
"name": "quant_grade.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "quant_grade.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "quant_grade.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "quant_grade.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "quant_grade.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "quant_composite_technical",
"value": "",
"type": "query",
"description": "Combined technical analysis score aggregating short, intermediate, and long-term technical factors. Value must be a floating point number."
},
{
"name": "quant_composite_technical.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "quant_composite_technical.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_technical.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "quant_composite_technical.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_sentiment",
"value": "",
"type": "query",
"description": "Overall market sentiment score combining put/call ratios, short interest, and implied volatility. Value must be a floating point number."
},
{
"name": "quant_composite_sentiment.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "quant_composite_sentiment.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_sentiment.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "quant_composite_sentiment.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_behavioral",
"value": "",
"type": "query",
"description": "Behavioral analysis score measuring investor psychology and market behavior patterns. Value must be a floating point number."
},
{
"name": "quant_composite_behavioral.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "quant_composite_behavioral.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_behavioral.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "quant_composite_behavioral.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_fundamental",
"value": "",
"type": "query",
"description": "Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics. Value must be a floating point number."
},
{
"name": "quant_composite_fundamental.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "quant_composite_fundamental.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_fundamental.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "quant_composite_fundamental.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_global",
"value": "",
"type": "query",
"description": "Overall global theme score combining sector and country analysis for macro investment views. Value must be a floating point number."
},
{
"name": "quant_composite_global.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "quant_composite_global.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_global.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "quant_composite_global.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_quality",
"value": "",
"type": "query",
"description": "Overall quality assessment score combining liquidity, diversification, and issuing firm factors. Value must be a floating point number."
},
{
"name": "quant_composite_quality.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "quant_composite_quality.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "quant_composite_quality.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "quant_composite_quality.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "ETF Global analytics data containing risk scores, reward metrics, and quantitative analysis for ETF composite tickers."
},
{
"info": {
"name": "get_etf-global_v1_constituents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/etf-global/v1/constituents",
"params": [
{
"name": "composite_ticker",
"value": "",
"type": "query",
"description": "The stock ticker symbol of the ETF that holds these constituent securities."
},
{
"name": "composite_ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "composite_ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "composite_ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "composite_ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "composite_ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "constituent_ticker",
"value": "",
"type": "query",
"description": "The stock ticker symbol of the individual security held within the ETF."
},
{
"name": "constituent_ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "constituent_ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "constituent_ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "constituent_ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "constituent_ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "effective_date",
"value": "",
"type": "query",
"description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date",
"value": "",
"type": "query",
"description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "us_code",
"value": "",
"type": "query",
"description": "A unique identifier code for the constituent security in US markets."
},
{
"name": "us_code.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "us_code.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "us_code.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "us_code.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "us_code.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "isin",
"value": "",
"type": "query",
"description": "The International Securities Identification Number, a global standard for identifying securities."
},
{
"name": "isin.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "isin.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "isin.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "isin.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "isin.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "figi",
"value": "",
"type": "query",
"description": "The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments."
},
{
"name": "figi.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "figi.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "figi.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "figi.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "figi.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "sedol",
"value": "",
"type": "query",
"description": "The Stock Exchange Daily Official List code, primarily used for securities trading in the UK."
},
{
"name": "sedol.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "sedol.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "sedol.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "sedol.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "sedol.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "ETF Global constituents data containing detailed information about the securities held within ETFs, including weights, market values, and security identifiers."
},
{
"info": {
"name": "get_etf-global_v1_fund-flows",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/etf-global/v1/fund-flows",
"params": [
{
"name": "processed_date",
"value": "",
"type": "query",
"description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date",
"value": "",
"type": "query",
"description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "composite_ticker",
"value": "",
"type": "query",
"description": "The stock ticker symbol used to identify this ETF on exchanges."
},
{
"name": "composite_ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "composite_ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "composite_ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "composite_ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "composite_ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "ETF Global fund flow data containing information about ETF share movements, net asset values, and fund flow metrics."
},
{
"info": {
"name": "get_etf-global_v1_profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/etf-global/v1/profiles",
"params": [
{
"name": "processed_date",
"value": "",
"type": "query",
"description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date",
"value": "",
"type": "query",
"description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "composite_ticker",
"value": "",
"type": "query",
"description": "The stock ticker symbol used to identify this ETF product on exchanges."
},
{
"name": "composite_ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "composite_ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "composite_ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "composite_ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "composite_ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "ETF Global industry profile data containing comprehensive ETF metadata including financial metrics, operational details, and exposure information."
},
{
"info": {
"name": "get_etf-global_v1_taxonomies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/etf-global/v1/taxonomies",
"params": [
{
"name": "processed_date",
"value": "",
"type": "query",
"description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "processed_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date",
"value": "",
"type": "query",
"description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "effective_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "composite_ticker",
"value": "",
"type": "query",
"description": "The stock ticker symbol used to identify this ETF product on exchanges."
},
{
"name": "composite_ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "composite_ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "composite_ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "composite_ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "composite_ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "ETF Global taxonomy data containing detailed classification and categorization information for ETFs including investment strategy, methodology, and structural characteristics."
}
]
},
{
"info": {
"name": "fed",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_fed_v1_inflation",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/fed/v1/inflation",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "Calendar date of the observation (YYYY‑MM‑DD)."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time."
},
{
"info": {
"name": "get_fed_v1_inflation-expectations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/fed/v1/inflation-expectations",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "Calendar date of the observation (YYYY‑MM‑DD)."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons."
},
{
"info": {
"name": "get_fed_v1_labor-market",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/fed/v1/labor-market",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "Calendar date of the observation (YYYY-MM-DD)."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "Labor market indicators from the Federal Reserve, including unemployment rate, labor force participation, average hourly earnings, and job openings data."
},
{
"info": {
"name": "get_fed_v1_treasury-yields",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/fed/v1/treasury-yields",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "Calendar date of the yield observation (YYYY-MM-DD)."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities."
}
]
},
{
"info": {
"name": "global_forex",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_forex_v1_exchanges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/forex/v1/exchanges",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'."
}
]
},
"docs": "Global foreign exchange (FX) trading venues and market infrastructure, including electronic trading platforms, banks, and other institutions facilitating currency pair trading worldwide."
}
]
},
{
"info": {
"name": "futures:aggregates",
"type": "folder"
},
"items": [
{
"info": {
"name": "Aggregates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/futures/v1/aggs/:ticker",
"params": [
{
"name": "ticker",
"value": "GCJ5",
"type": "path",
"description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract)."
},
{
"name": "resolution",
"value": "1min",
"type": "query",
"description": "The size of each aggregate candle, specified as a number followed by a unit: `sec`, `min`, `hour`, `session`, `week`, `month`, `quarter`, or `year`.\n\nEach unit has a maximum multiplier. For instance, minute candles go up to `59min` — after that, use `1hour`. Requesting an unsupported size returns a `400 Bad Request`."
},
{
"name": "window_start",
"value": "",
"type": "query",
"description": "Filter by the start time of each candle. Accepts a `YYYY-MM-DD` date or a nanosecond Unix timestamp. The value is snapped to the start of the matching candle interval.\n\nWhen omitted, the API returns the most recent candles up to `limit`.\n\nUse comparison suffixes to query a range:\n- `window_start.gte` — greater than or equal to\n- `window_start.gt` — greater than\n- `window_start.lte` — less than or equal to\n- `window_start.lt` — less than\n\n**Examples**\n- Most recent minute candles: `/v1/aggs/ESU5?resolution=1min&limit=5`\n- Single daily candle: `/v1/aggs/ESU5?resolution=1session&window_start=2025-08-05`\n- Date range: `/v1/aggs/ESU5?resolution=1session&window_start.gte=2025-07-01&window_start.lte=2025-07-31`\n- After a timestamp: `/v1/aggs/ESU5?resolution=1sec&window_start.gt=1751409877000000000&limit=1000`"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The number of results to return per page (default=1000, maximum=50000, minimum=1)."
},
{
"name": "window_start.gte",
"value": "",
"type": "query",
"description": "Range by window_start."
},
{
"name": "window_start.gt",
"value": "",
"type": "query",
"description": "Range by window_start."
},
{
"name": "window_start.lte",
"value": "",
"type": "query",
"description": "Range by window_start."
},
{
"name": "window_start.lt",
"value": "",
"type": "query",
"description": "Range by window_start."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc')."
}
]
},
"docs": "Get aggregates for a contract in a given time range."
}
]
},
{
"info": {
"name": "us_futures",
"type": "folder"
},
"items": [
{
"info": {
"name": "futures contracts API",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/futures/v1/contracts",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about contracts for the specified day. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "product_code",
"value": "",
"type": "query",
"description": "The identifier for the contract's product."
},
{
"name": "product_code.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "product_code.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "product_code.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "product_code.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "product_code.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The ticker for the contract."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "active",
"value": "",
"type": "query",
"description": "Whether or not a given contract was tradeable at the given point in time. Active is true when (first_trade_date <= date >= last_trade_date) and false otherwise."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "The type of contract, one of 'single' or 'combo'. Leaving this filter blank will query for contracts where type is 'single', 'combo' or empty. This field only exists on contracts as of 2025-03-12 and later. It will be null when date < 2025-03-12."
},
{
"name": "type.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "first_trade_date",
"value": "",
"type": "query",
"description": "The first day on which the contract was tradeable. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "first_trade_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "first_trade_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "first_trade_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "first_trade_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "last_trade_date",
"value": "",
"type": "query",
"description": "The last day on which the contract was tradeable. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "last_trade_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "last_trade_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "last_trade_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "last_trade_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'product_code' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "The Contracts API provides a single source for discovering all listed futures contracts and retrieving complete contract specifications. You can query the full contract index with filters for product code, trade dates, active status, and date, returning key attributes such as ticker, first and last trade dates, days to maturity, exchange code, and order quantity limits in paginated form. The same API also returns the full specification for a single contract, including settlement dates, tick size"
},
{
"info": {
"name": "get_futures_v1_exchanges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/futures/v1/exchanges",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'."
}
]
},
"docs": "US futures exchanges and trading venues including major derivatives exchanges (CME, CBOT, NYMEX, COMEX) and other futures market infrastructure for commodity, financial, and other derivative contract trading."
},
{
"info": {
"name": "Market Status API",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/futures/v1/market-status",
"params": [
{
"name": "product_code",
"value": "",
"type": "query",
"description": "The product code of the futures contracts for which you want statuses."
},
{
"name": "product_code.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "product_code.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "product_code.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "product_code.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "product_code.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '100'."
}
]
},
"docs": "Retrieve the current market status for a specific product or products. This endpoint returns real-time indicators, such as open, pause, close, for futures products, along with the corresponding exchange and product codes and an evaluation timestamp. This information enables users to monitor operational conditions and adjust their trading strategies accordingly.\n\nUse Cases: Real-time monitoring, algorithm scheduling, UI updates, operational planning."
},
{
"info": {
"name": "Futures Products API",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/futures/v1/products",
"params": [
{
"name": "name",
"value": "",
"type": "query",
"description": "The full name of the product."
},
{
"name": "name.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "name.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "name.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "name.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "name.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "product_code",
"value": "",
"type": "query",
"description": "The identifier for the product."
},
{
"name": "product_code.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "product_code.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "product_code.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "product_code.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "product_code.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "date",
"value": "",
"type": "query",
"description": "A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "trading_venue",
"value": "",
"type": "query",
"description": "The trading venue (MIC) for the exchange on which this product's contracts trade."
},
{
"name": "trading_venue.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "trading_venue.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "trading_venue.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "trading_venue.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "trading_venue.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "sector",
"value": "",
"type": "query",
"description": "The sector to which the product belongs."
},
{
"name": "sector.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "sub_sector",
"value": "",
"type": "query",
"description": "The sub-sector to which the product belongs."
},
{
"name": "sub_sector.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "asset_class",
"value": "",
"type": "query",
"description": "The asset class to which the product belongs."
},
{
"name": "asset_class.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "asset_sub_class",
"value": "",
"type": "query",
"description": "The asset sub-class to which the product belongs."
},
{
"name": "asset_sub_class.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "The type of product, one of 'single' or 'combo'. Leaving this filter blank will query for both 'single' and 'combo' types."
},
{
"name": "type.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "The Products API is a unified source for discovering all supported futures products and retrieving full product specifications. It returns the complete product universe with product codes, names, exchange identifiers, sector and asset class classifications, product type, settlement method, and pricing and quotation details. You can filter by name, exchange, sector, asset class, product type, or date to capture the product set or product definition that existed at a specific point in time. It als"
},
{
"info": {
"name": "get_futures_v1_quotes_ticker",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/futures/v1/quotes/:ticker",
"params": [
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The time when the quote was generated at the exchange to nanosecond precision. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "session_end_date",
"value": "",
"type": "query",
"description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'timestamp' if not specified. The sort order defaults to 'desc' if not specified."
},
{
"name": "ticker",
"value": "",
"type": "path",
"description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract)."
}
]
},
"docs": "Retrieve quote data for a specified futures contract ticker. Each record includes the best bid and offer prices, sizes, and timestamps, reflecting the prevailing quote environment at each moment. This endpoint supports detailed analysis of price dynamics and liquidity conditions to inform trading decisions and market research.\n\nUse Cases: Liquidity analysis, price discovery, trading strategy refinement, market research."
},
{
"info": {
"name": "Futures Schedules API",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/futures/v1/schedules",
"params": [
{
"name": "product_code",
"value": "",
"type": "query",
"description": "The product code of the futures contract."
},
{
"name": "product_code.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "product_code.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "product_code.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "product_code.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "product_code.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "session_end_date",
"value": "",
"type": "query",
"description": "The session end date for the schedules (also known as the trading date). This field is optional and can be used to filter results by a specific session end date. If left blank, schedules for all dates will be returned. Note that trading sessions end at 5 PM Central Time, so a session ending at 5 PM CT on January 1st would have a session_end_date of 2025-01-01. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "session_end_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "session_end_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "session_end_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "session_end_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "trading_venue",
"value": "",
"type": "query",
"description": "The trading venue (MIC) for the exchange on which this schedule's product trades."
},
{
"name": "trading_venue.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "trading_venue.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "trading_venue.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "trading_venue.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "trading_venue.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '1000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'product_code' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "The Schedules API provides a unified way to retrieve trading schedules for futures markets, returning precise session open and close times, intraday breaks, and any adjustments for holidays or special events. You can filter schedules by session_end_date or retrieve the schedule for a single product using its product code. All times are returned in Coordinated Universal Time (UTC), making it straightforward to align trading, execution, and operational workflows across systems.\n\nUse Cases: Schedul"
},
{
"info": {
"name": "futures_snapshot_v1 API",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/futures/v1/snapshot",
"params": [
{
"name": "product_code",
"value": "",
"type": "query",
"description": "The code for the contracts' underlying product."
},
{
"name": "product_code.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "product_code.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "product_code.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "product_code.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "product_code.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ24 for the December 2024 S&P 500 E-mini contract)."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "Retrieve a snapshot of the most recent futures contract data."
},
{
"info": {
"name": "get_futures_v1_trades_ticker",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/futures/v1/trades/:ticker",
"params": [
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The time when the trade was generated at the exchange to nanosecond precision. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "session_end_date",
"value": "",
"type": "query",
"description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'timestamp' if not specified. The sort order defaults to 'desc' if not specified."
},
{
"name": "ticker",
"value": "",
"type": "path",
"description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract)."
}
]
},
"docs": "Retrieve comprehensive, tick-level trade data for a specified futures contract ticker over a defined time range. Each record includes the trade price, size, session start date, and precise timestamps, capturing individual trade events throughout the period. This granular data is essential for constructing aggregated bars and performing detailed analyses of intraday price movements, making it a valuable tool for backtesting, algorithmic strategy development, and market research.\n\nUse Cases: Intra"
}
]
},
{
"info": {
"name": "us_options",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_options_v1_exchanges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/options/v1/exchanges",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'."
}
]
},
"docs": "US options exchanges and trading venues including traditional options exchanges (CBOE, ISE, etc.), Securities Information Processors (SIP), and other options market infrastructure for derivatives trading."
},
{
"info": {
"name": "get_options_v3_quotes_ticker",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/options/v3/quotes/:ticker",
"params": [
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '1000' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'timestamp' if not specified. The sort order defaults to 'desc' if not specified."
},
{
"name": "ticker",
"value": "",
"type": "path",
"description": "The options ticker symbol (e.g., O:SPY260123C00687000)."
}
]
},
"docs": "Contains NBBO (National Best Bid and Offer) quote records for US options contracts, capturing bid/ask prices, sizes, and exchange attribution at nanosecond precision."
},
{
"info": {
"name": "get_options_v3_trades_ticker",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/options/v3/trades/:ticker",
"params": [
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '1000' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'timestamp' if not specified. The sort order defaults to 'desc' if not specified."
},
{
"name": "ticker",
"value": "",
"type": "path",
"description": "The options ticker symbol (e.g., O:SPY260123C00687000)."
}
]
},
"docs": "Contains individual trade transactions for US options contracts, capturing trade execution details including pricing, timing, and exchange information."
}
]
},
{
"info": {
"name": "us_stocks_all",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_stocks_dev_trades_ticker",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/dev/trades/:ticker",
"params": [
{
"name": "sip_timestamp",
"value": "",
"type": "query",
"description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "sip_timestamp.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "sip_timestamp.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "sip_timestamp.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "sip_timestamp.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'sip_timestamp' if not specified. The sort order defaults to 'desc' if not specified."
},
{
"name": "ticker",
"value": "",
"type": "path",
"description": "The ticker symbol."
}
]
},
"docs": "Contains individual trade transactions for US stocks, capturing trade execution details including pricing, timing, and exchange information."
},
{
"info": {
"name": "get_stocks_v1_exchanges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/v1/exchanges",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'."
}
]
},
"docs": "US stock exchanges, trading venues, and reporting facilities including exchanges (NYSE, Nasdaq), Trade Reporting Facilities (TRF), Securities Information Processors (SIP), and OTC Reporting Facilities (ORF) for equity trading."
}
]
},
{
"info": {
"name": "reference",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_stocks_filings_10-K_vX_sections",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/filings/10-K/vX/sections",
"params": [
{
"name": "cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key (10 digits, zero-padded)."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "cik.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "cik.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "cik.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "cik.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Stock ticker symbol for the company."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "section",
"value": "",
"type": "query",
"description": "Standardized section identifier from the filing (e.g. 'business', 'risk_factors', etc.)."
},
{
"name": "section.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end",
"value": "",
"type": "query",
"description": "Period end date that the filing relates to (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '100'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "SEC document text sections providing raw text content from specific sections of SEC filings (10-K, 10-Q, etc.)."
},
{
"info": {
"name": "get_stocks_filings_10-K_vX_0_sections",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/filings/10-K/vX_0/sections",
"params": [
{
"name": "cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key (10 digits, zero-padded)."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "cik.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "cik.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "cik.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "cik.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Stock ticker symbol for the company."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "section",
"value": "",
"type": "query",
"description": "Standardized section identifier from the filing (e.g. 'business', 'risk_factors', etc.)."
},
{
"name": "section.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end",
"value": "",
"type": "query",
"description": "Period end date that the filing relates to (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '100'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "SEC document text sections providing raw text content from specific sections of SEC filings (10-K, 10-Q, etc.)."
},
{
"info": {
"name": "get_stocks_filings_8-K_vX_disclosures",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/filings/8-K/vX/disclosures",
"params": [
{
"name": "cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key of the filer (10 digits, zero-padded)."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "tickers.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD)."
},
{
"name": "filing_date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "tertiary_category",
"value": "",
"type": "query",
"description": "Most specific disclosure category (e.g., 'quarterly_results'). Filtering on this column must use an exact match. See the full taxonomy at /stocks/taxonomies/vX/disclosures."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "SEC 8-K filing disclosure categorization. A single 8-K filing can produce multiple rows when it covers multiple disclosure types — each row represents one tagged disclosure within the filing, classified into primary, secondary, and tertiary categories with a supporting text excerpt. The full classification list is available at /stocks/taxonomies/vX/disclosures."
},
{
"info": {
"name": "get_stocks_filings_8-K_vX_text",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/filings/8-K/vX/text",
"params": [
{
"name": "cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key (10 digits, zero-padded)."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "cik.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "cik.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "cik.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "cik.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Stock ticker symbol for the company."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "form_type",
"value": "",
"type": "query",
"description": "SEC form type (e.g., '8-K', '8-K/A' for amendments)."
},
{
"name": "form_type.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "form_type.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "form_type.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "form_type.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "form_type.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '100'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "SEC 8-K filings text providing parsed content from current report filings. 8-K forms report material events such as earnings, acquisitions, executive changes, and other significant corporate events."
},
{
"info": {
"name": "get_stocks_filings_vX_13-F",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/filings/vX/13-F",
"params": [
{
"name": "filer_cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key (10 digits, zero-padded) of the filing entity."
},
{
"name": "filer_cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "SEC Form 13F filings data showing institutional investment manager holdings. Form 13F is required to be filed quarterly by institutional investment managers with at least $100 million in qualifying assets under management."
},
{
"info": {
"name": "get_stocks_filings_vX_form-3",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/filings/vX/form-3",
"params": [
{
"name": "issuer_cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key of the issuer company (10 digits, zero-padded)."
},
{
"name": "issuer_cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "owner_cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key of the reporting owner (10 digits, zero-padded)."
},
{
"name": "owner_cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "tickers.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "form_type",
"value": "",
"type": "query",
"description": "SEC form type ('3' for initial filing, '3/A' for amendments)."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '10000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "SEC Form 3 filings reporting initial statements of beneficial ownership of securities. Filed by corporate insiders (directors, officers, and 10%+ shareholders) when they first acquire a position."
},
{
"info": {
"name": "get_stocks_filings_vX_form-4",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/filings/vX/form-4",
"params": [
{
"name": "issuer_cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key of the issuer company (10 digits, zero-padded)."
},
{
"name": "issuer_cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "owner_cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key of the reporting owner (10 digits, zero-padded)."
},
{
"name": "owner_cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "tickers.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "form_type",
"value": "",
"type": "query",
"description": "SEC form type ('4' for standard filing, '4/A' for amendments)."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "transaction_code",
"value": "",
"type": "query",
"description": "SEC transaction code indicating the type of transaction (e.g., 'P' for purchase, 'S' for sale, 'A' for grant/award, 'M' for exercise/conversion)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '10000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "SEC Form 4 filings reporting changes in beneficial ownership of securities. Filed by corporate insiders (directors, officers, and 10%+ shareholders) within two business days of a transaction."
},
{
"info": {
"name": "get_stocks_filings_vX_index",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/filings/vX/index",
"params": [
{
"name": "cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key (CIK) identifying the filing entity."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "cik.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "cik.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "cik.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "cik.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Stock ticker symbol for the filing entity, if available."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "form_type",
"value": "",
"type": "query",
"description": "SEC form type (e.g., '10-K', '10-Q', '8-K', 'S-1', '4', etc.)."
},
{
"name": "form_type.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "form_type.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "form_type.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "form_type.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "form_type.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '1000' if not specified. The maximum allowed limit is '10000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "SEC EDGAR master index providing metadata for all SEC filings including form types, filing dates, and direct links to source documents."
},
{
"info": {
"name": "get_stocks_filings_vX_risk-factors",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/filings/vX/risk-factors",
"params": [
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD)."
},
{
"name": "filing_date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Stock ticker symbol for the company."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "cik",
"value": "",
"type": "query",
"description": "SEC Central Index Key (10 digits, zero-padded)."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "cik.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "cik.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "cik.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "cik.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "The risk factors identified in companies' 10K filings."
},
{
"info": {
"name": "get_stocks_taxonomies_vX_disclosures",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/taxonomies/vX/disclosures",
"params": [
{
"name": "taxonomy",
"value": "",
"type": "query",
"description": "Taxonomy version that defines this classification (e.g., '1.0')."
},
{
"name": "taxonomy.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "taxonomy.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "taxonomy.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "taxonomy.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "taxonomy.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "primary_category",
"value": "",
"type": "query",
"description": "Top-level disclosure category."
},
{
"name": "primary_category.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "primary_category.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "primary_category.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "primary_category.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "primary_category.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "secondary_category",
"value": "",
"type": "query",
"description": "Mid-level disclosure category."
},
{
"name": "secondary_category.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "secondary_category.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "secondary_category.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "secondary_category.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "secondary_category.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "tertiary_category",
"value": "",
"type": "query",
"description": "Most specific disclosure category."
},
{
"name": "tertiary_category.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tertiary_category.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "tertiary_category.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "tertiary_category.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "tertiary_category.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '200' if not specified. The maximum allowed limit is '1000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "The complete list of 8-K disclosure classifications used in the 8-K disclosures endpoint."
},
{
"info": {
"name": "get_stocks_taxonomies_vX_risk-factors",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/taxonomies/vX/risk-factors",
"params": [
{
"name": "taxonomy",
"value": "",
"type": "query",
"description": "Version identifier (e.g., '1.0', '1.1') for the taxonomy Value must be a floating point number."
},
{
"name": "taxonomy.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "taxonomy.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "taxonomy.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "taxonomy.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "primary_category",
"value": "",
"type": "query",
"description": "Top-level risk category"
},
{
"name": "primary_category.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "primary_category.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "primary_category.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "primary_category.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "primary_category.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "secondary_category",
"value": "",
"type": "query",
"description": "Mid-level risk category"
},
{
"name": "secondary_category.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "secondary_category.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "secondary_category.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "secondary_category.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "secondary_category.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "tertiary_category",
"value": "",
"type": "query",
"description": "Most specific risk classification"
},
{
"name": "tertiary_category.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tertiary_category.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "tertiary_category.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "tertiary_category.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "tertiary_category.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '200' if not specified. The maximum allowed limit is '1000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "The complete list of risk factor classifications used in the risk factors endpoint."
},
{
"info": {
"name": "get_stocks_v1_short-interest",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/v1/short-interest",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The primary ticker symbol for the stock."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "days_to_cover",
"value": "",
"type": "query",
"description": "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. Value must be a floating point number."
},
{
"name": "days_to_cover.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number."
},
{
"name": "days_to_cover.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "days_to_cover.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "days_to_cover.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "days_to_cover.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "settlement_date",
"value": "",
"type": "query",
"description": "The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules."
},
{
"name": "settlement_date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "settlement_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "settlement_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "settlement_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "settlement_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "avg_daily_volume",
"value": "",
"type": "query",
"description": "The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. Value must be an integer."
},
{
"name": "avg_daily_volume.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer."
},
{
"name": "avg_daily_volume.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer."
},
{
"name": "avg_daily_volume.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer."
},
{
"name": "avg_daily_volume.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer."
},
{
"name": "avg_daily_volume.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date."
},
{
"info": {
"name": "get_stocks_v1_short-volume",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/v1/short-volume",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The primary ticker symbol for the stock."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "date",
"value": "",
"type": "query",
"description": "The date of trade activity reported in the format YYYY-MM-DD"
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "short_volume_ratio",
"value": "",
"type": "query",
"description": "The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. Value must be a floating point number."
},
{
"name": "short_volume_ratio.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number."
},
{
"name": "short_volume_ratio.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "short_volume_ratio.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "short_volume_ratio.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "short_volume_ratio.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms."
},
{
"info": {
"name": "get_stocks_vX_float",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/vX/float",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The primary ticker symbol for the stock."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "free_float_percent",
"value": "",
"type": "query",
"description": "Percentage of total shares outstanding that are available for public trading, rounded to two decimal places. Value must be a floating point number."
},
{
"name": "free_float_percent.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "free_float_percent.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "free_float_percent.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "free_float_percent.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "Contains 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."
}
]
},
{
"info": {
"name": "financials",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_stocks_financials_v1_balance-sheets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/financials/v1/balance-sheets",
"params": [
{
"name": "cik",
"value": "",
"type": "query",
"description": "The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company's CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup)."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "cik.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "cik.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "cik.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "cik.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "tickers",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "tickers.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "period_end",
"value": "",
"type": "query",
"description": "The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "The date of the most recent SEC filing that included this period's data. This is not necessarily the date this period was originally filed. Because SEC filings restate comparative data for prior periods, multiple records can share the same filing_date. For example, an annual 10-K reports three years of results, and a 10-Q includes prior period comparatives. To find the original filing date for a specific 10-K or 10-Q, use the SEC EDGAR filings index endpoint (/stocks/filings/vX/index). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "fiscal_year",
"value": "",
"type": "query",
"description": "The fiscal year for the reporting period. Value must be a floating point number."
},
{
"name": "fiscal_year.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "fiscal_year.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_year.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "fiscal_year.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter",
"value": "",
"type": "query",
"description": "The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number."
},
{
"name": "fiscal_quarter.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "timeframe",
"value": "",
"type": "query",
"description": "The reporting period type. Possible values include: quarterly, annual."
},
{
"name": "timeframe.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "timeframe.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "timeframe.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "timeframe.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "timeframe.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "A comprehensive financial dataset containing quarterly and annual balance sheet data for public companies. Includes detailed asset, liability, and equity positions representing the company's financial position at specific points in time. Balance sheet data represents point-in-time snapshots rather than cumulative flows, showing what the company owns, owes, and shareholders' equity as of each period end date."
},
{
"info": {
"name": "get_stocks_financials_v1_cash-flow-statements",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/financials/v1/cash-flow-statements",
"params": [
{
"name": "cik",
"value": "",
"type": "query",
"description": "The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup)."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "cik.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "cik.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "cik.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "cik.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "period_end",
"value": "",
"type": "query",
"description": "The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "The date of the most recent SEC filing that included this period's data. This is not necessarily the date this period was originally filed. Because SEC filings restate comparative data for prior periods, multiple records can share the same filing_date. For example, an annual 10-K reports three years of results, and a 10-Q includes prior period comparatives. To find the original filing date for a specific 10-K or 10-Q, use the SEC EDGAR filings index endpoint (/stocks/filings/vX/index). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "tickers",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "tickers.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "fiscal_year",
"value": "",
"type": "query",
"description": "The fiscal year for the reporting period. Value must be a floating point number."
},
{
"name": "fiscal_year.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "fiscal_year.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_year.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "fiscal_year.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter",
"value": "",
"type": "query",
"description": "The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number."
},
{
"name": "fiscal_quarter.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "timeframe",
"value": "",
"type": "query",
"description": "The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months."
},
{
"name": "timeframe.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "timeframe.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "timeframe.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "timeframe.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "timeframe.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "A comprehensive financial dataset containing quarterly, annual, and trailing twelve-month cash flow statement data for public companies. Includes detailed operating, investing, and financing cash flows with proper TTM calculations that sum all cash flow components over four quarters. TTM records are validated to ensure exactly four distinct quarters spanning 250-400 days for accurate trailing twelve-month cash flow analysis."
},
{
"info": {
"name": "get_stocks_financials_v1_income-statements",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/financials/v1/income-statements",
"params": [
{
"name": "cik",
"value": "",
"type": "query",
"description": "The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup)."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "cik.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "cik.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "cik.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "cik.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "tickers",
"value": "",
"type": "query",
"description": "Filter for arrays that contain the value."
},
{
"name": "tickers.all_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tickers.any_of",
"value": "",
"type": "query",
"description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "period_end",
"value": "",
"type": "query",
"description": "The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "period_end.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "The date of the most recent SEC filing that included this period's data. This is not necessarily the date this period was originally filed. Because SEC filings restate comparative data for prior periods, multiple records can share the same filing_date. For example, an annual 10-K reports three years of results, and a 10-Q includes prior period comparatives. To find the original filing date for a specific 10-K or 10-Q, use the SEC EDGAR filings index endpoint (/stocks/filings/vX/index). Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "fiscal_year",
"value": "",
"type": "query",
"description": "The fiscal year for the reporting period. Value must be a floating point number."
},
{
"name": "fiscal_year.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "fiscal_year.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_year.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "fiscal_year.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter",
"value": "",
"type": "query",
"description": "The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number."
},
{
"name": "fiscal_quarter.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "fiscal_quarter.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "timeframe",
"value": "",
"type": "query",
"description": "The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months."
},
{
"name": "timeframe.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "timeframe.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "timeframe.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "timeframe.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "timeframe.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified."
}
]
},
"docs": "A comprehensive database of income statement financial data for public companies, including key metrics such as revenue, expenses, and net income for various reporting periods."
},
{
"info": {
"name": "get_stocks_financials_v1_ratios",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/financials/v1/ratios",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Stock ticker symbol for the company."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "cik",
"value": "",
"type": "query",
"description": "Central Index Key (CIK) number assigned by the SEC to identify the company."
},
{
"name": "cik.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "cik.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "cik.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "cik.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "cik.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "price",
"value": "",
"type": "query",
"description": "Stock price used in ratio calculations, typically the closing price for the given date. Value must be a floating point number."
},
{
"name": "price.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "price.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "price.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "price.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "average_volume",
"value": "",
"type": "query",
"description": "Average trading volume over the last 30 trading days, providing context for liquidity. Value must be a floating point number."
},
{
"name": "average_volume.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "average_volume.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "average_volume.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "average_volume.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "market_cap",
"value": "",
"type": "query",
"description": "Market capitalization, calculated as stock price multiplied by total shares outstanding. Value must be a floating point number."
},
{
"name": "market_cap.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "market_cap.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "market_cap.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "market_cap.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "earnings_per_share",
"value": "",
"type": "query",
"description": "Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding. Value must be a floating point number."
},
{
"name": "earnings_per_share.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "earnings_per_share.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "earnings_per_share.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "earnings_per_share.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_earnings",
"value": "",
"type": "query",
"description": "Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive. Value must be a floating point number."
},
{
"name": "price_to_earnings.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "price_to_earnings.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_earnings.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "price_to_earnings.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_book",
"value": "",
"type": "query",
"description": "Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value. Value must be a floating point number."
},
{
"name": "price_to_book.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "price_to_book.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_book.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "price_to_book.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_sales",
"value": "",
"type": "query",
"description": "Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales. Value must be a floating point number."
},
{
"name": "price_to_sales.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "price_to_sales.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_sales.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "price_to_sales.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_cash_flow",
"value": "",
"type": "query",
"description": "Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive. Value must be a floating point number."
},
{
"name": "price_to_cash_flow.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "price_to_cash_flow.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_cash_flow.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "price_to_cash_flow.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_free_cash_flow",
"value": "",
"type": "query",
"description": "Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive. Value must be a floating point number."
},
{
"name": "price_to_free_cash_flow.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "price_to_free_cash_flow.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "price_to_free_cash_flow.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "price_to_free_cash_flow.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "dividend_yield",
"value": "",
"type": "query",
"description": "Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment. Value must be a floating point number."
},
{
"name": "dividend_yield.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "dividend_yield.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "dividend_yield.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "dividend_yield.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "return_on_assets",
"value": "",
"type": "query",
"description": "Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit. Value must be a floating point number."
},
{
"name": "return_on_assets.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "return_on_assets.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "return_on_assets.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "return_on_assets.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "return_on_equity",
"value": "",
"type": "query",
"description": "Return on equity ratio, calculated as net income divided by total shareholders' equity, measuring profitability relative to shareholders' equity. Value must be a floating point number."
},
{
"name": "return_on_equity.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "return_on_equity.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "return_on_equity.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "return_on_equity.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "debt_to_equity",
"value": "",
"type": "query",
"description": "Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders' equity, measuring financial leverage. Value must be a floating point number."
},
{
"name": "debt_to_equity.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "debt_to_equity.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "debt_to_equity.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "debt_to_equity.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "current",
"value": "",
"type": "query",
"description": "Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity. Value must be a floating point number."
},
{
"name": "current.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "current.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "current.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "current.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "quick",
"value": "",
"type": "query",
"description": "Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity. Value must be a floating point number."
},
{
"name": "quick.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "quick.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "quick.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "quick.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "cash",
"value": "",
"type": "query",
"description": "Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage. Value must be a floating point number."
},
{
"name": "cash.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "cash.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "cash.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "cash.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "ev_to_sales",
"value": "",
"type": "query",
"description": "Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales. Value must be a floating point number."
},
{
"name": "ev_to_sales.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "ev_to_sales.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "ev_to_sales.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "ev_to_sales.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "ev_to_ebitda",
"value": "",
"type": "query",
"description": "Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization. Value must be a floating point number."
},
{
"name": "ev_to_ebitda.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "ev_to_ebitda.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "ev_to_ebitda.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "ev_to_ebitda.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "enterprise_value",
"value": "",
"type": "query",
"description": "Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value. Value must be a floating point number."
},
{
"name": "enterprise_value.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "enterprise_value.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "enterprise_value.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "enterprise_value.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "free_cash_flow",
"value": "",
"type": "query",
"description": "Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment). Value must be a floating point number."
},
{
"name": "free_cash_flow.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be a floating point number."
},
{
"name": "free_cash_flow.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be a floating point number."
},
{
"name": "free_cash_flow.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be a floating point number."
},
{
"name": "free_cash_flow.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be a floating point number."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "A comprehensive financial ratios dataset providing key valuation, profitability, liquidity, and leverage metrics for public companies. Combines data from income statements, balance sheets, and cash flow statements with daily stock prices to calculate ratios on a daily basis. Uses trailing twelve months (TTM) data for income/cash flow metrics and quarterly data for balance sheet items. Fundamental data updates are applied starting from each filing's period end date. Market cap calculations use po"
}
]
},
{
"info": {
"name": "us_stocks_reference",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_stocks_v1_dividends",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/v1/dividends",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Stock symbol for the company issuing the dividend"
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ex_dividend_date",
"value": "",
"type": "query",
"description": "Date when the stock begins trading without the dividend value Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "ex_dividend_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "ex_dividend_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "ex_dividend_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "ex_dividend_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "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. Value must be an integer."
},
{
"name": "frequency.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer."
},
{
"name": "frequency.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer."
},
{
"name": "frequency.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer."
},
{
"name": "frequency.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer."
},
{
"name": "distribution_type",
"value": "",
"type": "query",
"description": "Classification describing the nature of this dividend's recurrence pattern: recurring (paid on a regular schedule), special (one-time or commemorative), supplemental (extra beyond the regular schedule), irregular (unpredictable or non-recurring), unknown (cannot be classified from available data)"
},
{
"name": "distribution_type.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "Contains historical dividend payment records for US stocks with split-adjusted amounts and historical adjustment factors for price normalization."
},
{
"info": {
"name": "get_stocks_v1_splits",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/stocks/v1/splits",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Stock symbol for the company that executed the split"
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "execution_date",
"value": "",
"type": "query",
"description": "Date when the stock split takes effect. The adjustment is applied overnight. On the prior trading day, the post-market session is the last session that shows pre-split prices. On the execution date, all trading is already adjusted for the split. This includes the pre-market session. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "execution_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "execution_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "execution_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "execution_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'."
},
{
"name": "adjustment_type",
"value": "",
"type": "query",
"description": "Classification of the share-change event. Possible values include: forward_split (share count increases), reverse_split (share count decreases), stock_dividend (shares issued as a dividend)"
},
{
"name": "adjustment_type.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "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."
}
]
},
"docs": "Contains historical stock split and reverse split events for US equities with historical adjustment factors for price normalization."
},
{
"info": {
"name": "get_v1_reference_ipos",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/reference/ipos",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The ticker symbol of the IPO event."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "us_code",
"value": "",
"type": "query",
"description": "Nine-character alphanumeric code that uniquely identifies a financial security in North America."
},
{
"name": "us_code.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "us_code.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "us_code.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "us_code.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "us_code.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "isin",
"value": "",
"type": "query",
"description": "International Securities Identification Number. This is a unique twelve-digit code that is assigned to every security issuance in the world."
},
{
"name": "isin.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "isin.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "isin.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "isin.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "isin.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "listing_date",
"value": "",
"type": "query",
"description": "First trading date for the newly listed entity. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "listing_date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "listing_date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "listing_date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "listing_date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds, formatted 'yyyy-mm-dd', or ISO 8601/RFC 3339 (e.g. '2024-05-28T20:27:41Z')."
},
{
"name": "ipo_status",
"value": "",
"type": "query",
"description": "The status of the IPO."
},
{
"name": "ipo_status.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '1000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'listing_date' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "Contains comprehensive data about Initial Public Offerings (IPOs) and direct listings for US stocks, tracking both historical and pending offerings with detailed pricing, share, and timing information."
}
]
},
{
"info": {
"name": "tmx",
"type": "folder"
},
"items": [
{
"info": {
"name": "get_tmx_v1_corporate-events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/tmx/v1/corporate-events",
"params": [
{
"name": "date",
"value": "",
"type": "query",
"description": "Scheduled date of the corporate event, formatted as YYYY-MM-DD."
},
{
"name": "date.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "date.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "date.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "date.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "date.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop."
},
{
"name": "type.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "type.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "type.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "type.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "type.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed."
},
{
"name": "status.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "status.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "status.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "status.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "status.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "The company's stock symbol."
},
{
"name": "ticker.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "isin",
"value": "",
"type": "query",
"description": "Standard international identifier for the company's common stock."
},
{
"name": "isin.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "isin.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "isin.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "isin.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "isin.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "trading_venue",
"value": "",
"type": "query",
"description": "MIC (Market Identifier Code) of the exchange where the company's stock is listed."
},
{
"name": "trading_venue.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "trading_venue.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "trading_venue.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "trading_venue.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "trading_venue.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "tmx_company_id",
"value": "",
"type": "query",
"description": "Unique numeric identifier for the company used by TMX. Value must be an integer."
},
{
"name": "tmx_company_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value. Value must be an integer."
},
{
"name": "tmx_company_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value. Value must be an integer."
},
{
"name": "tmx_company_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value. Value must be an integer."
},
{
"name": "tmx_company_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value. Value must be an integer."
},
{
"name": "tmx_record_id",
"value": "",
"type": "query",
"description": "The unique alphanumeric identifier for the event record used by TMX."
},
{
"name": "tmx_record_id.any_of",
"value": "",
"type": "query",
"description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list."
},
{
"name": "tmx_record_id.gt",
"value": "",
"type": "query",
"description": "Filter greater than the value."
},
{
"name": "tmx_record_id.gte",
"value": "",
"type": "query",
"description": "Filter greater than or equal to the value."
},
{
"name": "tmx_record_id.lt",
"value": "",
"type": "query",
"description": "Filter less than the value."
},
{
"name": "tmx_record_id.lte",
"value": "",
"type": "query",
"description": "Filter less than or equal to the value."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'desc' if not specified."
}
]
},
"docs": "Contains corporate events and announcements for publicly traded companies, including earnings releases, conferences, dividends, and business updates sourced from TMX."
}
]
},
{
"info": {
"name": "fx:conversion",
"type": "folder"
},
"items": [
{
"info": {
"name": "Real-time Currency Conversion",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/conversion/:from/:to",
"params": [
{
"name": "from",
"value": "AUD",
"type": "path",
"description": "The \"from\" symbol of the pair."
},
{
"name": "to",
"value": "USD",
"type": "path",
"description": "The \"to\" symbol of the pair."
},
{
"name": "amount",
"value": "100",
"type": "query",
"description": "The amount to convert, with a decimal."
},
{
"name": "precision",
"value": "2",
"type": "query",
"description": "The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy."
}
]
},
"docs": "Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD."
}
]
},
{
"info": {
"name": "crypto:trades",
"type": "folder"
},
"items": [
{
"info": {
"name": "Historic Crypto Trades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/historic/crypto/:from/:to/:date",
"params": [
{
"name": "from",
"value": "BTC",
"type": "path",
"description": "The \"from\" symbol of the crypto pair."
},
{
"name": "to",
"value": "USD",
"type": "path",
"description": "The \"to\" symbol of the crypto pair."
},
{
"name": "date",
"value": "2020-10-14",
"type": "path",
"description": "The date/day of the historic ticks to retrieve."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results.\n"
},
{
"name": "limit",
"value": "100",
"type": "query",
"description": "Limit the size of the response, max 10000."
}
]
},
"docs": "Get historic trade ticks for a cryptocurrency pair.\n"
},
{
"info": {
"name": "Trades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/trades/:cryptoTicker",
"params": [
{
"name": "cryptoTicker",
"value": "X:BTC-USD",
"type": "path",
"description": "The ticker symbol to get trades for."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 1000 and max is 50000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get trades for a crypto ticker symbol in a given time range."
}
]
},
{
"info": {
"name": "fx:trades",
"type": "folder"
},
"items": [
{
"info": {
"name": "Historic Forex Ticks",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/historic/forex/:from/:to/:date",
"params": [
{
"name": "from",
"value": "AUD",
"type": "path",
"description": "The \"from\" symbol of the currency pair.\n\nExample: For **USD/JPY** the `from` would be **USD**.\n"
},
{
"name": "to",
"value": "USD",
"type": "path",
"description": "The \"to\" symbol of the currency pair.\n\nExample: For **USD/JPY** the `to` would be **JPY**.\n"
},
{
"name": "date",
"value": "2020-10-14",
"type": "path",
"description": "The date/day of the historic ticks to retrieve."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results.\n"
},
{
"name": "limit",
"value": "100",
"type": "query",
"description": "Limit the size of the response, max 10000."
}
]
},
"docs": "Get historic ticks for a forex currency pair.\n"
}
]
},
{
"info": {
"name": "crypto:aggregates",
"type": "folder"
},
"items": [
{
"info": {
"name": "Exponential Moving Average (EMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/ema/:cryptoTicker",
"params": [
{
"name": "cryptoTicker",
"value": "X:BTCUSD",
"type": "path",
"description": "The ticker symbol for which to get exponential moving average (EMA) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to \ncalculate the exponential moving average (EMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the exponential moving average (EMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Moving Average Convergence/Divergence (MACD)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/macd/:cryptoTicker",
"params": [
{
"name": "cryptoTicker",
"value": "X:BTCUSD",
"type": "path",
"description": "The ticker symbol for which to get MACD data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "short_window",
"value": "12",
"type": "query",
"description": "The short window size used to calculate MACD data."
},
{
"name": "long_window",
"value": "26",
"type": "query",
"description": "The long window size used to calculate MACD data."
},
{
"name": "signal_window",
"value": "9",
"type": "query",
"description": "The window size used to calculate the MACD signal line."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate MACD data. i.e. 'close' will result in using close prices to \ncalculate the MACD."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range."
},
{
"info": {
"name": "Relative Strength Index (RSI)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/rsi/:cryptoTicker",
"params": [
{
"name": "cryptoTicker",
"value": "X:BTCUSD",
"type": "path",
"description": "The ticker symbol for which to get relative strength index (RSI) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "window",
"value": "14",
"type": "query",
"description": "The window size used to calculate the relative strength index (RSI). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to \ncalculate the relative strength index (RSI)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the relative strength index (RSI) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Simple Moving Average (SMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/sma/:cryptoTicker",
"params": [
{
"name": "cryptoTicker",
"value": "X:BTCUSD",
"type": "path",
"description": "The ticker symbol for which to get simple moving average (SMA) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to \ncalculate the simple moving average (SMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the simple moving average (SMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Grouped Daily (Bars)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/grouped/locale/global/market/crypto/:date",
"params": [
{
"name": "date",
"value": "2025-11-03",
"type": "path",
"description": "The beginning date for the aggregate window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
}
]
},
"docs": "Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets.\n"
},
{
"info": {
"name": "Previous Close",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:cryptoTicker/prev",
"params": [
{
"name": "cryptoTicker",
"value": "X:BTCUSD",
"type": "path",
"description": "The ticker symbol of the currency pair."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
}
]
},
"docs": "Get the previous day's open, high, low, and close (OHLC) for the specified cryptocurrency pair.\n"
},
{
"info": {
"name": "Aggregates (Bars)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:cryptoTicker/range/:multiplier/:timespan/:from/:to",
"params": [
{
"name": "cryptoTicker",
"value": "X:BTCUSD",
"type": "path",
"description": "The ticker symbol of the currency pair."
},
{
"name": "multiplier",
"value": "1",
"type": "path",
"description": "The size of the timespan multiplier."
},
{
"name": "timespan",
"value": "day",
"type": "path",
"description": "The size of the time window."
},
{
"name": "from",
"value": "2025-11-03",
"type": "path",
"description": "The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "to",
"value": "2025-11-28",
"type": "path",
"description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
},
{
"name": "sort",
"value": "asc",
"type": "query",
"description": "Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n"
},
{
"name": "limit",
"value": "120",
"type": "query",
"description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n"
}
]
},
"docs": "Get aggregate bars for a cryptocurrency pair over a given date range in custom time window sizes.\n
\n
\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n"
}
]
},
{
"info": {
"name": "fx:aggregates",
"type": "folder"
},
"items": [
{
"info": {
"name": "Exponential Moving Average (EMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/ema/:fxTicker",
"params": [
{
"name": "fxTicker",
"value": "C:EURUSD",
"type": "path",
"description": "The ticker symbol for which to get exponential moving average (EMA) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to \ncalculate the exponential moving average (EMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the exponential moving average (EMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Moving Average Convergence/Divergence (MACD)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/macd/:fxTicker",
"params": [
{
"name": "fxTicker",
"value": "C:EURUSD",
"type": "path",
"description": "The ticker symbol for which to get MACD data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "short_window",
"value": "12",
"type": "query",
"description": "The short window size used to calculate MACD data."
},
{
"name": "long_window",
"value": "26",
"type": "query",
"description": "The long window size used to calculate MACD data."
},
{
"name": "signal_window",
"value": "9",
"type": "query",
"description": "The window size used to calculate the MACD signal line."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to \ncalculate the MACD."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range."
},
{
"info": {
"name": "Relative Strength Index (RSI)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/rsi/:fxTicker",
"params": [
{
"name": "fxTicker",
"value": "C:EURUSD",
"type": "path",
"description": "The ticker symbol for which to get relative strength index (RSI) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "14",
"type": "query",
"description": "The window size used to calculate the relative strength index (RSI)."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to \ncalculate the relative strength index (RSI)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the relative strength index (RSI) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Simple Moving Average (SMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/sma/:fxTicker",
"params": [
{
"name": "fxTicker",
"value": "C:EURUSD",
"type": "path",
"description": "The ticker symbol for which to get simple moving average (SMA) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to \ncalculate the simple moving average (SMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the simple moving average (SMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Grouped Daily (Bars)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/grouped/locale/global/market/fx/:date",
"params": [
{
"name": "date",
"value": "2025-11-03",
"type": "path",
"description": "The beginning date for the aggregate window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
}
]
},
"docs": "Get the daily open, high, low, and close (OHLC) for the entire forex markets.\n"
},
{
"info": {
"name": "Previous Close",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:forexTicker/prev",
"params": [
{
"name": "forexTicker",
"value": "C:EURUSD",
"type": "path",
"description": "The ticker symbol of the currency pair."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
}
]
},
"docs": "Get the previous day's open, high, low, and close (OHLC) for the specified forex pair.\n"
},
{
"info": {
"name": "Aggregates (Bars)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:forexTicker/range/:multiplier/:timespan/:from/:to",
"params": [
{
"name": "forexTicker",
"value": "C:EURUSD",
"type": "path",
"description": "The ticker symbol of the currency pair."
},
{
"name": "multiplier",
"value": "1",
"type": "path",
"description": "The size of the timespan multiplier."
},
{
"name": "timespan",
"value": "day",
"type": "path",
"description": "The size of the time window."
},
{
"name": "from",
"value": "2025-11-03",
"type": "path",
"description": "The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "to",
"value": "2025-11-28",
"type": "path",
"description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
},
{
"name": "sort",
"value": "asc",
"type": "query",
"description": "Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n"
},
{
"name": "limit",
"value": "120",
"type": "query",
"description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n"
}
]
},
"docs": "Get aggregate bars for a forex pair over a given date range in custom time window sizes.\n
\n
\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n"
}
]
},
{
"info": {
"name": "indices:aggregates",
"type": "folder"
},
"items": [
{
"info": {
"name": "Exponential Moving Average (EMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/ema/:indicesTicker",
"params": [
{
"name": "indicesTicker",
"value": "I:NDX",
"type": "path",
"description": "The ticker symbol for which to get exponential moving average (EMA) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The value in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close values to \ncalculate the exponential moving average (EMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the exponential moving average (EMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Moving Average Convergence/Divergence (MACD)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/macd/:indicesTicker",
"params": [
{
"name": "indicesTicker",
"value": "I:NDX",
"type": "path",
"description": "The ticker symbol for which to get MACD data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "short_window",
"value": "12",
"type": "query",
"description": "The short window size used to calculate MACD data."
},
{
"name": "long_window",
"value": "26",
"type": "query",
"description": "The long window size used to calculate MACD data."
},
{
"name": "signal_window",
"value": "9",
"type": "query",
"description": "The window size used to calculate the MACD signal line."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The value in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close values to \ncalculate the MACD."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Relative Strength Index (RSI)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/rsi/:indicesTicker",
"params": [
{
"name": "indicesTicker",
"value": "I:NDX",
"type": "path",
"description": "The ticker symbol for which to get relative strength index (RSI) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "14",
"type": "query",
"description": "The window size used to calculate the relative strength index (RSI)."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The value in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close values to \ncalculate the relative strength index (RSI)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the relative strength index (RSI) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Simple Moving Average (SMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/sma/:indicesTicker",
"params": [
{
"name": "indicesTicker",
"value": "I:NDX",
"type": "path",
"description": "The ticker symbol for which to get simple moving average (SMA) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The value in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close values to \ncalculate the simple moving average (SMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the simple moving average (SMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Previous Close",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:indicesTicker/prev",
"params": [
{
"name": "indicesTicker",
"value": "I:NDX",
"type": "path",
"description": "The ticker symbol of Index."
}
]
},
"docs": "Get the previous day's open, high, low, and close (OHLC) for the specified index.\n"
},
{
"info": {
"name": "Aggregates (Bars)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:indicesTicker/range/:multiplier/:timespan/:from/:to",
"params": [
{
"name": "indicesTicker",
"value": "I:NDX",
"type": "path",
"description": "The ticker symbol of Index."
},
{
"name": "multiplier",
"value": "1",
"type": "path",
"description": "The size of the timespan multiplier."
},
{
"name": "timespan",
"value": "day",
"type": "path",
"description": "The size of the time window."
},
{
"name": "from",
"value": "2025-11-03",
"type": "path",
"description": "The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "to",
"value": "2025-11-28",
"type": "path",
"description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "sort",
"value": "asc",
"type": "query",
"description": "Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n"
},
{
"name": "limit",
"value": "120",
"type": "query",
"description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n"
}
]
},
"docs": "Get aggregate bars for an index over a given date range in custom time window sizes.\n
\n
\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n"
}
]
},
{
"info": {
"name": "options:aggregates",
"type": "folder"
},
"items": [
{
"info": {
"name": "Exponential Moving Average (EMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/ema/:optionsTicker",
"params": [
{
"name": "optionsTicker",
"value": "O:SPY241220P00720000",
"type": "path",
"description": "The ticker symbol for which to get exponential moving average (EMA) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to \ncalculate the exponential moving average (EMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the exponential moving average (EMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Moving Average Convergence/Divergence (MACD)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/macd/:optionsTicker",
"params": [
{
"name": "optionsTicker",
"value": "O:SPY241220P00720000",
"type": "path",
"description": "The ticker symbol for which to get MACD data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "short_window",
"value": "12",
"type": "query",
"description": "The short window size used to calculate MACD data."
},
{
"name": "long_window",
"value": "26",
"type": "query",
"description": "The long window size used to calculate MACD data."
},
{
"name": "signal_window",
"value": "9",
"type": "query",
"description": "The window size used to calculate the MACD signal line."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to \ncalculate the MACD."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Relative Strength Index (RSI)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/rsi/:optionsTicker",
"params": [
{
"name": "optionsTicker",
"value": "O:SPY241220P00720000",
"type": "path",
"description": "The ticker symbol for which to get relative strength index (RSI) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "14",
"type": "query",
"description": "The window size used to calculate the relative strength index (RSI)."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to \ncalculate the relative strength index (RSI)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the relative strength index (RSI) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Simple Moving Average (SMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/sma/:optionsTicker",
"params": [
{
"name": "optionsTicker",
"value": "O:SPY241220P00720000",
"type": "path",
"description": "The ticker symbol for which to get simple moving average (SMA) data."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to \ncalculate the simple moving average (SMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the simple moving average (SMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Previous Close",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:optionsTicker/prev",
"params": [
{
"name": "optionsTicker",
"value": "O:SPY251219C00650000",
"type": "path",
"description": "The ticker symbol of the options contract."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
}
]
},
"docs": "Get the previous day's open, high, low, and close (OHLC) for the specified option contract.\n"
},
{
"info": {
"name": "Aggregates (Bars)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:optionsTicker/range/:multiplier/:timespan/:from/:to",
"params": [
{
"name": "optionsTicker",
"value": "O:SPY251219C00650000",
"type": "path",
"description": "The ticker symbol of the options contract."
},
{
"name": "multiplier",
"value": "1",
"type": "path",
"description": "The size of the timespan multiplier."
},
{
"name": "timespan",
"value": "day",
"type": "path",
"description": "The size of the time window."
},
{
"name": "from",
"value": "2025-11-03",
"type": "path",
"description": "The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "to",
"value": "2025-11-28",
"type": "path",
"description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
},
{
"name": "sort",
"value": "asc",
"type": "query",
"description": "Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n"
},
{
"name": "limit",
"value": "120",
"type": "query",
"description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n"
}
]
},
"docs": "Get aggregate bars for an option contract over a given date range in custom time window sizes.\n
\n
\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n"
}
]
},
{
"info": {
"name": "stocks:aggregates",
"type": "folder"
},
"items": [
{
"info": {
"name": "Exponential Moving Average (EMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/ema/:stockTicker",
"params": [
{
"name": "stockTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol for which to get exponential moving average (EMA) data. For example, AAPL represents Apple Inc."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "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."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to \ncalculate the exponential moving average (EMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the exponential moving average (EMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Moving Average Convergence/Divergence (MACD)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/macd/:stockTicker",
"params": [
{
"name": "stockTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol for which to get moving average convergence/divergence (MACD) data. For example, AAPL represents Apple Inc."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits."
},
{
"name": "short_window",
"value": "12",
"type": "query",
"description": "The short window size used to calculate MACD data."
},
{
"name": "long_window",
"value": "26",
"type": "query",
"description": "The long window size used to calculate MACD data."
},
{
"name": "signal_window",
"value": "9",
"type": "query",
"description": "The window size used to calculate the MACD signal line."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to \ncalculate the MACD."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range."
},
{
"info": {
"name": "Relative Strength Index (RSI)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/rsi/:stockTicker",
"params": [
{
"name": "stockTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol for which to get relative strength index (RSI) data. For example, AAPL represents Apple Inc."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "14",
"type": "query",
"description": "The window size used to calculate the relative strength index (RSI)."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to \ncalculate the relative strength index (RSI)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the relative strength index (RSI) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Simple Moving Average (SMA)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/indicators/sma/:stockTicker",
"params": [
{
"name": "stockTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol for which to get simple moving average (SMA) data. For example, AAPL represents Apple Inc."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "timespan",
"value": "day",
"type": "query",
"description": "The size of the aggregate time window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted.\nSet this to false to get results that are NOT adjusted for splits."
},
{
"name": "window",
"value": "50",
"type": "query",
"description": "The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average."
},
{
"name": "series_type",
"value": "close",
"type": "query",
"description": "The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to \ncalculate the simple moving average (SMA)."
},
{
"name": "expand_underlying",
"value": "",
"type": "query",
"description": "Whether or not to include the aggregates used to calculate this indicator in the response."
},
{
"name": "order",
"value": "desc",
"type": "query",
"description": "The order in which to return the results, ordered by timestamp."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 5000"
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
}
]
},
"docs": "Get the simple moving average (SMA) for a ticker symbol over a given time range."
},
{
"info": {
"name": "Grouped Daily (Bars)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/grouped/locale/us/market/stocks/:date",
"params": [
{
"name": "date",
"value": "2025-11-03",
"type": "path",
"description": "The beginning date for the aggregate window."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
},
{
"name": "include_otc",
"value": "",
"type": "query",
"description": "Include OTC securities in the response. Default is false (don't include OTC securities).\n"
}
]
},
"docs": "Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets.\n"
},
{
"info": {
"name": "Previous Close",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:stocksTicker/prev",
"params": [
{
"name": "stocksTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
}
]
},
"docs": "Get the previous day's open, high, low, and close (OHLC) for the specified stock ticker.\n"
},
{
"info": {
"name": "Aggregates (Bars)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/aggs/ticker/:stocksTicker/range/:multiplier/:timespan/:from/:to",
"params": [
{
"name": "stocksTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
},
{
"name": "multiplier",
"value": "1",
"type": "path",
"description": "The size of the timespan multiplier."
},
{
"name": "timespan",
"value": "day",
"type": "path",
"description": "The size of the time window."
},
{
"name": "from",
"value": "2025-11-03",
"type": "path",
"description": "The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "to",
"value": "2025-11-28",
"type": "path",
"description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
},
{
"name": "sort",
"value": "asc",
"type": "query",
"description": "Sort the results by timestamp.\n`asc` will return results in ascending order (oldest at the top),\n`desc` will return results in descending order (newest at the top).\n"
},
{
"name": "limit",
"value": "120",
"type": "query",
"description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n"
}
]
},
"docs": "Get aggregate bars for a stock over a given date range in custom time window sizes.\n
\n
\nFor example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.\n"
}
]
},
{
"info": {
"name": "crypto:last:trade",
"type": "folder"
},
"items": [
{
"info": {
"name": "Last Trade for a Crypto Pair",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/last/crypto/:from/:to",
"params": [
{
"name": "from",
"value": "BTC",
"type": "path",
"description": "The \"from\" symbol of the pair."
},
{
"name": "to",
"value": "USD",
"type": "path",
"description": "The \"to\" symbol of the pair."
}
]
},
"docs": "Get the last trade tick for a cryptocurrency pair."
}
]
},
{
"info": {
"name": "fx:last:quote",
"type": "folder"
},
"items": [
{
"info": {
"name": "Last Quote for a Currency Pair",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/last_quote/currencies/:from/:to",
"params": [
{
"name": "from",
"value": "AUD",
"type": "path",
"description": "The \"from\" symbol of the pair."
},
{
"name": "to",
"value": "USD",
"type": "path",
"description": "The \"to\" symbol of the pair."
}
]
},
"docs": "Get the last quote tick for a forex currency pair."
}
]
},
{
"info": {
"name": "reference:stocks:market",
"type": "folder"
},
"items": [
{
"info": {
"name": "Market Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/marketstatus/now"
},
"docs": "Get the current trading status of the exchanges and overall financial markets."
},
{
"info": {
"name": "Market Holidays",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/marketstatus/upcoming"
},
"docs": "Get upcoming market holidays and their open/close times."
}
]
},
{
"info": {
"name": "crypto:open-close",
"type": "folder"
},
"items": [
{
"info": {
"name": "Daily Open/Close",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/open-close/crypto/:from/:to/:date",
"params": [
{
"name": "from",
"value": "BTC",
"type": "path",
"description": "The \"from\" symbol of the pair."
},
{
"name": "to",
"value": "USD",
"type": "path",
"description": "The \"to\" symbol of the pair."
},
{
"name": "date",
"value": "2023-01-09",
"type": "path",
"description": "The date of the requested open/close in the format YYYY-MM-DD."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
}
]
},
"docs": "Get the open, close prices of a cryptocurrency symbol on a certain day.\n"
}
]
},
{
"info": {
"name": "stocks:open-close",
"type": "folder"
},
"items": [
{
"info": {
"name": "Daily Open/Close",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/open-close/:indicesTicker/:date",
"params": [
{
"name": "indicesTicker",
"value": "I:NDX",
"type": "path",
"description": "The ticker symbol of Index."
},
{
"name": "date",
"value": "2023-03-10",
"type": "path",
"description": "The date of the requested open/close in the format YYYY-MM-DD."
}
]
},
"docs": "Get the open, close and afterhours values of a index symbol on a certain date.\n"
},
{
"info": {
"name": "Daily Open/Close",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/open-close/:stocksTicker/:date",
"params": [
{
"name": "stocksTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
},
{
"name": "date",
"value": "2023-01-09",
"type": "path",
"description": "The date of the requested open/close in the format YYYY-MM-DD."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
}
]
},
"docs": "Get the open, close and afterhours prices of a stock symbol on a certain date.\n"
}
]
},
{
"info": {
"name": "options:open-close",
"type": "folder"
},
"items": [
{
"info": {
"name": "Daily Open/Close",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/open-close/:optionsTicker/:date",
"params": [
{
"name": "optionsTicker",
"value": "O:SPY251219C00650000",
"type": "path",
"description": "The ticker symbol of the options contract."
},
{
"name": "date",
"value": "2023-01-09",
"type": "path",
"description": "The date of the requested open/close in the format YYYY-MM-DD."
},
{
"name": "adjusted",
"value": "true",
"type": "query",
"description": "Whether or not the results are adjusted for splits. By default, results are adjusted.\nSet this to false to get results that are NOT adjusted for splits.\n"
}
]
},
"docs": "Get the open, close and afterhours prices of an options contract on a certain date.\n"
}
]
},
{
"info": {
"name": "reference:sec:filings",
"type": "folder"
},
"items": [
{
"info": {
"name": "SEC Filings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/reference/sec/filings",
"params": [
{
"name": "type",
"value": "",
"type": "query",
"description": "Query by filing type."
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Query by filing date."
},
{
"name": "period_of_report_date",
"value": "",
"type": "query",
"description": "Query by period of report."
},
{
"name": "has_xbrl",
"value": "",
"type": "query",
"description": "If true, query only for filings with an XBRL instance file.\nIf false, query for filings without an XBRL instance file.\nIf this parameter is not provided, query for filings with or without XBRL instance files."
},
{
"name": "entities.company_data.name",
"value": "",
"type": "query",
"description": "Query by entity company name."
},
{
"name": "entities.company_data.cik",
"value": "",
"type": "query",
"description": "Query by entity company CIK."
},
{
"name": "entities.company_data.ticker",
"value": "",
"type": "query",
"description": "Query by entity company ticker."
},
{
"name": "entities.company_data.sic",
"value": "",
"type": "query",
"description": "Query by entity company SIC."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Search by filing_date."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Search by filing_date."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Search by filing_date."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Search by filing_date."
},
{
"name": "period_of_report_date.gte",
"value": "",
"type": "query",
"description": "Search by period_of_report_date."
},
{
"name": "period_of_report_date.gt",
"value": "",
"type": "query",
"description": "Search by period_of_report_date."
},
{
"name": "period_of_report_date.lte",
"value": "",
"type": "query",
"description": "Search by period_of_report_date."
},
{
"name": "period_of_report_date.lt",
"value": "",
"type": "query",
"description": "Search by period_of_report_date."
},
{
"name": "entities.company_data.name.search",
"value": "",
"type": "query",
"description": "Search by entities.company_data.name."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "List filings"
}
]
},
{
"info": {
"name": "reference:sec:filing",
"type": "folder"
},
"items": [
{
"info": {
"name": "SEC Filing",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/reference/sec/filings/:filing_id",
"params": [
{
"name": "filing_id",
"value": "",
"type": "path",
"description": "Select by filing id."
}
]
},
"docs": "Get filing"
}
]
},
{
"info": {
"name": "reference:sec:filing:files",
"type": "folder"
},
"items": [
{
"info": {
"name": "SEC Filing Files",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/reference/sec/filings/:filing_id/files",
"params": [
{
"name": "filing_id",
"value": "",
"type": "path",
"description": "Select by filing id."
},
{
"name": "sequence",
"value": "",
"type": "query",
"description": "Query by file sequence number."
},
{
"name": "filename",
"value": "",
"type": "query",
"description": "Query by file name."
},
{
"name": "sequence.gte",
"value": "",
"type": "query",
"description": "Search by sequence."
},
{
"name": "sequence.gt",
"value": "",
"type": "query",
"description": "Search by sequence."
},
{
"name": "sequence.lte",
"value": "",
"type": "query",
"description": "Search by sequence."
},
{
"name": "sequence.lt",
"value": "",
"type": "query",
"description": "Search by sequence."
},
{
"name": "filename.gte",
"value": "",
"type": "query",
"description": "Search by filename."
},
{
"name": "filename.gt",
"value": "",
"type": "query",
"description": "Search by filename."
},
{
"name": "filename.lte",
"value": "",
"type": "query",
"description": "Search by filename."
},
{
"name": "filename.lt",
"value": "",
"type": "query",
"description": "Search by filename."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "List filing files"
}
]
},
{
"info": {
"name": "reference:sec:filing:file",
"type": "folder"
},
"items": [
{
"info": {
"name": "SEC Filing File",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/reference/sec/filings/:filing_id/files/:file_id",
"params": [
{
"name": "filing_id",
"value": "",
"type": "path",
"description": "Select by filing id."
},
{
"name": "file_id",
"value": "",
"type": "path",
"description": "Select by file id."
}
]
},
"docs": "Get filing file"
}
]
},
{
"info": {
"name": "reference:related:companies",
"type": "folder"
},
"items": [
{
"info": {
"name": "Related Companies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/related-companies/:ticker",
"params": [
{
"name": "ticker",
"value": "AAPL",
"type": "path",
"description": "The ticker symbol to search."
}
]
},
"docs": "Get a list of tickers related to the queried ticker based on News and Returns data."
}
]
},
{
"info": {
"name": "Default",
"type": "folder"
},
"items": [
{
"info": {
"name": "Summaries",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v1/summaries",
"params": [
{
"name": "ticker.any_of",
"value": "NCLH,O:SPY250321C00380000,C:EURUSD,X:BTCUSD",
"type": "query",
"description": "Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See the tickers endpoint for more details on supported tickers. If no tickers are passed then no results will be returned.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack."
}
]
},
"docs": "Get everything needed to visualize the tick-by-tick movement of a list of tickers."
},
{
"info": {
"name": "Universal Snapshot",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/snapshot",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Search a range of tickers lexicographically."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Query by the type of asset."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.any_of",
"value": "NCLH,O:SPY250321C00380000,C:EURUSD,X:BTCUSD,I:SPX",
"type": "query",
"description": "Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack.\n"
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 250."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get snapshots for assets of all types"
}
]
},
{
"info": {
"name": "stocks:last:quote",
"type": "folder"
},
"items": [
{
"info": {
"name": "Last Quote",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/last/nbbo/:stocksTicker",
"params": [
{
"name": "stocksTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
}
]
},
"docs": "Get the most recent NBBO (Quote) tick for a given stock."
}
]
},
{
"info": {
"name": "options:last:trade",
"type": "folder"
},
"items": [
{
"info": {
"name": "Last Trade",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/last/trade/:optionsTicker",
"params": [
{
"name": "optionsTicker",
"value": "O:TSLA210903C00700000",
"type": "path",
"description": "The ticker symbol of the options contract."
}
]
},
"docs": "Get the most recent trade for a given options contract."
}
]
},
{
"info": {
"name": "stocks:last:trade",
"type": "folder"
},
"items": [
{
"info": {
"name": "Last Trade",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/last/trade/:stocksTicker",
"params": [
{
"name": "stocksTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
}
]
},
"docs": "Get the most recent trade for a given stock."
}
]
},
{
"info": {
"name": "reference:news",
"type": "folder"
},
"items": [
{
"info": {
"name": "Ticker News",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/reference/news",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
},
{
"name": "published_utc",
"value": "",
"type": "query",
"description": "Return results published on, before, or after this date."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Search by ticker."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Search by ticker."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Search by ticker."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Search by ticker."
},
{
"name": "published_utc.gte",
"value": "",
"type": "query",
"description": "Search by published_utc."
},
{
"name": "published_utc.gt",
"value": "",
"type": "query",
"description": "Search by published_utc."
},
{
"name": "published_utc.lte",
"value": "",
"type": "query",
"description": "Search by published_utc."
},
{
"name": "published_utc.lt",
"value": "",
"type": "query",
"description": "Search by published_utc."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get the most recent news articles relating to a stock ticker symbol, including a summary of the article and a link to the original source."
}
]
},
{
"info": {
"name": "crypto:snapshot",
"type": "folder"
},
"items": [
{
"info": {
"name": "All Tickers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/tickers",
"params": [
{
"name": "tickers",
"value": "",
"type": "query",
"description": "A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers."
}
]
},
"docs": "Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.\n
\n
\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n"
},
{
"info": {
"name": "Ticker",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/tickers/:ticker",
"params": [
{
"name": "ticker",
"value": "X:BTCUSD",
"type": "path",
"description": "Ticker of the snapshot"
}
]
},
"docs": "Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded cryptocurrency symbol.\n
\n
\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n"
},
{
"info": {
"name": "Ticker Full Book (L2)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/tickers/:ticker/book",
"params": [
{
"name": "ticker",
"value": "X:BTCUSD",
"type": "path",
"description": "The cryptocurrency ticker."
}
]
},
"docs": "Get the current level 2 book of a single ticker. This is the combined book from all of the exchanges.\n
\n
\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n"
},
{
"info": {
"name": "Gainers/Losers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/:direction",
"params": [
{
"name": "direction",
"value": "gainers",
"type": "path",
"description": "The direction of the snapshot results to return.\n"
}
]
},
"docs": "Get the current top 20 gainers or losers of the day in cryptocurrency markets.\n
\n
\nTop gainers are those tickers whose price has increased by the highest percentage since the previous day's close.\nTop losers are those tickers whose price has decreased by the highest percentage since the previous day's close.\n
\n
\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n"
}
]
},
{
"info": {
"name": "fx:snapshot",
"type": "folder"
},
"items": [
{
"info": {
"name": "All Tickers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/global/markets/forex/tickers",
"params": [
{
"name": "tickers",
"value": "",
"type": "query",
"description": "A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers."
}
]
},
"docs": "Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded forex symbols.\n
\n
\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n"
},
{
"info": {
"name": "Ticker",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/global/markets/forex/tickers/:ticker",
"params": [
{
"name": "ticker",
"value": "C:EURUSD",
"type": "path",
"description": "The forex ticker."
}
]
},
"docs": "Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded currency symbol.\n
\n
\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n"
},
{
"info": {
"name": "Gainers/Losers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/global/markets/forex/:direction",
"params": [
{
"name": "direction",
"value": "gainers",
"type": "path",
"description": "The direction of the snapshot results to return.\n"
}
]
},
"docs": "Get the current top 20 gainers or losers of the day in forex markets.\n
\n
\nTop gainers are those tickers whose price has increased by the highest percentage since the previous day's close.\nTop losers are those tickers whose price has decreased by the highest percentage since the previous day's close.\n
\n
\nNote: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.\n"
}
]
},
{
"info": {
"name": "stocks:snapshot",
"type": "folder"
},
"items": [
{
"info": {
"name": "All Tickers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/us/markets/stocks/tickers",
"params": [
{
"name": "tickers",
"value": "",
"type": "query",
"description": "A case-sensitive comma separated list of tickers to get snapshots for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all tickers."
},
{
"name": "include_otc",
"value": "",
"type": "query",
"description": "Include OTC securities in the response. Default is false (don't include OTC securities).\n"
}
]
},
"docs": "Get the most up-to-date market data for all traded stock symbols.\n
\n
\nNote: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n"
},
{
"info": {
"name": "Ticker",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/us/markets/stocks/tickers/:stocksTicker",
"params": [
{
"name": "stocksTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
}
]
},
"docs": "Get the most up-to-date market data for a single traded stock ticker.\n
\n
\nNote: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n"
},
{
"info": {
"name": "Gainers/Losers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/snapshot/locale/us/markets/stocks/:direction",
"params": [
{
"name": "direction",
"value": "gainers",
"type": "path",
"description": "The direction of the snapshot results to return.\n"
},
{
"name": "include_otc",
"value": "",
"type": "query",
"description": "Include OTC securities in the response. Default is false (don't include OTC securities).\n"
}
]
},
"docs": "Get the most up-to-date market data for the current top 20 gainers or losers of the day in the stocks/equities markets.\n
\n
\nTop gainers are those tickers whose price has increased by the highest percentage since the previous day's close.\nTop losers are those tickers whose price has decreased by the highest percentage since the previous day's close.\nThis output will only include tickers with a trading volume of 10,000 or more.\n
\n
\nNote: Snapshot data is cleared at 3:30am EST a"
}
]
},
{
"info": {
"name": "stocks:quotes",
"type": "folder"
},
"items": [
{
"info": {
"name": "Quotes (NBBO)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/ticks/stocks/nbbo/:ticker/:date",
"params": [
{
"name": "ticker",
"value": "AAPL",
"type": "path",
"description": "The ticker symbol we want quotes for."
},
{
"name": "date",
"value": "2020-10-14",
"type": "path",
"description": "The date/day of the quotes to retrieve in the format YYYY-MM-DD."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results.\n"
},
{
"name": "timestampLimit",
"value": "",
"type": "query",
"description": "The maximum timestamp allowed in the results.\n"
},
{
"name": "reverse",
"value": "true",
"type": "query",
"description": "Reverse the order of the results.\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "Limit the size of the response, max 50000 and default 5000."
}
]
},
"docs": "Get NBBO quotes for a given ticker symbol on a specified date.\n"
},
{
"info": {
"name": "Quotes (NBBO)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/quotes/:stockTicker",
"params": [
{
"name": "stockTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 1000 and max is 50000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get NBBO quotes for a ticker symbol in a given time range."
}
]
},
{
"info": {
"name": "stocks:trades",
"type": "folder"
},
"items": [
{
"info": {
"name": "Trades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v2/ticks/stocks/trades/:ticker/:date",
"params": [
{
"name": "ticker",
"value": "AAPL",
"type": "path",
"description": "The ticker symbol we want trades for."
},
{
"name": "date",
"value": "2020-10-14",
"type": "path",
"description": "The date/day of the trades to retrieve in the format YYYY-MM-DD."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results.\n"
},
{
"name": "timestampLimit",
"value": "",
"type": "query",
"description": "The maximum timestamp allowed in the results.\n"
},
{
"name": "reverse",
"value": "true",
"type": "query",
"description": "Reverse the order of the results.\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "Limit the size of the response, max 50000 and default 5000."
}
]
},
"docs": "Get trades for a given ticker symbol on a specified date.\n"
},
{
"info": {
"name": "Trades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/trades/:stockTicker",
"params": [
{
"name": "stockTicker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 1000 and max is 50000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get trades for a ticker symbol in a given time range."
}
]
},
{
"info": {
"name": "fx:quotes",
"type": "folder"
},
"items": [
{
"info": {
"name": "Quotes (BBO)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/quotes/:fxTicker",
"params": [
{
"name": "fxTicker",
"value": "C:EUR-USD",
"type": "path",
"description": "The ticker symbol to get quotes for."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 1000 and max is 50000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get BBO quotes for a ticker symbol in a given time range."
}
]
},
{
"info": {
"name": "options:quotes",
"type": "folder"
},
"items": [
{
"info": {
"name": "Quotes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/quotes/:optionsTicker",
"params": [
{
"name": "optionsTicker",
"value": "O:SPY241220P00720000",
"type": "path",
"description": "The ticker symbol to get quotes for."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 1000 and max is 50000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get quotes for an options ticker symbol in a given time range."
}
]
},
{
"info": {
"name": "reference:conditions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Conditions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/reference/conditions",
"params": [
{
"name": "asset_class",
"value": "",
"type": "query",
"description": "Filter for conditions within a given asset class."
},
{
"name": "data_type",
"value": "",
"type": "query",
"description": "Filter by data type."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter for conditions with a given ID."
},
{
"name": "sip",
"value": "",
"type": "query",
"description": "Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "List all conditions that Massive uses."
}
]
},
{
"info": {
"name": "reference:dividends",
"type": "folder"
},
"items": [
{
"info": {
"name": "Dividends v3",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/reference/dividends",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
},
{
"name": "ex_dividend_date",
"value": "",
"type": "query",
"description": "Query by ex-dividend date with the format YYYY-MM-DD."
},
{
"name": "record_date",
"value": "",
"type": "query",
"description": "Query by record date with the format YYYY-MM-DD."
},
{
"name": "declaration_date",
"value": "",
"type": "query",
"description": "Query by declaration date with the format YYYY-MM-DD."
},
{
"name": "pay_date",
"value": "",
"type": "query",
"description": "Query by pay date with the format YYYY-MM-DD."
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Query by the number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly)."
},
{
"name": "cash_amount",
"value": "",
"type": "query",
"description": "Query by the cash amount of the dividend."
},
{
"name": "dividend_type",
"value": "",
"type": "query",
"description": "Query by the type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD.\nSpecial Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ex_dividend_date.gte",
"value": "",
"type": "query",
"description": "Range by ex_dividend_date."
},
{
"name": "ex_dividend_date.gt",
"value": "",
"type": "query",
"description": "Range by ex_dividend_date."
},
{
"name": "ex_dividend_date.lte",
"value": "",
"type": "query",
"description": "Range by ex_dividend_date."
},
{
"name": "ex_dividend_date.lt",
"value": "",
"type": "query",
"description": "Range by ex_dividend_date."
},
{
"name": "record_date.gte",
"value": "",
"type": "query",
"description": "Range by record_date."
},
{
"name": "record_date.gt",
"value": "",
"type": "query",
"description": "Range by record_date."
},
{
"name": "record_date.lte",
"value": "",
"type": "query",
"description": "Range by record_date."
},
{
"name": "record_date.lt",
"value": "",
"type": "query",
"description": "Range by record_date."
},
{
"name": "declaration_date.gte",
"value": "",
"type": "query",
"description": "Range by declaration_date."
},
{
"name": "declaration_date.gt",
"value": "",
"type": "query",
"description": "Range by declaration_date."
},
{
"name": "declaration_date.lte",
"value": "",
"type": "query",
"description": "Range by declaration_date."
},
{
"name": "declaration_date.lt",
"value": "",
"type": "query",
"description": "Range by declaration_date."
},
{
"name": "pay_date.gte",
"value": "",
"type": "query",
"description": "Range by pay_date."
},
{
"name": "pay_date.gt",
"value": "",
"type": "query",
"description": "Range by pay_date."
},
{
"name": "pay_date.lte",
"value": "",
"type": "query",
"description": "Range by pay_date."
},
{
"name": "pay_date.lt",
"value": "",
"type": "query",
"description": "Range by pay_date."
},
{
"name": "cash_amount.gte",
"value": "",
"type": "query",
"description": "Range by cash_amount."
},
{
"name": "cash_amount.gt",
"value": "",
"type": "query",
"description": "Range by cash_amount."
},
{
"name": "cash_amount.lte",
"value": "",
"type": "query",
"description": "Range by cash_amount."
},
{
"name": "cash_amount.lt",
"value": "",
"type": "query",
"description": "Range by cash_amount."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get a list of historical cash dividends, including the ticker symbol,\ndeclaration date, ex-dividend date, record date, pay date, frequency,\nand amount."
}
]
},
{
"info": {
"name": "reference:exchanges",
"type": "folder"
},
"items": [
{
"info": {
"name": "Exchanges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/reference/exchanges",
"params": [
{
"name": "asset_class",
"value": "",
"type": "query",
"description": "Filter by asset class."
},
{
"name": "locale",
"value": "",
"type": "query",
"description": "Filter by locale."
}
]
},
"docs": "List all exchanges that Massive knows about."
}
]
},
{
"info": {
"name": "reference:options:contracts:list",
"type": "folder"
},
"items": [
{
"info": {
"name": "Options Contracts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/reference/options/contracts",
"params": [
{
"name": "underlying_ticker",
"value": "",
"type": "query",
"description": "Query for contracts relating to an underlying stock ticker."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://massive.com/docs/rest/options/contracts/contract-overview)."
},
{
"name": "contract_type",
"value": "",
"type": "query",
"description": "Query by the type of contract."
},
{
"name": "expiration_date",
"value": "",
"type": "query",
"description": "Query by contract expiration with date format YYYY-MM-DD."
},
{
"name": "as_of",
"value": "",
"type": "query",
"description": "Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today's date."
},
{
"name": "strike_price",
"value": "",
"type": "query",
"description": "Query by strike price of a contract."
},
{
"name": "expired",
"value": "",
"type": "query",
"description": "Query for expired contracts. Default is false."
},
{
"name": "underlying_ticker.gte",
"value": "",
"type": "query",
"description": "Range by underlying_ticker."
},
{
"name": "underlying_ticker.gt",
"value": "",
"type": "query",
"description": "Range by underlying_ticker."
},
{
"name": "underlying_ticker.lte",
"value": "",
"type": "query",
"description": "Range by underlying_ticker."
},
{
"name": "underlying_ticker.lt",
"value": "",
"type": "query",
"description": "Range by underlying_ticker."
},
{
"name": "expiration_date.gte",
"value": "",
"type": "query",
"description": "Range by expiration_date."
},
{
"name": "expiration_date.gt",
"value": "",
"type": "query",
"description": "Range by expiration_date."
},
{
"name": "expiration_date.lte",
"value": "",
"type": "query",
"description": "Range by expiration_date."
},
{
"name": "expiration_date.lt",
"value": "",
"type": "query",
"description": "Range by expiration_date."
},
{
"name": "strike_price.gte",
"value": "",
"type": "query",
"description": "Range by strike_price."
},
{
"name": "strike_price.gt",
"value": "",
"type": "query",
"description": "Range by strike_price."
},
{
"name": "strike_price.lte",
"value": "",
"type": "query",
"description": "Range by strike_price."
},
{
"name": "strike_price.lt",
"value": "",
"type": "query",
"description": "Range by strike_price."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Query for historical options contracts. This provides both active and expired options contracts."
}
]
},
{
"info": {
"name": "reference:options:contract",
"type": "folder"
},
"items": [
{
"info": {
"name": "Options Contract",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/reference/options/contracts/:options_ticker",
"params": [
{
"name": "options_ticker",
"value": "O:SPY251219C00650000",
"type": "path",
"description": "Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://massive.com/blog/how-to-read-a-stock-options-ticker/)."
},
{
"name": "as_of",
"value": "",
"type": "query",
"description": "Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today's date."
}
]
},
"docs": "Get an options contract"
}
]
},
{
"info": {
"name": "reference:stocks",
"type": "folder"
},
"items": [
{
"info": {
"name": "Stock Splits v3",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/reference/splits",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
},
{
"name": "execution_date",
"value": "",
"type": "query",
"description": "Query by execution date with the format YYYY-MM-DD."
},
{
"name": "reverse_split",
"value": "",
"type": "query",
"description": "Query for reverse stock splits. A split ratio where split_from is greater than split_to represents a reverse split. By default this filter is not used."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "execution_date.gte",
"value": "",
"type": "query",
"description": "Range by execution_date."
},
{
"name": "execution_date.gt",
"value": "",
"type": "query",
"description": "Range by execution_date."
},
{
"name": "execution_date.lte",
"value": "",
"type": "query",
"description": "Range by execution_date."
},
{
"name": "execution_date.lt",
"value": "",
"type": "query",
"description": "Range by execution_date."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get a list of historical stock splits, including the ticker symbol, the execution date, and the factors of the split ratio."
},
{
"info": {
"name": "Stock Financials vX",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/vX/reference/financials",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Query by company ticker."
},
{
"name": "cik",
"value": "",
"type": "query",
"description": "Query by central index key (CIK) Number"
},
{
"name": "company_name",
"value": "",
"type": "query",
"description": "Query by company name."
},
{
"name": "sic",
"value": "",
"type": "query",
"description": "Query by standard industrial classification (SIC)"
},
{
"name": "filing_date",
"value": "",
"type": "query",
"description": "Query by the date when the filing with financials data was filed in YYYY-MM-DD format.\n\nBest used when querying over date ranges to find financials based on filings that happen in a time period.\n\nExamples:\n\nTo get financials based on filings that have happened after January 1, 2009 use the query param filing_date.gte=2009-01-01\n\nTo get financials based on filings that happened in the year 2009 use the query params filing_date.gte=2009-01-01&filing_date.lt=2010-01-01"
},
{
"name": "period_of_report_date",
"value": "",
"type": "query",
"description": "The period of report for the filing with financials data in YYYY-MM-DD format."
},
{
"name": "timeframe",
"value": "",
"type": "query",
"description": "Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4"
},
{
"name": "include_sources",
"value": "",
"type": "query",
"description": "Whether or not to include the `xpath` and `formula` attributes for each financial data point.\nSee the `xpath` and `formula` response attributes for more info. False by default."
},
{
"name": "company_name.search",
"value": "",
"type": "query",
"description": "Search by company_name."
},
{
"name": "filing_date.gte",
"value": "",
"type": "query",
"description": "Search by filing_date."
},
{
"name": "filing_date.gt",
"value": "",
"type": "query",
"description": "Search by filing_date."
},
{
"name": "filing_date.lte",
"value": "",
"type": "query",
"description": "Search by filing_date."
},
{
"name": "filing_date.lt",
"value": "",
"type": "query",
"description": "Search by filing_date."
},
{
"name": "period_of_report_date.gte",
"value": "",
"type": "query",
"description": "Search by period_of_report_date."
},
{
"name": "period_of_report_date.gt",
"value": "",
"type": "query",
"description": "Search by period_of_report_date."
},
{
"name": "period_of_report_date.lte",
"value": "",
"type": "query",
"description": "Search by period_of_report_date."
},
{
"name": "period_of_report_date.lt",
"value": "",
"type": "query",
"description": "Search by period_of_report_date."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 100."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get historical financial data for a stock ticker.\nThe financials data is extracted from XBRL from company SEC filings using the methodology outlined here."
}
]
},
{
"info": {
"name": "reference:tickers:list",
"type": "folder"
},
"items": [
{
"info": {
"name": "Tickers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/reference/tickers",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Specify a ticker symbol.\nDefaults to empty string which queries all tickers."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://massive.com/docs/rest/stocks/tickers/ticker-types).\nDefaults to empty string which queries all types."
},
{
"name": "market",
"value": "",
"type": "query",
"description": "Filter by market type. By default all markets are included."
},
{
"name": "exchange",
"value": "",
"type": "query",
"description": "Specify the asset's primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes).\nDefaults to empty string which queries all exchanges."
},
{
"name": "cusip",
"value": "",
"type": "query",
"description": "Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP).\nDefaults to empty string which queries all CUSIPs.\n\nNote: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response."
},
{
"name": "cik",
"value": "",
"type": "query",
"description": "Specify the CIK of the asset you want to search for. Find more information about CIK codes [at their website](https://www.sec.gov/edgar/searchedgar/cik.htm).\nDefaults to empty string which queries all CIKs."
},
{
"name": "date",
"value": "",
"type": "query",
"description": "Specify a point in time to retrieve tickers available on that date.\nDefaults to the most recent available date."
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search for terms within the ticker and/or company name."
},
{
"name": "active",
"value": "true",
"type": "query",
"description": "Specify if the tickers returned should be actively traded on the queried date. Default is true."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 100 and max is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Query all ticker symbols which are supported by Massive. This API currently includes Stocks/Equities, Indices, Forex, and Crypto."
}
]
},
{
"info": {
"name": "reference:tickers:types",
"type": "folder"
},
"items": [
{
"info": {
"name": "Ticker Types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/reference/tickers/types",
"params": [
{
"name": "asset_class",
"value": "",
"type": "query",
"description": "Filter by asset class."
},
{
"name": "locale",
"value": "",
"type": "query",
"description": "Filter by locale."
}
]
},
"docs": "List all ticker types that Massive has."
}
]
},
{
"info": {
"name": "reference:tickers:get",
"type": "folder"
},
"items": [
{
"info": {
"name": "Ticker Details v3",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/reference/tickers/:ticker",
"params": [
{
"name": "ticker",
"value": "AAPL",
"type": "path",
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc."
},
{
"name": "date",
"value": "",
"type": "query",
"description": "Specify a point in time to get information about the ticker available on that date.\nWhen retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing.\n\nFor example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29.\nThat means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29.\nIf you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing.\n\nDefaults to the most recent available date."
}
]
},
"docs": "Get a single ticker supported by Massive. This response will have detailed information about the ticker and the company behind it."
},
{
"info": {
"name": "Ticker Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/vX/reference/tickers/:id/events",
"params": [
{
"name": "id",
"value": "META",
"type": "path",
"description": "Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive \nticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently \nrepresented by that ticker are returned. To find events for entities previously associated with a \nticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://massive.com/docs/rest/stocks/tickers/ticker-overview)."
},
{
"name": "types",
"value": "",
"type": "query",
"description": "A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type.\nLeave blank to return all supported event_types."
}
]
},
"docs": "Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI."
}
]
},
{
"info": {
"name": "indices:snapshot",
"type": "folder"
},
"items": [
{
"info": {
"name": "Indices Snapshot",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/snapshot/indices",
"params": [
{
"name": "ticker.any_of",
"value": "I:DJI",
"type": "query",
"description": "Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack."
},
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Search a range of tickers lexicographically."
},
{
"name": "ticker.gte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.gt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lte",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "ticker.lt",
"value": "",
"type": "query",
"description": "Range by ticker."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 250."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get a Snapshot of indices data for said tickers"
}
]
},
{
"info": {
"name": "options:snapshot",
"type": "folder"
},
"items": [
{
"info": {
"name": "Options Chain",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/snapshot/options/:underlyingAsset",
"params": [
{
"name": "underlyingAsset",
"value": "EVRI",
"type": "path",
"description": "The underlying ticker symbol of the option contract."
},
{
"name": "strike_price",
"value": "",
"type": "query",
"description": "Query by strike price of a contract."
},
{
"name": "expiration_date",
"value": "",
"type": "query",
"description": "Query by contract expiration with date format YYYY-MM-DD."
},
{
"name": "contract_type",
"value": "",
"type": "query",
"description": "Query by the type of contract."
},
{
"name": "strike_price.gte",
"value": "",
"type": "query",
"description": "Range by strike_price."
},
{
"name": "strike_price.gt",
"value": "",
"type": "query",
"description": "Range by strike_price."
},
{
"name": "strike_price.lte",
"value": "",
"type": "query",
"description": "Range by strike_price."
},
{
"name": "strike_price.lt",
"value": "",
"type": "query",
"description": "Range by strike_price."
},
{
"name": "expiration_date.gte",
"value": "",
"type": "query",
"description": "Range by expiration_date."
},
{
"name": "expiration_date.gt",
"value": "",
"type": "query",
"description": "Range by expiration_date."
},
{
"name": "expiration_date.lte",
"value": "",
"type": "query",
"description": "Range by expiration_date."
},
{
"name": "expiration_date.lt",
"value": "",
"type": "query",
"description": "Range by expiration_date."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 250."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get the snapshot of all options contracts for an underlying ticker."
},
{
"info": {
"name": "Option Contract",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/snapshot/options/:underlyingAsset/:optionContract",
"params": [
{
"name": "underlyingAsset",
"value": "EVRI",
"type": "path",
"description": "The underlying ticker symbol of the option contract."
},
{
"name": "optionContract",
"value": "O:EVRI260116C00015000",
"type": "path",
"description": "The option contract identifier."
}
]
},
"docs": "Get the snapshot of an option contract for a stock equity."
}
]
},
{
"info": {
"name": "options:trades",
"type": "folder"
},
"items": [
{
"info": {
"name": "Trades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/v3/trades/:optionsTicker",
"params": [
{
"name": "optionsTicker",
"value": "O:TSLA210903C00700000",
"type": "path",
"description": "The options ticker symbol to get trades for."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp."
},
{
"name": "timestamp.gte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.gt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lte",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "timestamp.lt",
"value": "",
"type": "query",
"description": "Range by timestamp."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 1000 and max is 50000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "Get trades for an options ticker symbol in a given time range."
}
]
},
{
"info": {
"name": "reference:stocks:ipos",
"type": "folder"
},
"items": [
{
"info": {
"name": "IPOs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.polygon.io/vX/reference/ipos",
"params": [
{
"name": "ticker",
"value": "",
"type": "query",
"description": "Specify a case-sensitive ticker symbol. For example, TSLA represents Tesla Inc."
},
{
"name": "us_code",
"value": "",
"type": "query",
"description": "Specify a us_code. This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades."
},
{
"name": "isin",
"value": "",
"type": "query",
"description": "Specify an International Securities Identification Number (ISIN). This is a unique twelve-digit code that is assigned to every security issuance in the world."
},
{
"name": "listing_date",
"value": "",
"type": "query",
"description": "Specify a listing date. This is the first trading date for the newly listed entity."
},
{
"name": "ipo_status",
"value": "",
"type": "query",
"description": "Specify an IPO status."
},
{
"name": "listing_date.gte",
"value": "",
"type": "query",
"description": "Range by listing_date."
},
{
"name": "listing_date.gt",
"value": "",
"type": "query",
"description": "Range by listing_date."
},
{
"name": "listing_date.lte",
"value": "",
"type": "query",
"description": "Range by listing_date."
},
{
"name": "listing_date.lt",
"value": "",
"type": "query",
"description": "Range by listing_date."
},
{
"name": "order",
"value": "",
"type": "query",
"description": "Order results based on the `sort` field."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of results returned, default is 10 and max is 1000."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort field used for ordering."
}
]
},
"docs": "The IPOs API provides access to detailed information about Initial Public Offerings (IPOs), including both upcoming and historical events. With this API, you can query for a comprehensive list of IPOs, along with key details such as the issuer name, ticker symbol, ISIN, IPO date, number of shares offered, expected price range, and final offering price. You can filter the results by status to focus on new, rumors, pending, historical, and more."
}
]
}
],
"bundled": true
}