A diff between this client library's spec and our hosted spec was found. The client may need an update to match any changes in our API. See the diff below:
--- https://raw.githubusercontent.com/polygon-io/client-jvm/master/.polygon/rest.json
+++ https://api.polygon.io/openapi
@@ -150,7 +150,7 @@
},
"IndicesTickerPathParam": {
"description": "The ticker symbol of Index.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -6339,7 +6339,7 @@
"parameters": [
{
"description": "The ticker symbol for which to get exponential moving average (EMA) data.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -6485,16 +6485,16 @@
"content": {
"application/json": {
"example": {
- "next_url": "https://api.polygon.io/v1/indicators/ema/I:DJI?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTQwNDcuNDEwMDAwMDAwMDAwMyUyQyUyMmglMjIlM0EwJTJDJTIybCUyMiUzQTAlMkMlMjJ0JTIyJTNBMTY3ODA4MjQwMDAwMCU3RCZhcz0mZXhwYW5kX3VuZGVybHlpbmc9ZmFsc2UmbGltaXQ9MTAmb3JkZXI9ZGVzYyZzZXJpZXNfdHlwZT1jbG9zZSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2NzgxNjUyMDAwMDAmd2luZG93PTU",
- "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+ "next_url": "https://api.polygon.io/v1/indicators/ema/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01MA",
+ "request_id": "b9201816341441eed663a90443c0623a",
"results": {
"underlying": {
- "url": "https://api.polygon.io/v2/aggs/ticker/I:DJI/range/1/day/1063281600000/1678726291180?limit=35&sort=desc"
+ "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366449650?limit=226&sort=desc"
},
"values": [
{
- "timestamp": 1681966800000,
- "value": 33355.64416487007
+ "timestamp": 1687237200000,
+ "value": 14452.002555459003
}
]
},
@@ -8001,7 +7996,7 @@
"parameters": [
{
"description": "The ticker symbol for which to get MACD data.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -8167,24 +8162,24 @@
"content": {
"application/json": {
"example": {
- "next_url": "https://api.polygon.io/v1/indicators/macd/I:DJI?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
- "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+ "next_url": "https://api.polygon.io/v1/indicators/macd/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MTUwODAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0yJmxvbmdfd2luZG93PTI2Jm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2Umc2hvcnRfd2luZG93PTEyJnNpZ25hbF93aW5kb3c9OSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2ODcyMTkyMDAwMDA",
+ "request_id": "2eeda0be57e83cbc64cc8d1a74e84dbd",
"results": {
"underlying": {
- "url": "https://api.polygon.io/v2/aggs/ticker/I:DJI/range/1/day/1063281600000/1678726155743?limit=129&sort=desc"
+ "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366537196?limit=121&sort=desc"
},
"values": [
{
- "histogram": -48.29157370302107,
- "signal": 225.60959338746886,
- "timestamp": 1681966800000,
- "value": 177.3180196844478
+ "histogram": -4.7646219788108795,
+ "signal": 220.7596784587801,
+ "timestamp": 1687237200000,
+ "value": 215.9950564799692
},
{
- "histogram": -37.55634001543484,
- "signal": 237.6824868132241,
- "timestamp": 1681963200000,
- "value": 200.12614679778926
+ "histogram": 3.4518937661882205,
+ "signal": 221.9508339534828,
+ "timestamp": 1687219200000,
+ "value": 225.40272771967102
}
]
},
@@ -9707,7 +9695,7 @@
"parameters": [
{
"description": "The ticker symbol for which to get relative strength index (RSI) data.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -9853,16 +9841,16 @@
"content": {
"application/json": {
"example": {
- "next_url": "https://api.polygon.io/v1/indicators/rsi/I:DJI?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTQwNDcuNDEwMDAwMDAwMDAwMyUyQyUyMmglMjIlM0EwJTJDJTIybCUyMiUzQTAlMkMlMjJ0JTIyJTNBMTY3ODA4MjQwMDAwMCU3RCZhcz0mZXhwYW5kX3VuZGVybHlpbmc9ZmFsc2UmbGltaXQ9MTAmb3JkZXI9ZGVzYyZzZXJpZXNfdHlwZT1jbG9zZSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2NzgxNjUyMDAwMDAmd2luZG93PTU",
- "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+ "next_url": "https://api.polygon.io/v1/indicators/rsi/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz0xNA",
+ "request_id": "28a8417f521f98e1d08f6ed7d1fbcad3",
"results": {
"underlying": {
- "url": "https://api.polygon.io/v2/aggs/ticker/I:DJI/range/1/day/1063281600000/1678725829099?limit=35&sort=desc"
+ "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366658253?limit=66&sort=desc"
},
"values": [
{
- "timestamp": 1681966800000,
- "value": 55.89394103205648
+ "timestamp": 1687237200000,
+ "value": 73.98019439047955
}
]
},
@@ -11325,7 +11308,7 @@
"parameters": [
{
"description": "The ticker symbol for which to get simple moving average (SMA) data.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -11471,16 +11454,16 @@
"content": {
"application/json": {
"example": {
- "next_url": "https://api.polygon.io/v1/indicators/sma/I:DJI?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTQwNDcuNDEwMDAwMDAwMDAwMyUyQyUyMmglMjIlM0EwJTJDJTIybCUyMiUzQTAlMkMlMjJ0JTIyJTNBMTY3ODA4MjQwMDAwMCU3RCZhcz0mZXhwYW5kX3VuZGVybHlpbmc9ZmFsc2UmbGltaXQ9MTAmb3JkZXI9ZGVzYyZzZXJpZXNfdHlwZT1jbG9zZSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2NzgxNjUyMDAwMDAmd2luZG93PTU",
- "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+ "next_url": "https://api.polygon.io/v1/indicators/sma/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01Mw",
+ "request_id": "4cae270008cb3f947e3f92c206e3888a",
"results": {
"underlying": {
- "url": "https://api.polygon.io/v2/aggs/ticker/I:DJI/range/1/day/1063281600000/1678725829099?limit=35&sort=desc"
+ "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366378997?limit=240&sort=desc"
},
"values": [
{
- "timestamp": 1681966800000,
- "value": 33236.3424
+ "timestamp": 1687237200000,
+ "value": 14362.676417589264
}
]
},
@@ -13042,7 +13020,7 @@
"parameters": [
{
"description": "The ticker symbol of Index.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -13057,7 +13035,6 @@
"name": "date",
"required": true,
"schema": {
- "format": "date",
"type": "string"
}
}
@@ -13067,15 +13044,15 @@
"content": {
"application/json": {
"example": {
- "afterHours": 31909.64,
- "close": 32245.14,
- "from": "2023-03-10",
- "high": 32988.26,
- "low": 32200.66,
- "open": 32922.75,
- "preMarket": 32338.23,
+ "afterHours": 11830.43006295237,
+ "close": 11830.28178808306,
+ "from": "2023-03-10T00:00:00.000Z",
+ "high": 12069.62262033557,
+ "low": 11789.85923449393,
+ "open": 12001.69552583921,
+ "preMarket": 12001.69552583921,
"status": "OK",
- "symbol": "I:DJI"
+ "symbol": "I:NDX"
},
"schema": {
"properties": {
@@ -13145,6 +13121,7 @@
"tags": [
"stocks:open-close"
],
+ "x-polygon-entitlement-allowed-limited-tickers": true,
"x-polygon-entitlement-data-type": {
"description": "Aggregate data",
"name": "aggregates"
@@ -16258,7 +16235,7 @@
"parameters": [
{
"description": "The ticker symbol of Index.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -16276,17 +16253,17 @@
"request_id": "b2170df985474b6d21a6eeccfb6bee67",
"results": [
{
- "T": "I:DJI",
- "c": 33786.62,
- "h": 33786.62,
- "l": 33677.74,
- "o": 33677.74,
- "t": 1682020800000
+ "T": "I:NDX",
+ "c": 15070.14948566977,
+ "h": 15127.4195807999,
+ "l": 14946.7243781848,
+ "o": 15036.48391066877,
+ "t": 1687291200000
}
],
"resultsCount": 1,
"status": "OK",
- "ticker": "I:DJI"
+ "ticker": "I:NDX"
},
"schema": {
"allOf": [
@@ -16387,6 +16360,7 @@
"tags": [
"indices:aggregates"
],
+ "x-polygon-entitlement-allowed-limited-tickers": true,
"x-polygon-entitlement-data-type": {
"description": "Aggregate data",
"name": "aggregates"
@@ -16403,7 +16377,7 @@
"parameters": [
{
"description": "The ticker symbol of Index.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -16492,22 +16466,22 @@
"request_id": "0cf72b6da685bcd386548ffe2895904a",
"results": [
{
- "c": 32245.14,
- "h": 32988.26,
- "l": 32200.66,
- "o": 32922.75,
+ "c": 11995.88235998666,
+ "h": 12340.44936267155,
+ "l": 11970.34221717375,
+ "o": 12230.83658266843,
"t": 1678341600000
},
{
- "c": 31787.7,
- "h": 32422.100000000002,
- "l": 31786.06,
- "o": 32198.9,
+ "c": 11830.28178808306,
+ "h": 12069.62262033557,
+ "l": 11789.85923449393,
+ "o": 12001.69552583921,
"t": 1678428000000
}
],
"status": "OK",
- "ticker": "I:DJI"
+ "ticker": "I:NDX"
},
"schema": {
"allOf": [
@@ -16608,6 +16575,7 @@
"tags": [
"indices:aggregates"
],
+ "x-polygon-entitlement-allowed-limited-tickers": true,
"x-polygon-entitlement-data-type": {
"description": "Aggregate data",
"name": "aggregates"
@@ -18512,7 +18480,9 @@
"c": 0.296,
"h": 0.296,
"l": 0.294,
+ "n": 2,
"o": 0.296,
+ "t": 1684427880000,
"v": 123.4866,
"vw": 0
},
@@ -18861,7 +18830,9 @@
"c": 16235.1,
"h": 16264.29,
"l": 16129.3,
+ "n": 558,
"o": 16257.51,
+ "t": 1684428960000,
"v": 19.30791925,
"vw": 0
},
@@ -19410,7 +19380,9 @@
"c": 0.062377,
"h": 0.062377,
"l": 0.062377,
+ "n": 2,
"o": 0.062377,
+ "t": 1684426740000,
"v": 35420,
"vw": 0
},
@@ -19747,7 +19718,9 @@
"c": 0.117769,
"h": 0.11779633,
"l": 0.11773698,
+ "n": 1,
"o": 0.11778,
+ "t": 1684422000000,
"v": 202
},
"prevDay": {
@@ -20052,7 +20024,9 @@
"c": 1.18396,
"h": 1.18423,
"l": 1.1838,
+ "n": 85,
"o": 1.18404,
+ "t": 1684422000000,
"v": 41
},
"prevDay": {
@@ -20368,7 +20341,9 @@
"c": 0.886156,
"h": 0.886156,
"l": 0.886156,
+ "n": 1,
"o": 0.886156,
+ "t": 1684422000000,
"v": 1
},
"prevDay": {
@@ -20698,7 +20672,9 @@
"c": 20.506,
"h": 20.506,
"l": 20.506,
+ "n": 1,
"o": 20.506,
+ "t": 1684428600000,
"v": 5000,
"vw": 20.5105
},
@@ -21096,7 +21071,9 @@
"c": 120.4201,
"h": 120.468,
"l": 120.37,
+ "n": 762,
"o": 120.435,
+ "t": 1684428720000,
"v": 270796,
"vw": 120.4129
},
@@ -21509,7 +21485,9 @@
"c": 14.2284,
"h": 14.325,
"l": 14.2,
+ "n": 5,
"o": 14.28,
+ "t": 1684428600000,
"v": 6108,
"vw": 14.2426
},
@@ -22513,7 +22490,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -22521,7 +22498,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -22529,7 +22506,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -22537,7 +22514,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -22738,7 +22715,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -22746,7 +22723,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -22754,7 +22731,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -22762,7 +22739,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -22978,7 +22955,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -22986,7 +22963,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -22994,7 +22971,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -23002,7 +22979,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -24122,7 +24099,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.gte",
"schema": {
@@ -24130,7 +24107,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.gt",
"schema": {
@@ -24138,7 +24115,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.lte",
"schema": {
@@ -24146,7 +24123,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.lt",
"schema": {
@@ -24154,7 +24131,7 @@
}
},
{
- "description": "Search by ex_dividend_date.",
+ "description": "Range by ex_dividend_date.",
"in": "query",
"name": "ex_dividend_date.gte",
"schema": {
@@ -24163,7 +24140,7 @@
}
},
{
- "description": "Search by ex_dividend_date.",
+ "description": "Range by ex_dividend_date.",
"in": "query",
"name": "ex_dividend_date.gt",
"schema": {
@@ -24172,7 +24149,7 @@
}
},
{
- "description": "Search by ex_dividend_date.",
+ "description": "Range by ex_dividend_date.",
"in": "query",
"name": "ex_dividend_date.lte",
"schema": {
@@ -24181,7 +24158,7 @@
}
},
{
- "description": "Search by ex_dividend_date.",
+ "description": "Range by ex_dividend_date.",
"in": "query",
"name": "ex_dividend_date.lt",
"schema": {
@@ -24190,7 +24167,7 @@
}
},
{
- "description": "Search by record_date.",
+ "description": "Range by record_date.",
"in": "query",
"name": "record_date.gte",
"schema": {
@@ -24199,7 +24176,7 @@
}
},
{
- "description": "Search by record_date.",
+ "description": "Range by record_date.",
"in": "query",
"name": "record_date.gt",
"schema": {
@@ -24208,7 +24185,7 @@
}
},
{
- "description": "Search by record_date.",
+ "description": "Range by record_date.",
"in": "query",
"name": "record_date.lte",
"schema": {
@@ -24217,7 +24194,7 @@
}
},
{
- "description": "Search by record_date.",
+ "description": "Range by record_date.",
"in": "query",
"name": "record_date.lt",
"schema": {
@@ -24226,7 +24203,7 @@
}
},
{
- "description": "Search by declaration_date.",
+ "description": "Range by declaration_date.",
"in": "query",
"name": "declaration_date.gte",
"schema": {
@@ -24235,7 +24212,7 @@
}
},
{
- "description": "Search by declaration_date.",
+ "description": "Range by declaration_date.",
"in": "query",
"name": "declaration_date.gt",
"schema": {
@@ -24244,7 +24221,7 @@
}
},
{
- "description": "Search by declaration_date.",
+ "description": "Range by declaration_date.",
"in": "query",
"name": "declaration_date.lte",
"schema": {
@@ -24253,7 +24230,7 @@
}
},
{
- "description": "Search by declaration_date.",
+ "description": "Range by declaration_date.",
"in": "query",
"name": "declaration_date.lt",
"schema": {
@@ -24262,7 +24239,7 @@
}
},
{
- "description": "Search by pay_date.",
+ "description": "Range by pay_date.",
"in": "query",
"name": "pay_date.gte",
"schema": {
@@ -24271,7 +24248,7 @@
}
},
{
- "description": "Search by pay_date.",
+ "description": "Range by pay_date.",
"in": "query",
"name": "pay_date.gt",
"schema": {
@@ -24280,7 +24257,7 @@
}
},
{
- "description": "Search by pay_date.",
+ "description": "Range by pay_date.",
"in": "query",
"name": "pay_date.lte",
"schema": {
@@ -24289,7 +24266,7 @@
}
},
{
- "description": "Search by pay_date.",
+ "description": "Range by pay_date.",
"in": "query",
"name": "pay_date.lt",
"schema": {
@@ -24298,7 +24275,7 @@
}
},
{
- "description": "Search by cash_amount.",
+ "description": "Range by cash_amount.",
"in": "query",
"name": "cash_amount.gte",
"schema": {
@@ -24306,7 +24283,7 @@
}
},
{
- "description": "Search by cash_amount.",
+ "description": "Range by cash_amount.",
"in": "query",
"name": "cash_amount.gt",
"schema": {
@@ -24314,7 +24291,7 @@
}
},
{
- "description": "Search by cash_amount.",
+ "description": "Range by cash_amount.",
"in": "query",
"name": "cash_amount.lte",
"schema": {
@@ -24322,7 +24299,7 @@
}
},
{
- "description": "Search by cash_amount.",
+ "description": "Range by cash_amount.",
"in": "query",
"name": "cash_amount.lt",
"schema": {
@@ -24568,349 +24545,6 @@
]
}
}
- },
- "post": {
- "description": "Manually add Polygon a dividend.",
- "operationId": "CreateDividend",
- "parameters": [
- {
- "description": "If true don't trigger overlay",
- "in": "query",
- "name": "skip_overlay_trigger",
- "schema": {
- "default": false,
- "type": "boolean"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "cash_amount": {
- "description": "The cash amount of the dividend per share owned.",
- "type": "number",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "currency": {
- "description": "The currency in which the dividend is paid.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "declaration_date": {
- "description": "The date that the dividend was announced.",
- "type": "string"
- },
- "dividend_type": {
- "description": "The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD.\nSpecial Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.\nLong-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively.",
- "enum": [
- "CD",
- "SC",
- "LT",
- "ST"
- ],
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "ex_dividend_date": {
- "description": "The date that the stock first trades without the dividend, determined by the exchange.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "frequency": {
- "description": "The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), and 12 (monthly).",
- "type": "integer",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "pay_date": {
- "description": "The date that the dividend is paid out.",
- "type": "string"
- },
- "record_date": {
- "description": "The date that the stock must be held to receive the dividend, set by the company.",
- "type": "string"
- },
- "ticker": {
- "description": "The ticker symbol of the dividend.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- }
- },
- "required": [
- "ticker",
- "ex_dividend_date",
- "frequency",
- "cash_amount",
- "dividend_type"
- ],
- "type": "object",
- "x-polygon-go-struct-tags": {
- "tags": [
- "db"
- ]
- }
- }
- }
- },
- "description": "Pass the desired dividend in the request body.",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "request_id": {
- "type": "string"
- },
- "results": {
- "properties": {
- "cash_amount": {
- "description": "The cash amount of the dividend per share owned.",
- "type": "number",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "currency": {
- "description": "The currency in which the dividend is paid.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "declaration_date": {
- "description": "The date that the dividend was announced.",
- "type": "string"
- },
- "dividend_type": {
- "description": "The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD.\nSpecial Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.\nLong-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively.",
- "enum": [
- "CD",
- "SC",
- "LT",
- "ST"
- ],
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "ex_dividend_date": {
- "description": "The date that the stock first trades without the dividend, determined by the exchange.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "frequency": {
- "description": "The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), and 12 (monthly).",
- "type": "integer",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "pay_date": {
- "description": "The date that the dividend is paid out.",
- "type": "string"
- },
- "record_date": {
- "description": "The date that the stock must be held to receive the dividend, set by the company.",
- "type": "string"
- },
- "ticker": {
- "description": "The ticker symbol of the dividend.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- }
- },
- "required": [
- "ticker",
- "ex_dividend_date",
- "frequency",
- "cash_amount",
- "dividend_type"
- ],
- "type": "object",
- "x-polygon-go-struct-tags": {
- "tags": [
- "db"
- ]
- }
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "request_id"
- ],
- "type": "object"
- }
- }
- },
- "description": "OK"
- },
- "400": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "error": {
- "type": "string"
- },
- "request_id": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "request_id",
- "error"
- ],
- "type": "object"
- }
- }
- },
- "description": "the requested update was unable to be performed due to an invalid request body"
- },
- "409": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "error": {
- "type": "string"
- },
- "request_id": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "request_id",
- "error"
- ],
- "type": "object"
- }
- }
- },
- "description": "a dividend already exists for this date and ticker"
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "error": {
- "type": "string"
- },
- "request_id": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "request_id",
- "error"
- ],
- "type": "object"
- }
- }
- },
- "description": "unknown error"
- }
- },
- "summary": "Dividends v3",
- "tags": [
- "reference:stocks"
- ],
- "x-polygon-entitlement-data-type": {
- "description": "Reference data",
- "name": "reference"
- }
}
},
"/v3/reference/exchanges": {
@@ -26072,7 +25706,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.gte",
"schema": {
@@ -26080,7 +25714,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.gt",
"schema": {
@@ -26088,7 +25722,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.lte",
"schema": {
@@ -26096,7 +25730,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.lt",
"schema": {
@@ -27500,8 +27134,8 @@
"name": "snapshots"
},
"x-polygon-entitlement-market-type": {
- "description": "Stocks data",
- "name": "stocks"
+ "description": "All asset classes",
+ "name": "universal"
},
"x-polygon-paginate": {
"limit": {
@@ -27516,8 +27150,7 @@
]
}
}
- },
- "x-polygon-draft": true
+ }
},
"/v3/snapshot/indices": {
"get": {
@@ -27535,7 +27168,6 @@
},
{
"description": "Search a range of tickers lexicographically.",
- "example": "I:DJI",
"in": "query",
"name": "ticker",
"schema": {
@@ -27830,7 +27462,7 @@
"parameters": [
{
"description": "The underlying ticker symbol of the option contract.",
- "example": "AAPL",
+ "example": "EVRI",
"in": "path",
"name": "underlyingAsset",
"required": true,
@@ -28480,7 +28112,7 @@
"parameters": [
{
"description": "The underlying ticker symbol of the option contract.",
- "example": "AAPL",
+ "example": "EVRI",
"in": "path",
"name": "underlyingAsset",
"required": true,
@@ -28490,7 +28122,7 @@
},
{
"description": "The option contract identifier.",
- "example": "O:AAPL230616C00150000",
+ "example": "O:EVRI240119C00002500",
"in": "path",
"name": "optionContract",
"required": true,
@@ -29009,7 +28641,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -29017,7 +28649,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -29025,7 +28657,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -29033,7 +28665,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -29255,7 +28887,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -29263,7 +28895,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -29271,7 +28903,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -29279,7 +28911,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -29500,7 +29132,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -29508,7 +29140,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -29516,7 +29148,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -29524,7 +29156,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -30734,7 +30366,8 @@
"/v2/snapshot/locale/global/markets/crypto/tickers",
"/v2/snapshot/locale/global/markets/crypto/{direction}",
"/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}",
- "/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book"
+ "/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book",
+ "/v3/snapshot"
]
},
{
@@ -30824,7 +30457,8 @@
"paths": [
"/v2/snapshot/locale/global/markets/forex/tickers",
"/v2/snapshot/locale/global/markets/forex/{direction}",
- "/v2/snapshot/locale/global/markets/forex/tickers/{ticker}"
+ "/v2/snapshot/locale/global/markets/forex/tickers/{ticker}",
+ "/v3/snapshot"
]
},
{
@@ -30895,7 +30529,8 @@
{
"group": "Snapshots",
"paths": [
- "/v3/snapshot/indices"
+ "/v3/snapshot/indices",
+ "/v3/snapshot"
]
}
],
@@ -30966,7 +30601,7 @@
"paths": [
"/v3/snapshot/options/{underlyingAsset}/{optionContract}",
"/v3/snapshot/options/{underlyingAsset}",
- "/v3/snapshot/options"
+ "/v3/snapshot"
]
},
{
@@ -31102,7 +30737,7 @@
"/v2/snapshot/locale/us/markets/stocks/tickers",
"/v2/snapshot/locale/us/markets/stocks/{direction}",
"/v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}",
- "/v3/snapshot/stocks"
+ "/v3/snapshot"
]
},
{