Finance — entry 034 of 47
Massive
Polygon.io rebranded to Massive on 2025-10-30 (existing API keys, accounts, and the api.polygon.io endpoints all continue to work unchanged during the transition). It's a low-latency market-data API for US stocks, options, forex, and crypto, offering realtime and historical tick-level aggregates, trades, and quotes over REST and WebSocket in JSON or CSV. The free Basic tier allows 5 calls/minute with delayed/limited history; paid plans run roughly $29–$199+/month for realtime data and deeper history.
GreatAPIs Score
Auth quickstart
- Sign up with the provider to get an API key.
- Send it on every request as a header
Authorization: <key> - The exact header isn't documented — Authorization is a common default; confirm in the provider's docs.
Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.
Endpoints
reference14
Reference API
GET/stocks/filings/10-K/vX/sections
| Name | In | Required | Type |
|---|---|---|---|
cik | query | no | string |
cik.any_of | query | no | string |
cik.gt | query | no | string |
cik.gte | query | no | string |
cik.lt | query | no | string |
cik.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
section | query | no | string |
section.any_of | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
period_end | query | no | string |
period_end.gt | query | no | string |
period_end.gte | query | no | string |
period_end.lt | query | no | string |
period_end.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/filings/10-K/vX_0/sections
| Name | In | Required | Type |
|---|---|---|---|
cik | query | no | string |
cik.any_of | query | no | string |
cik.gt | query | no | string |
cik.gte | query | no | string |
cik.lt | query | no | string |
cik.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
section | query | no | string |
section.any_of | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
period_end | query | no | string |
period_end.gt | query | no | string |
period_end.gte | query | no | string |
period_end.lt | query | no | string |
period_end.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/filings/8-K/vX/disclosures
| Name | In | Required | Type |
|---|---|---|---|
cik | query | no | string |
cik.any_of | query | no | string |
tickers | query | no | string |
tickers.all_of | query | no | string |
tickers.any_of | query | no | string |
filing_date | query | no | string |
filing_date.any_of | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
tertiary_category | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/filings/8-K/vX/text
| Name | In | Required | Type |
|---|---|---|---|
cik | query | no | string |
cik.any_of | query | no | string |
cik.gt | query | no | string |
cik.gte | query | no | string |
cik.lt | query | no | string |
cik.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
form_type | query | no | string |
form_type.any_of | query | no | string |
form_type.gt | query | no | string |
form_type.gte | query | no | string |
form_type.lt | query | no | string |
form_type.lte | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/filings/vX/13-F
| Name | In | Required | Type |
|---|---|---|---|
filer_cik | query | no | string |
filer_cik.any_of | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/filings/vX/form-3
| Name | In | Required | Type |
|---|---|---|---|
issuer_cik | query | no | string |
issuer_cik.any_of | query | no | string |
owner_cik | query | no | string |
owner_cik.any_of | query | no | string |
tickers | query | no | string |
tickers.all_of | query | no | string |
tickers.any_of | query | no | string |
form_type | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/filings/vX/form-4
| Name | In | Required | Type |
|---|---|---|---|
issuer_cik | query | no | string |
issuer_cik.any_of | query | no | string |
owner_cik | query | no | string |
owner_cik.any_of | query | no | string |
tickers | query | no | string |
tickers.all_of | query | no | string |
tickers.any_of | query | no | string |
form_type | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
transaction_code | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/filings/vX/index
| Name | In | Required | Type |
|---|---|---|---|
cik | query | no | string |
cik.any_of | query | no | string |
cik.gt | query | no | string |
cik.gte | query | no | string |
cik.lt | query | no | string |
cik.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
form_type | query | no | string |
form_type.any_of | query | no | string |
form_type.gt | query | no | string |
form_type.gte | query | no | string |
form_type.lt | query | no | string |
form_type.lte | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/filings/vX/risk-factors
| Name | In | Required | Type |
|---|---|---|---|
filing_date | query | no | string |
filing_date.any_of | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
cik | query | no | string |
cik.any_of | query | no | string |
cik.gt | query | no | string |
cik.gte | query | no | string |
cik.lt | query | no | string |
cik.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/taxonomies/vX/disclosures
| Name | In | Required | Type |
|---|---|---|---|
taxonomy | query | no | string |
taxonomy.any_of | query | no | string |
taxonomy.gt | query | no | string |
taxonomy.gte | query | no | string |
taxonomy.lt | query | no | string |
taxonomy.lte | query | no | string |
primary_category | query | no | string |
primary_category.any_of | query | no | string |
primary_category.gt | query | no | string |
primary_category.gte | query | no | string |
primary_category.lt | query | no | string |
primary_category.lte | query | no | string |
secondary_category | query | no | string |
secondary_category.any_of | query | no | string |
secondary_category.gt | query | no | string |
secondary_category.gte | query | no | string |
secondary_category.lt | query | no | string |
secondary_category.lte | query | no | string |
tertiary_category | query | no | string |
tertiary_category.any_of | query | no | string |
tertiary_category.gt | query | no | string |
tertiary_category.gte | query | no | string |
tertiary_category.lt | query | no | string |
tertiary_category.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/taxonomies/vX/risk-factors
| Name | In | Required | Type |
|---|---|---|---|
taxonomy | query | no | number |
taxonomy.gt | query | no | number |
taxonomy.gte | query | no | number |
taxonomy.lt | query | no | number |
taxonomy.lte | query | no | number |
primary_category | query | no | string |
primary_category.any_of | query | no | string |
primary_category.gt | query | no | string |
primary_category.gte | query | no | string |
primary_category.lt | query | no | string |
primary_category.lte | query | no | string |
secondary_category | query | no | string |
secondary_category.any_of | query | no | string |
secondary_category.gt | query | no | string |
secondary_category.gte | query | no | string |
secondary_category.lt | query | no | string |
secondary_category.lte | query | no | string |
tertiary_category | query | no | string |
tertiary_category.any_of | query | no | string |
tertiary_category.gt | query | no | string |
tertiary_category.gte | query | no | string |
tertiary_category.lt | query | no | string |
tertiary_category.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/v1/short-interest
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
days_to_cover | query | no | number |
days_to_cover.any_of | query | no | string |
days_to_cover.gt | query | no | number |
days_to_cover.gte | query | no | number |
days_to_cover.lt | query | no | number |
days_to_cover.lte | query | no | number |
settlement_date | query | no | string |
settlement_date.any_of | query | no | string |
settlement_date.gt | query | no | string |
settlement_date.gte | query | no | string |
settlement_date.lt | query | no | string |
settlement_date.lte | query | no | string |
avg_daily_volume | query | no | integer |
avg_daily_volume.any_of | query | no | string |
avg_daily_volume.gt | query | no | integer |
avg_daily_volume.gte | query | no | integer |
avg_daily_volume.lt | query | no | integer |
avg_daily_volume.lte | query | no | integer |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/v1/short-volume
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
short_volume_ratio | query | no | number |
short_volume_ratio.any_of | query | no | string |
short_volume_ratio.gt | query | no | number |
short_volume_ratio.gte | query | no | number |
short_volume_ratio.lt | query | no | number |
short_volume_ratio.lte | query | no | number |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/vX/float
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
free_float_percent | query | no | number |
free_float_percent.gt | query | no | number |
free_float_percent.gte | query | no | number |
free_float_percent.lt | query | no | number |
free_float_percent.lte | query | no | number |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
benzinga9
GET/benzinga/v1/analyst-insights
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
last_updated | query | no | string |
last_updated.gt | query | no | string |
last_updated.gte | query | no | string |
last_updated.lt | query | no | string |
last_updated.lte | query | no | string |
firm | query | no | string |
firm.any_of | query | no | string |
firm.gt | query | no | string |
firm.gte | query | no | string |
firm.lt | query | no | string |
firm.lte | query | no | string |
rating_action | query | no | string |
rating_action.any_of | query | no | string |
rating_action.gt | query | no | string |
rating_action.gte | query | no | string |
rating_action.lt | query | no | string |
rating_action.lte | query | no | string |
benzinga_firm_id | query | no | string |
benzinga_firm_id.any_of | query | no | string |
benzinga_firm_id.gt | query | no | string |
benzinga_firm_id.gte | query | no | string |
benzinga_firm_id.lt | query | no | string |
benzinga_firm_id.lte | query | no | string |
benzinga_rating_id | query | no | string |
benzinga_rating_id.any_of | query | no | string |
benzinga_rating_id.gt | query | no | string |
benzinga_rating_id.gte | query | no | string |
benzinga_rating_id.lt | query | no | string |
benzinga_rating_id.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/benzinga/v1/analysts
| Name | In | Required | Type |
|---|---|---|---|
benzinga_id | query | no | string |
benzinga_id.any_of | query | no | string |
benzinga_id.gt | query | no | string |
benzinga_id.gte | query | no | string |
benzinga_id.lt | query | no | string |
benzinga_id.lte | query | no | string |
benzinga_firm_id | query | no | string |
benzinga_firm_id.any_of | query | no | string |
benzinga_firm_id.gt | query | no | string |
benzinga_firm_id.gte | query | no | string |
benzinga_firm_id.lt | query | no | string |
benzinga_firm_id.lte | query | no | string |
firm_name | query | no | string |
firm_name.any_of | query | no | string |
firm_name.gt | query | no | string |
firm_name.gte | query | no | string |
firm_name.lt | query | no | string |
firm_name.lte | query | no | string |
full_name | query | no | string |
full_name.any_of | query | no | string |
full_name.gt | query | no | string |
full_name.gte | query | no | string |
full_name.lt | query | no | string |
full_name.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/benzinga/v1/bulls-bears-say
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
benzinga_id | query | no | string |
benzinga_id.any_of | query | no | string |
benzinga_id.gt | query | no | string |
benzinga_id.gte | query | no | string |
benzinga_id.lt | query | no | string |
benzinga_id.lte | query | no | string |
last_updated | query | no | string |
last_updated.gt | query | no | string |
last_updated.gte | query | no | string |
last_updated.lt | query | no | string |
last_updated.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/benzinga/v1/consensus-ratings/{ticker}
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
limit | query | no | integer |
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/benzinga/v1/earnings
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
importance | query | no | integer |
importance.any_of | query | no | string |
importance.gt | query | no | integer |
importance.gte | query | no | integer |
importance.lt | query | no | integer |
importance.lte | query | no | integer |
last_updated | query | no | string |
last_updated.any_of | query | no | string |
last_updated.gt | query | no | string |
last_updated.gte | query | no | string |
last_updated.lt | query | no | string |
last_updated.lte | query | no | string |
date_status | query | no | string |
date_status.any_of | query | no | string |
date_status.gt | query | no | string |
date_status.gte | query | no | string |
date_status.lt | query | no | string |
date_status.lte | query | no | string |
eps_surprise_percent | query | no | number |
eps_surprise_percent.any_of | query | no | string |
eps_surprise_percent.gt | query | no | number |
eps_surprise_percent.gte | query | no | number |
eps_surprise_percent.lt | query | no | number |
eps_surprise_percent.lte | query | no | number |
revenue_surprise_percent | query | no | number |
revenue_surprise_percent.any_of | query | no | string |
revenue_surprise_percent.gt | query | no | number |
revenue_surprise_percent.gte | query | no | number |
revenue_surprise_percent.lt | query | no | number |
revenue_surprise_percent.lte | query | no | number |
fiscal_year | query | no | integer |
fiscal_year.any_of | query | no | string |
fiscal_year.gt | query | no | integer |
fiscal_year.gte | query | no | integer |
fiscal_year.lt | query | no | integer |
fiscal_year.lte | query | no | integer |
fiscal_period | query | no | string |
fiscal_period.any_of | query | no | string |
fiscal_period.gt | query | no | string |
fiscal_period.gte | query | no | string |
fiscal_period.lt | query | no | string |
fiscal_period.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/benzinga/v1/firms
| Name | In | Required | Type |
|---|---|---|---|
benzinga_id | query | no | string |
benzinga_id.any_of | query | no | string |
benzinga_id.gt | query | no | string |
benzinga_id.gte | query | no | string |
benzinga_id.lt | query | no | string |
benzinga_id.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/benzinga/v1/guidance
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
positioning | query | no | string |
positioning.any_of | query | no | string |
positioning.gt | query | no | string |
positioning.gte | query | no | string |
positioning.lt | query | no | string |
positioning.lte | query | no | string |
importance | query | no | integer |
importance.any_of | query | no | string |
importance.gt | query | no | integer |
importance.gte | query | no | integer |
importance.lt | query | no | integer |
importance.lte | query | no | integer |
last_updated | query | no | string |
last_updated.any_of | query | no | string |
last_updated.gt | query | no | string |
last_updated.gte | query | no | string |
last_updated.lt | query | no | string |
last_updated.lte | query | no | string |
fiscal_year | query | no | integer |
fiscal_year.any_of | query | no | string |
fiscal_year.gt | query | no | integer |
fiscal_year.gte | query | no | integer |
fiscal_year.lt | query | no | integer |
fiscal_year.lte | query | no | integer |
fiscal_period | query | no | string |
fiscal_period.any_of | query | no | string |
fiscal_period.gt | query | no | string |
fiscal_period.gte | query | no | string |
fiscal_period.lt | query | no | string |
fiscal_period.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/benzinga/v1/ratings
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
importance | query | no | integer |
importance.gt | query | no | integer |
importance.gte | query | no | integer |
importance.lt | query | no | integer |
importance.lte | query | no | integer |
last_updated | query | no | string |
last_updated.gt | query | no | string |
last_updated.gte | query | no | string |
last_updated.lt | query | no | string |
last_updated.lte | query | no | string |
rating_action | query | no | string |
rating_action.any_of | query | no | string |
rating_action.gt | query | no | string |
rating_action.gte | query | no | string |
rating_action.lt | query | no | string |
rating_action.lte | query | no | string |
price_target_action | query | no | string |
price_target_action.any_of | query | no | string |
price_target_action.gt | query | no | string |
price_target_action.gte | query | no | string |
price_target_action.lt | query | no | string |
price_target_action.lte | query | no | string |
benzinga_id | query | no | string |
benzinga_id.any_of | query | no | string |
benzinga_id.gt | query | no | string |
benzinga_id.gte | query | no | string |
benzinga_id.lt | query | no | string |
benzinga_id.lte | query | no | string |
benzinga_analyst_id | query | no | string |
benzinga_analyst_id.any_of | query | no | string |
benzinga_analyst_id.gt | query | no | string |
benzinga_analyst_id.gte | query | no | string |
benzinga_analyst_id.lt | query | no | string |
benzinga_analyst_id.lte | query | no | string |
benzinga_firm_id | query | no | string |
benzinga_firm_id.any_of | query | no | string |
benzinga_firm_id.gt | query | no | string |
benzinga_firm_id.gte | query | no | string |
benzinga_firm_id.lt | query | no | string |
benzinga_firm_id.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/benzinga/v2/news
| Name | In | Required | Type |
|---|---|---|---|
published | query | no | string |
published.gt | query | no | string |
published.gte | query | no | string |
published.lt | query | no | string |
published.lte | query | no | string |
channels | query | no | string |
channels.all_of | query | no | string |
channels.any_of | query | no | string |
tags | query | no | string |
tags.all_of | query | no | string |
tags.any_of | query | no | string |
author | query | no | string |
author.any_of | query | no | string |
author.gt | query | no | string |
author.gte | query | no | string |
author.lt | query | no | string |
author.lte | query | no | string |
stocks | query | no | string |
stocks.all_of | query | no | string |
stocks.any_of | query | no | string |
tickers | query | no | string |
tickers.all_of | query | no | string |
tickers.any_of | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
crypto:aggregates7
GET/v1/indicators/ema/{cryptoTicker}Exponential Moving Average (EMA)
| Name | In | Required | Type |
|---|---|---|---|
cryptoTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Exponential Moving Average (EMA) data for each period. | — |
GET/v1/indicators/macd/{cryptoTicker}Moving Average Convergence/Divergence (MACD)
| Name | In | Required | Type |
|---|---|---|---|
cryptoTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
short_window | query | no | integer |
long_window | query | no | integer |
signal_window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Moving Average Convergence/Divergence (MACD) data for each period. | — |
GET/v1/indicators/rsi/{cryptoTicker}Relative Strength Index (RSI)
| Name | In | Required | Type |
|---|---|---|---|
cryptoTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Relative strength index data for each period. | — |
GET/v1/indicators/sma/{cryptoTicker}Simple Moving Average (SMA)
| Name | In | Required | Type |
|---|---|---|---|
cryptoTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Simple Moving Average (SMA) data for each period. | — |
GET/v2/aggs/grouped/locale/global/market/crypto/{date}Grouped Daily (Bars)
| Name | In | Required | Type |
|---|---|---|---|
date | path | yes | string |
adjusted | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | The previous day OHLC for the ticker. | — |
default | Unexpected error | — |
GET/v2/aggs/ticker/{cryptoTicker}/prevPrevious Close
| Name | In | Required | Type |
|---|---|---|---|
cryptoTicker | path | yes | string |
adjusted | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | The previous day OHLC for a ticker. | — |
default | Unexpected error | — |
GET/v2/aggs/ticker/{cryptoTicker}/range/{multiplier}/{timespan}/{from}/{to}Aggregates (Bars)
| Name | In | Required | Type |
|---|---|---|---|
cryptoTicker | path | yes | string |
multiplier | path | yes | integer |
timespan | path | yes | string |
from | path | yes | string |
to | path | yes | string |
adjusted | query | no | boolean |
sort | query | no | — |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Cryptocurrency Aggregates. | — |
default | Unexpected error | — |
crypto:last:trade1
GET/v1/last/crypto/{from}/{to}Last Trade for a Crypto Pair
| Name | In | Required | Type |
|---|---|---|---|
from | path | yes | string |
to | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | The last tick for this currency pair. | — |
default | Unexpected error | — |
crypto:open-close1
GET/v1/open-close/crypto/{from}/{to}/{date}Daily Open/Close
| Name | In | Required | Type |
|---|---|---|---|
from | path | yes | string |
to | path | yes | string |
date | path | yes | string |
adjusted | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | The open/close of this symbol. | — |
default | Unexpected error | — |
crypto:snapshot4
GET/v2/snapshot/locale/global/markets/crypto/tickersAll Tickers
| Name | In | Required | Type |
|---|---|---|---|
tickers | query | no | array |
| Status | Description | Schema |
|---|---|---|
200 | Get current state for all tickers | — |
default | Unexpected error | — |
GET/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}Ticker
| Name | In | Required | Type |
|---|---|---|---|
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Get current state for a ticker | — |
default | Unexpected error | — |
GET/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/bookTicker Full Book (L2)
| Name | In | Required | Type |
|---|---|---|---|
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Get current level 2 book for a ticker | — |
default | Unexpected error | — |
GET/v2/snapshot/locale/global/markets/crypto/{direction}Gainers/Losers
| Name | In | Required | Type |
|---|---|---|---|
direction | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Get the current gainers / losers of the day | — |
default | Unexpected error | — |
crypto:trades2
GET/v1/historic/crypto/{from}/{to}/{date}Historic Crypto Trades
| Name | In | Required | Type |
|---|---|---|---|
from | path | yes | string |
to | path | yes | string |
date | path | yes | string |
offset | query | no | integer |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | An array of crypto trade ticks. | — |
default | Unexpected error | — |
GET/v3/trades/{cryptoTicker}Trades
| Name | In | Required | Type |
|---|---|---|---|
cryptoTicker | path | yes | string |
timestamp | query | no | string |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of trades. | — |
etfglobal5
GET/etf-global/v1/analytics
| Name | In | Required | Type |
|---|---|---|---|
composite_ticker | query | no | string |
composite_ticker.any_of | query | no | string |
composite_ticker.gt | query | no | string |
composite_ticker.gte | query | no | string |
composite_ticker.lt | query | no | string |
composite_ticker.lte | query | no | string |
processed_date | query | no | string |
processed_date.gt | query | no | string |
processed_date.gte | query | no | string |
processed_date.lt | query | no | string |
processed_date.lte | query | no | string |
effective_date | query | no | string |
effective_date.gt | query | no | string |
effective_date.gte | query | no | string |
effective_date.lt | query | no | string |
effective_date.lte | query | no | string |
risk_total_score | query | no | number |
risk_total_score.gt | query | no | number |
risk_total_score.gte | query | no | number |
risk_total_score.lt | query | no | number |
risk_total_score.lte | query | no | number |
reward_score | query | no | number |
reward_score.gt | query | no | number |
reward_score.gte | query | no | number |
reward_score.lt | query | no | number |
reward_score.lte | query | no | number |
quant_total_score | query | no | number |
quant_total_score.gt | query | no | number |
quant_total_score.gte | query | no | number |
quant_total_score.lt | query | no | number |
quant_total_score.lte | query | no | number |
quant_grade | query | no | string |
quant_grade.any_of | query | no | string |
quant_grade.gt | query | no | string |
quant_grade.gte | query | no | string |
quant_grade.lt | query | no | string |
quant_grade.lte | query | no | string |
quant_composite_technical | query | no | number |
quant_composite_technical.gt | query | no | number |
quant_composite_technical.gte | query | no | number |
quant_composite_technical.lt | query | no | number |
quant_composite_technical.lte | query | no | number |
quant_composite_sentiment | query | no | number |
quant_composite_sentiment.gt | query | no | number |
quant_composite_sentiment.gte | query | no | number |
quant_composite_sentiment.lt | query | no | number |
quant_composite_sentiment.lte | query | no | number |
quant_composite_behavioral | query | no | number |
quant_composite_behavioral.gt | query | no | number |
quant_composite_behavioral.gte | query | no | number |
quant_composite_behavioral.lt | query | no | number |
quant_composite_behavioral.lte | query | no | number |
quant_composite_fundamental | query | no | number |
quant_composite_fundamental.gt | query | no | number |
quant_composite_fundamental.gte | query | no | number |
quant_composite_fundamental.lt | query | no | number |
quant_composite_fundamental.lte | query | no | number |
quant_composite_global | query | no | number |
quant_composite_global.gt | query | no | number |
quant_composite_global.gte | query | no | number |
quant_composite_global.lt | query | no | number |
quant_composite_global.lte | query | no | number |
quant_composite_quality | query | no | number |
quant_composite_quality.gt | query | no | number |
quant_composite_quality.gte | query | no | number |
quant_composite_quality.lt | query | no | number |
quant_composite_quality.lte | query | no | number |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/etf-global/v1/constituents
| Name | In | Required | Type |
|---|---|---|---|
composite_ticker | query | no | string |
composite_ticker.any_of | query | no | string |
composite_ticker.gt | query | no | string |
composite_ticker.gte | query | no | string |
composite_ticker.lt | query | no | string |
composite_ticker.lte | query | no | string |
constituent_ticker | query | no | string |
constituent_ticker.any_of | query | no | string |
constituent_ticker.gt | query | no | string |
constituent_ticker.gte | query | no | string |
constituent_ticker.lt | query | no | string |
constituent_ticker.lte | query | no | string |
effective_date | query | no | string |
effective_date.gt | query | no | string |
effective_date.gte | query | no | string |
effective_date.lt | query | no | string |
effective_date.lte | query | no | string |
processed_date | query | no | string |
processed_date.gt | query | no | string |
processed_date.gte | query | no | string |
processed_date.lt | query | no | string |
processed_date.lte | query | no | string |
us_code | query | no | string |
us_code.any_of | query | no | string |
us_code.gt | query | no | string |
us_code.gte | query | no | string |
us_code.lt | query | no | string |
us_code.lte | query | no | string |
isin | query | no | string |
isin.any_of | query | no | string |
isin.gt | query | no | string |
isin.gte | query | no | string |
isin.lt | query | no | string |
isin.lte | query | no | string |
figi | query | no | string |
figi.any_of | query | no | string |
figi.gt | query | no | string |
figi.gte | query | no | string |
figi.lt | query | no | string |
figi.lte | query | no | string |
sedol | query | no | string |
sedol.any_of | query | no | string |
sedol.gt | query | no | string |
sedol.gte | query | no | string |
sedol.lt | query | no | string |
sedol.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/etf-global/v1/fund-flows
| Name | In | Required | Type |
|---|---|---|---|
processed_date | query | no | string |
processed_date.gt | query | no | string |
processed_date.gte | query | no | string |
processed_date.lt | query | no | string |
processed_date.lte | query | no | string |
effective_date | query | no | string |
effective_date.gt | query | no | string |
effective_date.gte | query | no | string |
effective_date.lt | query | no | string |
effective_date.lte | query | no | string |
composite_ticker | query | no | string |
composite_ticker.any_of | query | no | string |
composite_ticker.gt | query | no | string |
composite_ticker.gte | query | no | string |
composite_ticker.lt | query | no | string |
composite_ticker.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/etf-global/v1/profiles
| Name | In | Required | Type |
|---|---|---|---|
processed_date | query | no | string |
processed_date.gt | query | no | string |
processed_date.gte | query | no | string |
processed_date.lt | query | no | string |
processed_date.lte | query | no | string |
effective_date | query | no | string |
effective_date.gt | query | no | string |
effective_date.gte | query | no | string |
effective_date.lt | query | no | string |
effective_date.lte | query | no | string |
composite_ticker | query | no | string |
composite_ticker.any_of | query | no | string |
composite_ticker.gt | query | no | string |
composite_ticker.gte | query | no | string |
composite_ticker.lt | query | no | string |
composite_ticker.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/etf-global/v1/taxonomies
| Name | In | Required | Type |
|---|---|---|---|
processed_date | query | no | string |
processed_date.gt | query | no | string |
processed_date.gte | query | no | string |
processed_date.lt | query | no | string |
processed_date.lte | query | no | string |
effective_date | query | no | string |
effective_date.gt | query | no | string |
effective_date.gte | query | no | string |
effective_date.lt | query | no | string |
effective_date.lte | query | no | string |
composite_ticker | query | no | string |
composite_ticker.any_of | query | no | string |
composite_ticker.gt | query | no | string |
composite_ticker.gte | query | no | string |
composite_ticker.lt | query | no | string |
composite_ticker.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
fable2
GET/consumer-spending/eu/v1/merchant-aggregates
| Name | In | Required | Type |
|---|---|---|---|
transaction_date | query | no | string |
transaction_date.gt | query | no | string |
transaction_date.gte | query | no | string |
transaction_date.lt | query | no | string |
transaction_date.lte | query | no | string |
name | query | no | string |
name.any_of | query | no | string |
name.gt | query | no | string |
name.gte | query | no | string |
name.lt | query | no | string |
name.lte | query | no | string |
user_country | query | no | string |
user_country.any_of | query | no | string |
channel | query | no | string |
channel.any_of | query | no | string |
consumer_type | query | no | string |
consumer_type.any_of | query | no | string |
parent_name | query | no | string |
parent_name.any_of | query | no | string |
parent_name.gt | query | no | string |
parent_name.gte | query | no | string |
parent_name.lt | query | no | string |
parent_name.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/consumer-spending/eu/v1/merchant-hierarchy
| Name | In | Required | Type |
|---|---|---|---|
lookup_name | query | no | string |
lookup_name.any_of | query | no | string |
lookup_name.gt | query | no | string |
lookup_name.gte | query | no | string |
lookup_name.lt | query | no | string |
lookup_name.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
listing_status | query | no | string |
listing_status.any_of | query | no | string |
active_from | query | no | string |
active_from.gt | query | no | string |
active_from.gte | query | no | string |
active_from.lt | query | no | string |
active_from.lte | query | no | string |
active_to | query | no | string |
active_to.gt | query | no | string |
active_to.gte | query | no | string |
active_to.lt | query | no | string |
active_to.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
fed4
GET/fed/v1/inflation
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/fed/v1/inflation-expectations
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/fed/v1/labor-market
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/fed/v1/treasury-yields
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
financials4
GET/stocks/financials/v1/balance-sheets
| Name | In | Required | Type |
|---|---|---|---|
cik | query | no | string |
cik.any_of | query | no | string |
cik.gt | query | no | string |
cik.gte | query | no | string |
cik.lt | query | no | string |
cik.lte | query | no | string |
tickers | query | no | string |
tickers.all_of | query | no | string |
tickers.any_of | query | no | string |
period_end | query | no | string |
period_end.gt | query | no | string |
period_end.gte | query | no | string |
period_end.lt | query | no | string |
period_end.lte | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
fiscal_year | query | no | number |
fiscal_year.gt | query | no | number |
fiscal_year.gte | query | no | number |
fiscal_year.lt | query | no | number |
fiscal_year.lte | query | no | number |
fiscal_quarter | query | no | number |
fiscal_quarter.gt | query | no | number |
fiscal_quarter.gte | query | no | number |
fiscal_quarter.lt | query | no | number |
fiscal_quarter.lte | query | no | number |
timeframe | query | no | string |
timeframe.any_of | query | no | string |
timeframe.gt | query | no | string |
timeframe.gte | query | no | string |
timeframe.lt | query | no | string |
timeframe.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/financials/v1/cash-flow-statements
| Name | In | Required | Type |
|---|---|---|---|
cik | query | no | string |
cik.any_of | query | no | string |
cik.gt | query | no | string |
cik.gte | query | no | string |
cik.lt | query | no | string |
cik.lte | query | no | string |
period_end | query | no | string |
period_end.gt | query | no | string |
period_end.gte | query | no | string |
period_end.lt | query | no | string |
period_end.lte | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
tickers | query | no | string |
tickers.all_of | query | no | string |
tickers.any_of | query | no | string |
fiscal_year | query | no | number |
fiscal_year.gt | query | no | number |
fiscal_year.gte | query | no | number |
fiscal_year.lt | query | no | number |
fiscal_year.lte | query | no | number |
fiscal_quarter | query | no | number |
fiscal_quarter.gt | query | no | number |
fiscal_quarter.gte | query | no | number |
fiscal_quarter.lt | query | no | number |
fiscal_quarter.lte | query | no | number |
timeframe | query | no | string |
timeframe.any_of | query | no | string |
timeframe.gt | query | no | string |
timeframe.gte | query | no | string |
timeframe.lt | query | no | string |
timeframe.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/financials/v1/income-statements
| Name | In | Required | Type |
|---|---|---|---|
cik | query | no | string |
cik.any_of | query | no | string |
cik.gt | query | no | string |
cik.gte | query | no | string |
cik.lt | query | no | string |
cik.lte | query | no | string |
tickers | query | no | string |
tickers.all_of | query | no | string |
tickers.any_of | query | no | string |
period_end | query | no | string |
period_end.gt | query | no | string |
period_end.gte | query | no | string |
period_end.lt | query | no | string |
period_end.lte | query | no | string |
filing_date | query | no | string |
filing_date.gt | query | no | string |
filing_date.gte | query | no | string |
filing_date.lt | query | no | string |
filing_date.lte | query | no | string |
fiscal_year | query | no | number |
fiscal_year.gt | query | no | number |
fiscal_year.gte | query | no | number |
fiscal_year.lt | query | no | number |
fiscal_year.lte | query | no | number |
fiscal_quarter | query | no | number |
fiscal_quarter.gt | query | no | number |
fiscal_quarter.gte | query | no | number |
fiscal_quarter.lt | query | no | number |
fiscal_quarter.lte | query | no | number |
timeframe | query | no | string |
timeframe.any_of | query | no | string |
timeframe.gt | query | no | string |
timeframe.gte | query | no | string |
timeframe.lt | query | no | string |
timeframe.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/financials/v1/ratios
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
cik | query | no | string |
cik.any_of | query | no | string |
cik.gt | query | no | string |
cik.gte | query | no | string |
cik.lt | query | no | string |
cik.lte | query | no | string |
price | query | no | number |
price.gt | query | no | number |
price.gte | query | no | number |
price.lt | query | no | number |
price.lte | query | no | number |
average_volume | query | no | number |
average_volume.gt | query | no | number |
average_volume.gte | query | no | number |
average_volume.lt | query | no | number |
average_volume.lte | query | no | number |
market_cap | query | no | number |
market_cap.gt | query | no | number |
market_cap.gte | query | no | number |
market_cap.lt | query | no | number |
market_cap.lte | query | no | number |
earnings_per_share | query | no | number |
earnings_per_share.gt | query | no | number |
earnings_per_share.gte | query | no | number |
earnings_per_share.lt | query | no | number |
earnings_per_share.lte | query | no | number |
price_to_earnings | query | no | number |
price_to_earnings.gt | query | no | number |
price_to_earnings.gte | query | no | number |
price_to_earnings.lt | query | no | number |
price_to_earnings.lte | query | no | number |
price_to_book | query | no | number |
price_to_book.gt | query | no | number |
price_to_book.gte | query | no | number |
price_to_book.lt | query | no | number |
price_to_book.lte | query | no | number |
price_to_sales | query | no | number |
price_to_sales.gt | query | no | number |
price_to_sales.gte | query | no | number |
price_to_sales.lt | query | no | number |
price_to_sales.lte | query | no | number |
price_to_cash_flow | query | no | number |
price_to_cash_flow.gt | query | no | number |
price_to_cash_flow.gte | query | no | number |
price_to_cash_flow.lt | query | no | number |
price_to_cash_flow.lte | query | no | number |
price_to_free_cash_flow | query | no | number |
price_to_free_cash_flow.gt | query | no | number |
price_to_free_cash_flow.gte | query | no | number |
price_to_free_cash_flow.lt | query | no | number |
price_to_free_cash_flow.lte | query | no | number |
dividend_yield | query | no | number |
dividend_yield.gt | query | no | number |
dividend_yield.gte | query | no | number |
dividend_yield.lt | query | no | number |
dividend_yield.lte | query | no | number |
return_on_assets | query | no | number |
return_on_assets.gt | query | no | number |
return_on_assets.gte | query | no | number |
return_on_assets.lt | query | no | number |
return_on_assets.lte | query | no | number |
return_on_equity | query | no | number |
return_on_equity.gt | query | no | number |
return_on_equity.gte | query | no | number |
return_on_equity.lt | query | no | number |
return_on_equity.lte | query | no | number |
debt_to_equity | query | no | number |
debt_to_equity.gt | query | no | number |
debt_to_equity.gte | query | no | number |
debt_to_equity.lt | query | no | number |
debt_to_equity.lte | query | no | number |
current | query | no | number |
current.gt | query | no | number |
current.gte | query | no | number |
current.lt | query | no | number |
current.lte | query | no | number |
quick | query | no | number |
quick.gt | query | no | number |
quick.gte | query | no | number |
quick.lt | query | no | number |
quick.lte | query | no | number |
cash | query | no | number |
cash.gt | query | no | number |
cash.gte | query | no | number |
cash.lt | query | no | number |
cash.lte | query | no | number |
ev_to_sales | query | no | number |
ev_to_sales.gt | query | no | number |
ev_to_sales.gte | query | no | number |
ev_to_sales.lt | query | no | number |
ev_to_sales.lte | query | no | number |
ev_to_ebitda | query | no | number |
ev_to_ebitda.gt | query | no | number |
ev_to_ebitda.gte | query | no | number |
ev_to_ebitda.lt | query | no | number |
ev_to_ebitda.lte | query | no | number |
enterprise_value | query | no | number |
enterprise_value.gt | query | no | number |
enterprise_value.gte | query | no | number |
enterprise_value.lt | query | no | number |
enterprise_value.lte | query | no | number |
free_cash_flow | query | no | number |
free_cash_flow.gt | query | no | number |
free_cash_flow.gte | query | no | number |
free_cash_flow.lt | query | no | number |
free_cash_flow.lte | query | no | number |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
futures:aggregates1
GET/futures/v1/aggs/{ticker}Aggregates
| Name | In | Required | Type |
|---|---|---|---|
ticker | path | yes | string |
resolution | query | no | string |
window_start | query | no | string |
limit | query | no | integer |
window_start.gte | query | no | string |
window_start.gt | query | no | string |
window_start.lte | query | no | string |
window_start.lt | query | no | string |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of aggregates. | — |
fx:aggregates7
GET/v1/indicators/ema/{fxTicker}Exponential Moving Average (EMA)
| Name | In | Required | Type |
|---|---|---|---|
fxTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Exponential Moving Average (EMA) data for each period. | — |
GET/v1/indicators/macd/{fxTicker}Moving Average Convergence/Divergence (MACD)
| Name | In | Required | Type |
|---|---|---|---|
fxTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
short_window | query | no | integer |
long_window | query | no | integer |
signal_window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Moving Average Convergence/Divergence (MACD) data for each period. | — |
GET/v1/indicators/rsi/{fxTicker}Relative Strength Index (RSI)
| Name | In | Required | Type |
|---|---|---|---|
fxTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Relative strength index data for each period. | — |
GET/v1/indicators/sma/{fxTicker}Simple Moving Average (SMA)
| Name | In | Required | Type |
|---|---|---|---|
fxTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Simple Moving Average (SMA) data for each period. | — |
GET/v2/aggs/grouped/locale/global/market/fx/{date}Grouped Daily (Bars)
| Name | In | Required | Type |
|---|---|---|---|
date | path | yes | string |
adjusted | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | Previous day OHLC for ticker | — |
default | Unexpected error | — |
GET/v2/aggs/ticker/{forexTicker}/prevPrevious Close
| Name | In | Required | Type |
|---|---|---|---|
forexTicker | path | yes | string |
adjusted | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | The previous day OHLC for the ticker. | — |
default | Unexpected error | — |
GET/v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}Aggregates (Bars)
| Name | In | Required | Type |
|---|---|---|---|
forexTicker | path | yes | string |
multiplier | path | yes | integer |
timespan | path | yes | string |
from | path | yes | string |
to | path | yes | string |
adjusted | query | no | boolean |
sort | query | no | — |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Forex Aggregates. | — |
default | Unexpected error | — |
fx:conversion1
GET/v1/conversion/{from}/{to}Real-time Currency Conversion
| Name | In | Required | Type |
|---|---|---|---|
from | path | yes | string |
to | path | yes | string |
amount | query | no | number |
precision | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | The last tick for this currency pair, plus the converted amount for the requested amount. | — |
default | Unexpected error | — |
fx:last:quote1
GET/v1/last_quote/currencies/{from}/{to}Last Quote for a Currency Pair
| Name | In | Required | Type |
|---|---|---|---|
from | path | yes | string |
to | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | The last quote tick for this currency pair. | — |
default | Unexpected error | — |
fx:quotes1
GET/v3/quotes/{fxTicker}Quotes (BBO)
| Name | In | Required | Type |
|---|---|---|---|
fxTicker | path | yes | string |
timestamp | query | no | string |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of quotes. | — |
fx:snapshot3
GET/v2/snapshot/locale/global/markets/forex/tickersAll Tickers
| Name | In | Required | Type |
|---|---|---|---|
tickers | query | no | array |
| Status | Description | Schema |
|---|---|---|
200 | Get current state for all tickers | — |
default | Unexpected error | — |
GET/v2/snapshot/locale/global/markets/forex/tickers/{ticker}Ticker
| Name | In | Required | Type |
|---|---|---|---|
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Get current state for a ticker | — |
default | Unexpected error | — |
GET/v2/snapshot/locale/global/markets/forex/{direction}Gainers/Losers
| Name | In | Required | Type |
|---|---|---|---|
direction | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Get the current gainers / losers of the day | — |
default | Unexpected error | — |
fx:trades1
GET/v1/historic/forex/{from}/{to}/{date}Historic Forex Ticks
| Name | In | Required | Type |
|---|---|---|---|
from | path | yes | string |
to | path | yes | string |
date | path | yes | string |
offset | query | no | integer |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | An array of forex ticks | — |
default | Unexpected error | — |
global_crypto1
GET/crypto/v1/exchanges
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
global_forex1
GET/forex/v1/exchanges
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
indices:aggregates6
GET/v1/indicators/ema/{indicesTicker}Exponential Moving Average (EMA)
| Name | In | Required | Type |
|---|---|---|---|
indicesTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Exponential Moving Average (EMA) data for each period. | — |
GET/v1/indicators/macd/{indicesTicker}Moving Average Convergence/Divergence (MACD)
| Name | In | Required | Type |
|---|---|---|---|
indicesTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
short_window | query | no | integer |
long_window | query | no | integer |
signal_window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Moving Average Convergence/Divergence (MACD) data for each period. | — |
GET/v1/indicators/rsi/{indicesTicker}Relative Strength Index (RSI)
| Name | In | Required | Type |
|---|---|---|---|
indicesTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Relative Strength Index (RSI) data for each period. | — |
GET/v1/indicators/sma/{indicesTicker}Simple Moving Average (SMA)
| Name | In | Required | Type |
|---|---|---|---|
indicesTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Simple Moving Average (SMA) data for each period. | — |
GET/v2/aggs/ticker/{indicesTicker}/prevPrevious Close
| Name | In | Required | Type |
|---|---|---|---|
indicesTicker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | The previous day OHLC for a index. | — |
default | Unexpected error | — |
GET/v2/aggs/ticker/{indicesTicker}/range/{multiplier}/{timespan}/{from}/{to}Aggregates (Bars)
| Name | In | Required | Type |
|---|---|---|---|
indicesTicker | path | yes | string |
multiplier | path | yes | integer |
timespan | path | yes | string |
from | path | yes | string |
to | path | yes | string |
sort | query | no | — |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Index Aggregates. | — |
default | Unexpected error | — |
indices:snapshot1
GET/v3/snapshot/indicesIndices Snapshot
| Name | In | Required | Type |
|---|---|---|---|
ticker.any_of | query | no | string |
ticker | query | no | string |
ticker.gte | query | no | string |
ticker.gt | query | no | string |
ticker.lte | query | no | string |
ticker.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Snapshots for indices data of the underlying ticker | — |
options:aggregates6
GET/v1/indicators/ema/{optionsTicker}Exponential Moving Average (EMA)
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Exponential Moving Average (EMA) data for each period. | — |
GET/v1/indicators/macd/{optionsTicker}Moving Average Convergence/Divergence (MACD)
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
short_window | query | no | integer |
long_window | query | no | integer |
signal_window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Moving Average Convergence/Divergence (MACD) data for each period. | — |
GET/v1/indicators/rsi/{optionsTicker}Relative Strength Index (RSI)
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Relative Strength Index (RSI) data for each period. | — |
GET/v1/indicators/sma/{optionsTicker}Simple Moving Average (SMA)
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Simple Moving Average (SMA) data for each period. | — |
GET/v2/aggs/ticker/{optionsTicker}/prevPrevious Close
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
adjusted | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | The previous day OHLC for the options contract. | — |
default | Unexpected error | — |
GET/v2/aggs/ticker/{optionsTicker}/range/{multiplier}/{timespan}/{from}/{to}Aggregates (Bars)
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
multiplier | path | yes | integer |
timespan | path | yes | string |
from | path | yes | string |
to | path | yes | string |
adjusted | query | no | boolean |
sort | query | no | — |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Options Aggregates. | — |
default | Unexpected error | — |
options:last:trade1
GET/v2/last/trade/{optionsTicker}Last Trade
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | The last trade for this options contract. | — |
401 | Unauthorized - Check our API Key and account status | — |
404 | The specified resource was not found | — |
options:open-close1
GET/v1/open-close/{optionsTicker}/{date}Daily Open/Close
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
date | path | yes | string |
adjusted | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | The open/close of this stock symbol. | — |
default | Unexpected error | — |
options:quotes1
GET/v3/quotes/{optionsTicker}Quotes
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
timestamp | query | no | string |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of quotes. | — |
options:snapshot2
GET/v3/snapshot/options/{underlyingAsset}Options Chain
| Name | In | Required | Type |
|---|---|---|---|
underlyingAsset | path | yes | string |
strike_price | query | no | number |
expiration_date | query | no | string |
contract_type | query | no | string |
strike_price.gte | query | no | number |
strike_price.gt | query | no | number |
strike_price.lte | query | no | number |
strike_price.lt | query | no | number |
expiration_date.gte | query | no | string |
expiration_date.gt | query | no | string |
expiration_date.lte | query | no | string |
expiration_date.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Snapshots for options contracts of the underlying ticker | — |
GET/v3/snapshot/options/{underlyingAsset}/{optionContract}Option Contract
| Name | In | Required | Type |
|---|---|---|---|
underlyingAsset | path | yes | string |
optionContract | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Snapshot of the option contract. | — |
options:trades1
GET/v3/trades/{optionsTicker}Trades
| Name | In | Required | Type |
|---|---|---|---|
optionsTicker | path | yes | string |
timestamp | query | no | string |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of trades. | — |
reference:conditions1
GET/v3/reference/conditionsConditions
| Name | In | Required | Type |
|---|---|---|---|
asset_class | query | no | string |
data_type | query | no | string |
id | query | no | integer |
sip | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
400 | a query parameter was malformed | — |
default | an unknown error occurred | — |
reference:dividends1
GET/v3/reference/dividendsDividends v3
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
ex_dividend_date | query | no | string |
record_date | query | no | string |
declaration_date | query | no | string |
pay_date | query | no | string |
frequency | query | no | integer |
cash_amount | query | no | number |
dividend_type | query | no | string |
ticker.gte | query | no | string |
ticker.gt | query | no | string |
ticker.lte | query | no | string |
ticker.lt | query | no | string |
ex_dividend_date.gte | query | no | string |
ex_dividend_date.gt | query | no | string |
ex_dividend_date.lte | query | no | string |
ex_dividend_date.lt | query | no | string |
record_date.gte | query | no | string |
record_date.gt | query | no | string |
record_date.lte | query | no | string |
record_date.lt | query | no | string |
declaration_date.gte | query | no | string |
declaration_date.gt | query | no | string |
declaration_date.lte | query | no | string |
declaration_date.lt | query | no | string |
pay_date.gte | query | no | string |
pay_date.gt | query | no | string |
pay_date.lte | query | no | string |
pay_date.lt | query | no | string |
cash_amount.gte | query | no | number |
cash_amount.gt | query | no | number |
cash_amount.lte | query | no | number |
cash_amount.lt | query | no | number |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
reference:exchanges1
GET/v3/reference/exchangesExchanges
| Name | In | Required | Type |
|---|---|---|---|
asset_class | query | no | string |
locale | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
400 | a query parameter was malformed | — |
default | an unknown error occurred | — |
reference:news1
GET/v2/reference/newsTicker News
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
published_utc | query | no | — |
ticker.gte | query | no | string |
ticker.gt | query | no | string |
ticker.lte | query | no | string |
ticker.lt | query | no | string |
published_utc.gte | query | no | — |
published_utc.gt | query | no | — |
published_utc.lte | query | no | — |
published_utc.lt | query | no | — |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | An array of news articles. | — |
401 | Unauthorized - Check our API Key and account status | — |
404 | The specified resource was not found | — |
reference:options:contract1
GET/v3/reference/options/contracts/{options_ticker}Options Contract
| Name | In | Required | Type |
|---|---|---|---|
options_ticker | path | yes | string |
as_of | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A specific options contract | — |
reference:options:contracts:list1
GET/v3/reference/options/contractsOptions Contracts
| Name | In | Required | Type |
|---|---|---|---|
underlying_ticker | query | no | string |
ticker | query | no | string |
contract_type | query | no | string |
expiration_date | query | no | string |
as_of | query | no | string |
strike_price | query | no | number |
expired | query | no | boolean |
underlying_ticker.gte | query | no | string |
underlying_ticker.gt | query | no | string |
underlying_ticker.lte | query | no | string |
underlying_ticker.lt | query | no | string |
expiration_date.gte | query | no | string |
expiration_date.gt | query | no | string |
expiration_date.lte | query | no | string |
expiration_date.lt | query | no | string |
strike_price.gte | query | no | number |
strike_price.gt | query | no | number |
strike_price.lte | query | no | number |
strike_price.lt | query | no | number |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of options contracts | — |
reference:related:companies1
GET/v1/related-companies/{ticker}Related Companies
| Name | In | Required | Type |
|---|---|---|---|
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Related Companies. | — |
401 | Unauthorized - Check our API Key and account status | — |
reference:sec:filing1
GET/v1/reference/sec/filings/{filing_id}SEC Filing
| Name | In | Required | Type |
|---|---|---|---|
filing_id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | FIXME | — |
reference:sec:filing:file1
GET/v1/reference/sec/filings/{filing_id}/files/{file_id}SEC Filing File
| Name | In | Required | Type |
|---|---|---|---|
filing_id | path | yes | string |
file_id | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | The file data. | — |
reference:sec:filing:files1
GET/v1/reference/sec/filings/{filing_id}/filesSEC Filing Files
| Name | In | Required | Type |
|---|---|---|---|
filing_id | path | yes | string |
sequence | query | no | integer |
filename | query | no | string |
sequence.gte | query | no | integer |
sequence.gt | query | no | integer |
sequence.lte | query | no | integer |
sequence.lt | query | no | integer |
filename.gte | query | no | string |
filename.gt | query | no | string |
filename.lte | query | no | string |
filename.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | FIXME | — |
reference:sec:filings1
GET/v1/reference/sec/filingsSEC Filings
| Name | In | Required | Type |
|---|---|---|---|
type | query | no | string |
filing_date | query | no | string |
period_of_report_date | query | no | string |
has_xbrl | query | no | boolean |
entities.company_data.name | query | no | string |
entities.company_data.cik | query | no | string |
entities.company_data.ticker | query | no | string |
entities.company_data.sic | query | no | string |
filing_date.gte | query | no | string |
filing_date.gt | query | no | string |
filing_date.lte | query | no | string |
filing_date.lt | query | no | string |
period_of_report_date.gte | query | no | string |
period_of_report_date.gt | query | no | string |
period_of_report_date.lte | query | no | string |
period_of_report_date.lt | query | no | string |
entities.company_data.name.search | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | FIXME | — |
reference:stocks2
GET/v3/reference/splitsStock Splits v3
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
execution_date | query | no | string |
reverse_split | query | no | boolean |
ticker.gte | query | no | string |
ticker.gt | query | no | string |
ticker.lte | query | no | string |
ticker.lt | query | no | string |
execution_date.gte | query | no | string |
execution_date.gt | query | no | string |
execution_date.lte | query | no | string |
execution_date.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of stock splits. | — |
GET/vX/reference/financialsStock Financials vX
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
cik | query | no | string |
company_name | query | no | string |
sic | query | no | string |
filing_date | query | no | string |
period_of_report_date | query | no | string |
timeframe | query | no | string |
include_sources | query | no | boolean |
company_name.search | query | no | string |
filing_date.gte | query | no | string |
filing_date.gt | query | no | string |
filing_date.lte | query | no | string |
filing_date.lt | query | no | string |
period_of_report_date.gte | query | no | string |
period_of_report_date.gt | query | no | string |
period_of_report_date.lte | query | no | string |
period_of_report_date.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | FIXME | — |
reference:stocks:ipos1
GET/vX/reference/iposIPOs
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
us_code | query | no | string |
isin | query | no | string |
listing_date | query | no | string |
ipo_status | query | no | string |
listing_date.gte | query | no | string |
listing_date.gt | query | no | string |
listing_date.lte | query | no | string |
listing_date.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of IPO events. | — |
reference:stocks:market2
GET/v1/marketstatus/nowMarket Status
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
GET/v1/marketstatus/upcomingMarket Holidays
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
reference:tickers:get2
GET/v3/reference/tickers/{ticker}Ticker Details v3
| Name | In | Required | Type |
|---|---|---|---|
ticker | path | yes | string |
date | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Reference Tickers. | — |
401 | Unauthorized - Check our API Key and account status | — |
GET/vX/reference/tickers/{id}/eventsTicker Events
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
types | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Ticker Events. | — |
401 | Unauthorized - Check our API Key and account status | — |
reference:tickers:list1
GET/v3/reference/tickersTickers
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
type | query | no | string |
market | query | no | string |
exchange | query | no | string |
cusip | query | no | string |
cik | query | no | string |
date | query | no | string |
search | query | no | string |
active | query | no | boolean |
ticker.gte | query | no | string |
ticker.gt | query | no | string |
ticker.lte | query | no | string |
ticker.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Reference Tickers. | — |
401 | Unauthorized - Check our API Key and account status | — |
reference:tickers:types1
GET/v3/reference/tickers/typesTicker Types
| Name | In | Required | Type |
|---|---|---|---|
asset_class | query | no | string |
locale | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
400 | a query parameter was malformed | — |
default | an unknown error occurred | — |
stocks:aggregates7
GET/v1/indicators/ema/{stockTicker}Exponential Moving Average (EMA)
| Name | In | Required | Type |
|---|---|---|---|
stockTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Exponential Moving Average (EMA) data for each period. | — |
GET/v1/indicators/macd/{stockTicker}Moving Average Convergence/Divergence (MACD)
| Name | In | Required | Type |
|---|---|---|---|
stockTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
short_window | query | no | integer |
long_window | query | no | integer |
signal_window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Moving Average Convergence/Divergence (MACD) data for each period. | — |
GET/v1/indicators/rsi/{stockTicker}Relative Strength Index (RSI)
| Name | In | Required | Type |
|---|---|---|---|
stockTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Relative strength Index data for each period. | — |
GET/v1/indicators/sma/{stockTicker}Simple Moving Average (SMA)
| Name | In | Required | Type |
|---|---|---|---|
stockTicker | path | yes | string |
timestamp | query | no | string |
timespan | query | no | string |
adjusted | query | no | boolean |
window | query | no | integer |
series_type | query | no | string |
expand_underlying | query | no | boolean |
order | query | no | string |
limit | query | no | integer |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Simple Moving Average (SMA) data for each period. | — |
GET/v2/aggs/grouped/locale/us/market/stocks/{date}Grouped Daily (Bars)
| Name | In | Required | Type |
|---|---|---|---|
date | path | yes | string |
adjusted | query | no | boolean |
include_otc | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | Previous day OHLC for ticker | — |
default | Unexpected error | — |
GET/v2/aggs/ticker/{stocksTicker}/prevPrevious Close
| Name | In | Required | Type |
|---|---|---|---|
stocksTicker | path | yes | string |
adjusted | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | The previous day OHLC for the ticker. | — |
default | Unexpected error | — |
GET/v2/aggs/ticker/{stocksTicker}/range/{multiplier}/{timespan}/{from}/{to}Aggregates (Bars)
| Name | In | Required | Type |
|---|---|---|---|
stocksTicker | path | yes | string |
multiplier | path | yes | integer |
timespan | path | yes | string |
from | path | yes | string |
to | path | yes | string |
adjusted | query | no | boolean |
sort | query | no | — |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | Stock Aggregates. | — |
default | Unexpected error | — |
stocks:last:quote1
GET/v2/last/nbbo/{stocksTicker}Last Quote
| Name | In | Required | Type |
|---|---|---|---|
stocksTicker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | The last NBBO tick for this stock. | — |
401 | Unauthorized - Check our API Key and account status | — |
404 | The specified resource was not found | — |
stocks:last:trade1
GET/v2/last/trade/{stocksTicker}Last Trade
| Name | In | Required | Type |
|---|---|---|---|
stocksTicker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | The last trade for this stock. | — |
401 | Unauthorized - Check our API Key and account status | — |
404 | The specified resource was not found | — |
stocks:open-close2
GET/v1/open-close/{indicesTicker}/{date}Daily Open/Close
| Name | In | Required | Type |
|---|---|---|---|
indicesTicker | path | yes | string |
date | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | The open/close of this stock symbol. | — |
default | Unexpected error | — |
GET/v1/open-close/{stocksTicker}/{date}Daily Open/Close
| Name | In | Required | Type |
|---|---|---|---|
stocksTicker | path | yes | string |
date | path | yes | string |
adjusted | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | The open/close of this stock symbol. | — |
default | Unexpected error | — |
stocks:quotes2
GET/v2/ticks/stocks/nbbo/{ticker}/{date}Quotes (NBBO)
| Name | In | Required | Type |
|---|---|---|---|
ticker | path | yes | string |
date | path | yes | string |
timestamp | query | no | integer |
timestampLimit | query | no | integer |
reverse | query | no | boolean |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | A list of quotes. | — |
default | Unexpected error | — |
GET/v3/quotes/{stockTicker}Quotes (NBBO)
| Name | In | Required | Type |
|---|---|---|---|
stockTicker | path | yes | string |
timestamp | query | no | string |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of quotes. | — |
stocks:snapshot3
GET/v2/snapshot/locale/us/markets/stocks/tickersAll Tickers
| Name | In | Required | Type |
|---|---|---|---|
tickers | query | no | array |
include_otc | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | Get current state for all tickers | — |
default | Unexpected error | — |
GET/v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}Ticker
| Name | In | Required | Type |
|---|---|---|---|
stocksTicker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | Get current state for a ticker | — |
default | Unexpected error | — |
GET/v2/snapshot/locale/us/markets/stocks/{direction}Gainers/Losers
| Name | In | Required | Type |
|---|---|---|---|
direction | path | yes | string |
include_otc | query | no | boolean |
| Status | Description | Schema |
|---|---|---|
200 | Get the current tickers of the day | — |
default | Unexpected error | — |
stocks:trades2
GET/v2/ticks/stocks/trades/{ticker}/{date}Trades
| Name | In | Required | Type |
|---|---|---|---|
ticker | path | yes | string |
date | path | yes | string |
timestamp | query | no | integer |
timestampLimit | query | no | integer |
reverse | query | no | boolean |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | A list of trades. | — |
default | Unexpected error | — |
GET/v3/trades/{stockTicker}Trades
| Name | In | Required | Type |
|---|---|---|---|
stockTicker | path | yes | string |
timestamp | query | no | string |
timestamp.gte | query | no | string |
timestamp.gt | query | no | string |
timestamp.lte | query | no | string |
timestamp.lt | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of trades. | — |
tmx1
GET/tmx/v1/corporate-events
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.any_of | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
type | query | no | string |
type.any_of | query | no | string |
type.gt | query | no | string |
type.gte | query | no | string |
type.lt | query | no | string |
type.lte | query | no | string |
status | query | no | string |
status.any_of | query | no | string |
status.gt | query | no | string |
status.gte | query | no | string |
status.lt | query | no | string |
status.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
isin | query | no | string |
isin.any_of | query | no | string |
isin.gt | query | no | string |
isin.gte | query | no | string |
isin.lt | query | no | string |
isin.lte | query | no | string |
trading_venue | query | no | string |
trading_venue.any_of | query | no | string |
trading_venue.gt | query | no | string |
trading_venue.gte | query | no | string |
trading_venue.lt | query | no | string |
trading_venue.lte | query | no | string |
tmx_company_id | query | no | integer |
tmx_company_id.gt | query | no | integer |
tmx_company_id.gte | query | no | integer |
tmx_company_id.lt | query | no | integer |
tmx_company_id.lte | query | no | integer |
tmx_record_id | query | no | string |
tmx_record_id.any_of | query | no | string |
tmx_record_id.gt | query | no | string |
tmx_record_id.gte | query | no | string |
tmx_record_id.lt | query | no | string |
tmx_record_id.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
us_futures8
GET/futures/v1/contractsfutures contracts API
| Name | In | Required | Type |
|---|---|---|---|
date | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
product_code | query | no | string |
product_code.any_of | query | no | string |
product_code.gt | query | no | string |
product_code.gte | query | no | string |
product_code.lt | query | no | string |
product_code.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
active | query | no | boolean |
type | query | no | string |
type.any_of | query | no | string |
first_trade_date | query | no | string |
first_trade_date.gt | query | no | string |
first_trade_date.gte | query | no | string |
first_trade_date.lt | query | no | string |
first_trade_date.lte | query | no | string |
last_trade_date | query | no | string |
last_trade_date.gt | query | no | string |
last_trade_date.gte | query | no | string |
last_trade_date.lt | query | no | string |
last_trade_date.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/futures/v1/exchanges
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/futures/v1/market-statusMarket Status API
| Name | In | Required | Type |
|---|---|---|---|
product_code | query | no | string |
product_code.any_of | query | no | string |
product_code.gt | query | no | string |
product_code.gte | query | no | string |
product_code.lt | query | no | string |
product_code.lte | query | no | string |
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/futures/v1/productsFutures Products API
| Name | In | Required | Type |
|---|---|---|---|
name | query | no | string |
name.any_of | query | no | string |
name.gt | query | no | string |
name.gte | query | no | string |
name.lt | query | no | string |
name.lte | query | no | string |
product_code | query | no | string |
product_code.any_of | query | no | string |
product_code.gt | query | no | string |
product_code.gte | query | no | string |
product_code.lt | query | no | string |
product_code.lte | query | no | string |
date | query | no | string |
date.gt | query | no | string |
date.gte | query | no | string |
date.lt | query | no | string |
date.lte | query | no | string |
trading_venue | query | no | string |
trading_venue.any_of | query | no | string |
trading_venue.gt | query | no | string |
trading_venue.gte | query | no | string |
trading_venue.lt | query | no | string |
trading_venue.lte | query | no | string |
sector | query | no | string |
sector.any_of | query | no | string |
sub_sector | query | no | string |
sub_sector.any_of | query | no | string |
asset_class | query | no | string |
asset_class.any_of | query | no | string |
asset_sub_class | query | no | string |
asset_sub_class.any_of | query | no | string |
type | query | no | string |
type.any_of | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/futures/v1/quotes/{ticker}
| Name | In | Required | Type |
|---|---|---|---|
timestamp | query | no | string |
timestamp.gt | query | no | string |
timestamp.gte | query | no | string |
timestamp.lt | query | no | string |
timestamp.lte | query | no | string |
session_end_date | query | no | string |
limit | query | no | integer |
sort | query | no | string |
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/futures/v1/schedulesFutures Schedules API
| Name | In | Required | Type |
|---|---|---|---|
product_code | query | no | string |
product_code.any_of | query | no | string |
product_code.gt | query | no | string |
product_code.gte | query | no | string |
product_code.lt | query | no | string |
product_code.lte | query | no | string |
session_end_date | query | no | string |
session_end_date.gt | query | no | string |
session_end_date.gte | query | no | string |
session_end_date.lt | query | no | string |
session_end_date.lte | query | no | string |
trading_venue | query | no | string |
trading_venue.any_of | query | no | string |
trading_venue.gt | query | no | string |
trading_venue.gte | query | no | string |
trading_venue.lt | query | no | string |
trading_venue.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/futures/v1/snapshotfutures_snapshot_v1 API
| Name | In | Required | Type |
|---|---|---|---|
product_code | query | no | string |
product_code.any_of | query | no | string |
product_code.gt | query | no | string |
product_code.gte | query | no | string |
product_code.lt | query | no | string |
product_code.lte | query | no | string |
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/futures/v1/trades/{ticker}
| Name | In | Required | Type |
|---|---|---|---|
timestamp | query | no | string |
timestamp.gt | query | no | string |
timestamp.gte | query | no | string |
timestamp.lt | query | no | string |
timestamp.lte | query | no | string |
session_end_date | query | no | string |
limit | query | no | integer |
sort | query | no | string |
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
us_options3
GET/options/v1/exchanges
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/options/v3/quotes/{ticker}
| Name | In | Required | Type |
|---|---|---|---|
timestamp | query | no | string |
timestamp.gt | query | no | string |
timestamp.gte | query | no | string |
timestamp.lt | query | no | string |
timestamp.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/options/v3/trades/{ticker}
| Name | In | Required | Type |
|---|---|---|---|
timestamp | query | no | string |
timestamp.gt | query | no | string |
timestamp.gte | query | no | string |
timestamp.lt | query | no | string |
timestamp.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
us_stocks_all2
GET/stocks/dev/trades/{ticker}
| Name | In | Required | Type |
|---|---|---|---|
sip_timestamp | query | no | string |
sip_timestamp.gt | query | no | string |
sip_timestamp.gte | query | no | string |
sip_timestamp.lt | query | no | string |
sip_timestamp.lte | query | no | string |
limit | query | no | integer |
sort | query | no | string |
ticker | path | yes | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/v1/exchanges
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | integer |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
us_stocks_reference3
GET/stocks/v1/dividends
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
ex_dividend_date | query | no | string |
ex_dividend_date.gt | query | no | string |
ex_dividend_date.gte | query | no | string |
ex_dividend_date.lt | query | no | string |
ex_dividend_date.lte | query | no | string |
frequency | query | no | integer |
frequency.gt | query | no | integer |
frequency.gte | query | no | integer |
frequency.lt | query | no | integer |
frequency.lte | query | no | integer |
distribution_type | query | no | string |
distribution_type.any_of | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/stocks/v1/splits
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
execution_date | query | no | string |
execution_date.gt | query | no | string |
execution_date.gte | query | no | string |
execution_date.lt | query | no | string |
execution_date.lte | query | no | string |
adjustment_type | query | no | string |
adjustment_type.any_of | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
GET/v1/reference/ipos
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
ticker.any_of | query | no | string |
ticker.gt | query | no | string |
ticker.gte | query | no | string |
ticker.lt | query | no | string |
ticker.lte | query | no | string |
us_code | query | no | string |
us_code.any_of | query | no | string |
us_code.gt | query | no | string |
us_code.gte | query | no | string |
us_code.lt | query | no | string |
us_code.lte | query | no | string |
isin | query | no | string |
isin.any_of | query | no | string |
isin.gt | query | no | string |
isin.gte | query | no | string |
isin.lt | query | no | string |
isin.lte | query | no | string |
listing_date | query | no | string |
listing_date.gt | query | no | string |
listing_date.gte | query | no | string |
listing_date.lt | query | no | string |
listing_date.lte | query | no | string |
ipo_status | query | no | string |
ipo_status.any_of | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | A list of results. | — |
400 | An error message. | — |
v11
GET/v1/summariesSummaries
| Name | In | Required | Type |
|---|---|---|---|
ticker.any_of | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Snapshot Summary for ticker list | — |
v31
GET/v3/snapshotUniversal Snapshot
| Name | In | Required | Type |
|---|---|---|---|
ticker | query | no | string |
type | query | no | string |
ticker.gte | query | no | string |
ticker.gt | query | no | string |
ticker.lte | query | no | string |
ticker.lt | query | no | string |
ticker.any_of | query | no | string |
order | query | no | string |
limit | query | no | integer |
sort | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | Snapshots for the ticker list | — |
Try it
Developer reference
https://api.polygon.ioBasic (free) tier: 5 API calls/minute, shared across stocks, options, indices, and currencies (forex/crypto) product lines. Starter ($29/mo), Developer ($79/mo), and Advanced ($199/mo) plans are all listed as "Unlimited API Calls" with no published requests-per-minute cap.
- GET/v2/aggs/ticker/{stocksTicker}/range/{multiplier}/{timespan}/{from}/{to}
- GET/v3/reference/tickers
- GET/v3/reference/tickers/{ticker}
- GET/v2/last/trade/{stocksTicker}
- GET/v2/snapshot/locale/us/markets/stocks/tickers