Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Client update needed to match REST spec changes #850

Open
client-library-maintainer bot opened this issue Feb 17, 2025 · 0 comments
Open

Client update needed to match REST spec changes #850

client-library-maintainer bot opened this issue Feb 17, 2025 · 0 comments
Labels
spec The client may need an update due to API spec changes

Comments

@client-library-maintainer
Copy link

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-python/master/.polygon/rest.json
+++ https://api.polygon.io/openapi
@@ -515,6 +515,7 @@
         "type": "array"
       },
       "CryptoGroupedResults": {
+        "description": "An array of results containing the requested data.",
         "properties": {
           "results": {
             "items": {
@@ -886,6 +887,7 @@
         "type": "object"
       },
       "CryptoSnapshotTicker": {
+        "description": "Contains the requested snapshot data for the specified ticker.",
         "properties": {
           "ticker": {
             "properties": {
@@ -1203,6 +1205,7 @@
         "type": "object"
       },
       "CryptoSnapshotTickers": {
+        "description": "An array of snapshot data for the specified tickers.",
         "properties": {
           "tickers": {
             "items": {
@@ -2087,6 +2090,7 @@
         "type": "integer"
       },
       "ForexGroupedResults": {
+        "description": "An array of results containing the requested data.",
         "properties": {
           "results": {
             "items": {
@@ -2780,6 +2784,7 @@
         "type": "object"
       },
       "ForexTickerResults": {
+        "description": "An array of results containing the requested data.",
         "properties": {
           "results": {
             "items": {
@@ -2884,6 +2889,7 @@
         "type": "array"
       },
       "IndicesGroupedResults": {
+        "description": "An array of results containing the requested data.",
         "properties": {
           "results": {
             "items": {
@@ -2984,6 +2990,7 @@
         "type": "object"
       },
       "IndicesTickerResults": {
+        "description": "An array of results containing the requested data.",
         "properties": {
           "results": {
             "items": {
@@ -3089,6 +3096,7 @@
         "type": "object"
       },
       "MarketHoliday": {
+        "description": "An array of upcoming market holidays and their corresponding dates.",
         "items": {
           "properties": {
             "close": {
@@ -3119,6 +3127,12 @@
               "type": "string"
             }
           },
+          "required": [
+            "exchange",
+            "date",
+            "name",
+            "status"
+          ],
           "type": "object"
         },
         "type": "array"
@@ -3587,6 +3601,7 @@
         "type": "string"
       },
       "StocksGroupedResults": {
+        "description": "An array of results containing the requested data.",
         "properties": {
           "results": {
             "items": {
@@ -3875,6 +3890,7 @@
         "type": "object"
       },
       "StocksSnapshotTicker": {
+        "description": "Contains the requested snapshot data for the specified ticker.",
         "properties": {
           "ticker": {
             "properties": {
@@ -4144,6 +4160,7 @@
         "type": "object"
       },
       "StocksSnapshotTickers": {
+        "description": "An array of snapshot data for the specified tickers.",
         "properties": {
           "tickers": {
             "items": {
@@ -4416,6 +4433,7 @@
         "type": "object"
       },
       "StocksTickerResultsOTC": {
+        "description": "An array of results containing the requested data.",
         "properties": {
           "results": {
             "items": {
@@ -4954,6 +4972,7 @@
         "type": "object"
       },
       "TickerResults": {
+        "description": "An array of results containing the requested data.",
         "properties": {
           "results": {
             "items": {
@@ -5185,6 +5204,814 @@
   },
   "openapi": "3.0.3",
   "paths": {
+    "/futures/vX/aggs/{ticker}": {
+      "get": {
+        "description": "Get aggregates for a contract in a given time range.",
+        "operationId": "Aggregates",
+        "parameters": [
+          {
+            "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ4 for the December 2024 S&P 500 E-mini contract).",
+            "example": "ESZ4",
+            "in": "path",
+            "name": "ticker",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "x-polygon-go-id": "Ticker"
+          },
+          {
+            "description": "The resolution of the aggregates. Possible values are 1Min, 5Min, 15Min, 30Min, 1H, 1D.",
+            "example": "1min",
+            "in": "query",
+            "name": "resolution",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Query by window start timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.",
+            "in": "query",
+            "name": "window_start",
+            "schema": {
+              "type": "string"
+            },
+            "x-polygon-filter-field": {
+              "range": true
+            }
+          },
+          {
+            "description": "Range by window_start.",
+            "in": "query",
+            "name": "window_start.gte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by window_start.",
+            "in": "query",
+            "name": "window_start.gt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by window_start.",
+            "in": "query",
+            "name": "window_start.lte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by window_start.",
+            "in": "query",
+            "name": "window_start.lt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Order results based on the `sort` field.",
+            "in": "query",
+            "name": "order",
+            "schema": {
+              "default": "desc",
+              "enum": [
+                "asc",
+                "desc"
+              ],
+              "example": "asc",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Limit the number of results returned, default is 1000 and max is 50000.",
+            "in": "query",
+            "name": "limit",
+            "schema": {
+              "default": 1000,
+              "example": 10,
+              "maximum": 50000,
+              "minimum": 1,
+              "type": "integer"
+            }
+          },
+          {
+            "description": "Sort field used for ordering.",
+            "in": "query",
+            "name": "sort",
+            "schema": {
+              "default": "timestamp",
+              "enum": [
+                "timestamp"
+              ],
+              "example": "timestamp",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "example": {
+                  "request_id": "abc123def456ghi789abc123def456de",
+                  "status": "OK"
+                },
+                "schema": {
+                  "properties": {
+                    "next_url": {
+                      "description": "If present, the URL to the next page of results.",
+                      "type": "string"
+                    },
+                    "results": {
+                      "items": {
+                        "properties": {
+                          "close": {
+                            "description": "The last price within the timeframe.",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "dollar_volume": {
+                            "description": "The total dollar volume of the transactions that occurred within the timeframe.",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "high": {
+                            "description": "The highest price within the timeframe.",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "low": {
+                            "description": "The lowest price within the timeframe.",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "open": {
+                            "description": "The opening price within the timeframe.",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "ticker": {
+                            "description": "The ticker for the contract.",
+                            "type": "string"
+                          },
+                          "transaction_count": {
+                            "description": "The number of transactions that occurred within the timeframe.",
+                            "format": "int64",
+                            "type": "integer"
+                          },
+                          "underlying_asset": {
+                            "description": "The underlying asset or commodity for which this contract is derived from.",
+                            "type": "string"
+                          },
+                          "volume": {
+                            "description": "The number of contracts that traded within the timeframe.",
+                            "format": "int64",
+                            "type": "integer"
+                          },
+                          "window_end": {
+                            "description": "The end of the window for this aggregate.",
+                            "format": "int64",
+                            "type": "integer",
+                            "x-polygon-go-type": {
+                              "name": "INanoseconds",
+                              "path": "github.com/polygon-io/ptime"
+                            }
+                          },
+                          "window_start": {
+                            "description": "The start of the window for this aggregate.",
+                            "format": "int64",
+                            "type": "integer",
+                            "x-polygon-go-type": {
+                              "name": "INanoseconds",
+                              "path": "github.com/polygon-io/ptime"
+                            }
+                          }
+                        },
+                        "type": "object"
+                      },
+                      "type": "array"
+                    },
+                    "status": {
+                      "description": "The status of the response.",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              }
+            },
+            "description": "A list of aggregates."
+          }
+        },
+        "summary": "Aggregates",
+        "tags": [
+          "futures:aggregates"
+        ],
+        "x-polygon-entitlement-data-type": {
+          "description": "Aggregate data",
+          "name": "aggregates"
+        },
+        "x-polygon-entitlement-market-type": {
+          "description": "Futures data",
+          "name": "futures"
+        },
+        "x-polygon-paginate": {
+          "limit": {
+            "default": 1000,
+            "example": 10,
+            "max": 50000
+          },
+          "order": {
+            "default": "desc"
+          },
+          "sort": {
+            "default": "timestamp",
+            "enum": [
+              "timestamp"
+            ]
+          }
+        }
+      },
+      "x-polygon-draft": true
+    },
+    "/futures/vX/quotes/{ticker}": {
+      "get": {
+        "description": "Get quotes for a contract in a given time range.",
+        "operationId": "Quotes",
+        "parameters": [
+          {
+            "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ4 for the December 2024 S&P 500 E-mini contract).",
+            "example": "ESZ4",
+            "in": "path",
+            "name": "ticker",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "x-polygon-go-id": "Ticker"
+          },
+          {
+            "description": "Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.",
+            "in": "query",
+            "name": "timestamp",
+            "schema": {
+              "type": "string"
+            },
+            "x-polygon-filter-field": {
+              "range": true
+            }
+          },
+          {
+            "description": "Query by session start date",
+            "in": "query",
+            "name": "session_start_date",
+            "schema": {
+              "type": "string"
+            },
+            "x-polygon-filter-field": {
+              "range": true
+            }
+          },
+          {
+            "description": "Range by timestamp.",
+            "in": "query",
+            "name": "timestamp.gte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by timestamp.",
+            "in": "query",
+            "name": "timestamp.gt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by timestamp.",
+            "in": "query",
+            "name": "timestamp.lte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by timestamp.",
+            "in": "query",
+            "name": "timestamp.lt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by session_start_date.",
+            "in": "query",
+            "name": "session_start_date.gte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by session_start_date.",
+            "in": "query",
+            "name": "session_start_date.gt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by session_start_date.",
+            "in": "query",
+            "name": "session_start_date.lte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by session_start_date.",
+            "in": "query",
+            "name": "session_start_date.lt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Order results based on the `sort` field.",
+            "in": "query",
+            "name": "order",
+            "schema": {
+              "default": "desc",
+              "enum": [
+                "asc",
+                "desc"
+              ],
+              "example": "asc",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Limit the number of results returned, default is 1000 and max is 50000.",
+            "in": "query",
+            "name": "limit",
+            "schema": {
+              "default": 1000,
+              "example": 10,
+              "maximum": 50000,
+              "minimum": 1,
+              "type": "integer"
+            }
+          },
+          {
+            "description": "Sort field used for ordering.",
+            "in": "query",
+            "name": "sort",
+            "schema": {
+              "default": "timestamp",
+              "enum": [
+                "timestamp"
+              ],
+              "example": "timestamp",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "example": {
+                  "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+                  "results": [
+                    {
+                      "ask_price": 604075,
+                      "ask_size": 6,
+                      "ask_timestamp": 1734467086235923000,
+                      "bid_price": 604075,
+                      "bid_size": 6,
+                      "bid_timestamp": 1734415473057885400,
+                      "session_start_date": "2024-12-17",
+                      "ticker": "ESZ4",
+                      "timestamp": 1734476400002853000
+                    },
+                    {
+                      "ask_price": 604100,
+                      "ask_size": 2,
+                      "ask_timestamp": 1734466901129138400,
+                      "bid_price": 604100,
+                      "bid_size": 2,
+                      "bid_timestamp": 1734415473057885400,
+                      "session_start_date": "2024-12-17",
+                      "ticker": "ESZ4",
+                      "timestamp": 1734466901128680000
+                    }
+                  ],
+                  "status": "OK"
+                },
+                "schema": {
+                  "properties": {
+                    "next_url": {
+                      "description": "If present, this value can be used to fetch the next page of data.",
+                      "type": "string"
+                    },
+                    "results": {
+                      "items": {
+                        "properties": {
+                          "ask_price": {
+                            "description": "The price, per contract, the trade executed at. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "ask_size": {
+                            "description": "The size of a trade (also known as volume).",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "ask_timestamp": {
+                            "description": "The Unix millisecond timestamp.",
+                            "type": "integer",
+                            "x-polygon-go-type": {
+                              "name": "IMilliseconds",
+                              "path": "github.com/polygon-io/ptime"
+                            }
+                          },
+                          "bid_price": {
+                            "description": "The price, per contract, the trade executed at. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "bid_size": {
+                            "description": "The size of a trade (also known as volume).",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "bid_timestamp": {
+                            "description": "The Unix millisecond timestamp.",
+                            "type": "integer",
+                            "x-polygon-go-type": {
+                              "name": "IMilliseconds",
+                              "path": "github.com/polygon-io/ptime"
+                            }
+                          },
+                          "session_start_date": {
+                            "description": "Session start date",
+                            "type": "string"
+                          },
+                          "ticker": {
+                            "description": "ticker of the quote",
+                            "type": "string"
+                          },
+                          "timestamp": {
+                            "description": "The Unix millisecond timestamp.",
+                            "type": "integer",
+                            "x-polygon-go-type": {
+                              "name": "IMilliseconds",
+                              "path": "github.com/polygon-io/ptime"
+                            }
+                          }
+                        },
+                        "required": [
+                          "price",
+                          "size"
+                        ],
+                        "type": "object",
+                        "x-polygon-go-type": {
+                          "name": "Futures"
+                        }
+                      },
+                      "type": "array"
+                    },
+                    "status": {
+                      "description": "The status of this request's response.",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "status"
+                  ],
+                  "type": "object"
+                }
+              }
+            },
+            "description": "A list of quotes."
+          }
+        },
+        "summary": "Quotes",
+        "tags": [
+          "futures:quotes"
+        ],
+        "x-polygon-entitlement-data-type": {
+          "description": "Futures quotes data",
+          "name": "nbbo"
+        },
+        "x-polygon-entitlement-market-type": {
+          "description": "Futures data",
+          "name": "futures"
+        },
+        "x-polygon-paginate": {
+          "limit": {
+            "default": 1000,
+            "example": 10,
+            "max": 50000
+          },
+          "order": {
+            "default": "desc"
+          },
+          "sort": {
+            "default": "timestamp",
+            "enum": [
+              "timestamp"
+            ]
+          }
+        },
+        "x-polygon-replaces": {
+          "date": 1654056060000,
+          "replaces": {
+            "name": "Quotes",
+            "path": "get_v1_us_futures_quotes__ticker___date"
+          }
+        }
+      },
+      "x-polygon-draft": true
+    },
+    "/futures/vX/trades/{ticker}": {
+      "get": {
+        "description": "Get trades for a contract in a given time range.",
+        "operationId": "Trades",
+        "parameters": [
+          {
+            "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ4 for the December 2024 S&P 500 E-mini contract).",
+            "example": "ESZ4",
+            "in": "path",
+            "name": "ticker",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "x-polygon-go-id": "Ticker"
+          },
+          {
+            "description": "Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.",
+            "in": "query",
+            "name": "timestamp",
+            "schema": {
+              "type": "string"
+            },
+            "x-polygon-filter-field": {
+              "range": true
+            }
+          },
+          {
+            "description": "Query by session start date",
+            "in": "query",
+            "name": "session_start_date",
+            "schema": {
+              "type": "string"
+            },
+            "x-polygon-filter-field": {
+              "range": true
+            }
+          },
+          {
+            "description": "Range by timestamp.",
+            "in": "query",
+            "name": "timestamp.gte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by timestamp.",
+            "in": "query",
+            "name": "timestamp.gt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by timestamp.",
+            "in": "query",
+            "name": "timestamp.lte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by timestamp.",
+            "in": "query",
+            "name": "timestamp.lt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by session_start_date.",
+            "in": "query",
+            "name": "session_start_date.gte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by session_start_date.",
+            "in": "query",
+            "name": "session_start_date.gt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by session_start_date.",
+            "in": "query",
+            "name": "session_start_date.lte",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Range by session_start_date.",
+            "in": "query",
+            "name": "session_start_date.lt",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "Order results based on the `sort` field.",
+            "in": "query",
+            "name": "order",
+            "schema": {
+              "default": "desc",
+              "enum": [
+                "asc",
+                "desc"
+              ],
+              "example": "asc",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Limit the number of results returned, default is 1000 and max is 50000.",
+            "in": "query",
+            "name": "limit",
+            "schema": {
+              "default": 1000,
+              "example": 10,
+              "maximum": 50000,
+              "minimum": 1,
+              "type": "integer"
+            }
+          },
+          {
+            "description": "Sort field used for ordering.",
+            "in": "query",
+            "name": "sort",
+            "schema": {
+              "default": "timestamp",
+              "enum": [
+                "timestamp"
+              ],
+              "example": "timestamp",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "example": {
+                  "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+                  "results": [
+                    {
+                      "price": 605400,
+                      "session_start_date": "2024-12-17",
+                      "size": 12,
+                      "ticker": "ESZ4",
+                      "timestamp": 1734484219379895800
+                    },
+                    {
+                      "price": 605412,
+                      "session_start_date": "2024-12-17",
+                      "size": 55,
+                      "ticker": "ESZ4",
+                      "timestamp": 1734484212100118500
+                    },
+                    {
+                      "price": 605544,
+                      "session_start_date": "2024-12-17",
+                      "size": 36,
+                      "ticker": "ESZ4",
+                      "timestamp": 1734484212099944200
+                    }
+                  ],
+                  "status": "OK"
+                },
+                "schema": {
+                  "properties": {
+                    "next_url": {
+                      "description": "If present, this value can be used to fetch the next page of data.",
+                      "type": "string"
+                    },
+                    "results": {
+                      "items": {
+                        "properties": {
+                          "price": {
+                            "description": "The price, per contract, the trade executed at. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "session_start_date": {
+                            "description": "the session start date",
+                            "type": "string"
+                          },
+                          "size": {
+                            "description": "The size of a trade (also known as volume).",
+                            "format": "double",
+                            "type": "number"
+                          },
+                          "ticker": {
+                            "description": "ticker of the trade",
+                            "type": "string"
+                          },
+                          "timestamp": {
+                            "description": "The Unix millisecond timestamp.",
+                            "type": "integer",
+                            "x-polygon-go-type": {
+                              "name": "IMilliseconds",
+                              "path": "github.com/polygon-io/ptime"
+                            }
+                          }
+                        },
+                        "required": [
+                          "price",
+                          "size"
+                        ],
+                        "type": "object",
+                        "x-polygon-go-type": {
+                          "name": "Futures"
+                        }
+                      },
+                      "type": "array"
+                    },
+                    "status": {
+                      "description": "The status of this request's response.",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "status"
+                  ],
+                  "type": "object"
+                }
+              }
+            },
+            "description": "A list of trades."
+          }
+        },
+        "summary": "Trades",
+        "tags": [
+          "futures:trades"
+        ],
+        "x-polygon-entitlement-data-type": {
+          "description": "Futures trade data",
+          "name": "trades"
+        },
+        "x-polygon-entitlement-market-type": {
+          "description": "Futures data",
+          "name": "futures"
+        },
+        "x-polygon-paginate": {
+          "limit": {
+            "default": 1000,
+            "example": 10,
+            "max": 50000
+          },
+          "order": {
+            "default": "desc"
+          },
+          "sort": {
+            "default": "timestamp",
+            "enum": [
+              "timestamp"
+            ]
+          }
+        },
+        "x-polygon-replaces": {
+          "date": 1654056060000,
+          "replaces": {
+            "name": "Trades",
+            "path": "get_v1_us_futures_trades__ticker___date"
+          }
+        }
+      },
+      "x-polygon-draft": true
+    },
     "/v1/conversion/{from}/{to}": {
       "get": {
         "description": "Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD.",
@@ -12415,6 +13242,7 @@
                   "symbol": "BTC-USD"
                 },
                 "schema": {
+                  "description": "Contains the requested trade data for the specified ticker.",
                   "properties": {
                     "last": {
                       "properties": {
@@ -12554,6 +13382,7 @@
                   "symbol": "AUD/USD"
                 },
                 "schema": {
+                  "description": "Contains the requested quote data for the specified ticker.",
                   "properties": {
                     "last": {
                       "properties": {
@@ -14834,6 +15663,7 @@
                             "type": "number"
                           },
                           "session": {
+                            "description": "Comprehensive trading session metrics, detailing price changes, trading volume, and key price points (open, close, high, low) for the asset within the current trading day. Includes specific changes during early, regular, and late trading periods to enable detailed performance analysis and trend tracking.",
                             "properties": {
                               "change": {
                                 "description": "The value of the price change for the asset from the previous trading day.",
@@ -15081,6 +15911,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -15278,6 +16109,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -15483,6 +16315,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -15675,6 +16508,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -15944,6 +16778,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -16387,6 +17222,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -16553,6 +17389,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -16782,6 +17619,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -16952,6 +17790,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -17217,6 +18056,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -17400,6 +18240,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -17665,6 +18506,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -17811,6 +18653,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "Contains the requested quote data for the specified ticker.",
                       "properties": {
                         "P": {
                           "description": "The ask price.",
@@ -17997,6 +18840,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "Contains the requested trade data for the specified ticker.",
                       "properties": {
                         "T": {
                           "description": "The exchange symbol that this item is traded under.",
@@ -18177,6 +19021,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "Contains the requested trade data for the specified ticker.",
                       "properties": {
                         "T": {
                           "description": "The exchange symbol that this item is traded under.",
@@ -18803,6 +19648,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of snapshot data for the specified tickers.",
                       "properties": {
                         "tickers": {
                           "items": {
@@ -19170,6 +20016,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "Contains the requested snapshot data for the specified ticker.",
                       "properties": {
                         "ticker": {
                           "properties": {
@@ -19710,6 +20557,7 @@
                       "type": "string"
                     },
                     {
+                      "description": "An array of snapshot data for the specified tickers.",
                       "properties": {
                         "tickers": {
                           "items": {
@@ -21038,6 +21886,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of snapshot data for the specified tickers.",
                       "properties": {
                         "tickers": {
                           "items": {
@@ -21450,6 +22299,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "Contains the requested snapshot data for the specified ticker.",
                       "properties": {
                         "ticker": {
                           "properties": {
@@ -21859,6 +22709,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of snapshot data for the specified tickers.",
                       "properties": {
                         "tickers": {
                           "items": {
@@ -22937,6 +23788,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "ask_exchange": {
@@ -23170,6 +24022,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "ask_exchange": {
@@ -23422,6 +24275,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "ask_exchange": {
@@ -26989,6 +27843,8 @@
                         "low": 5.42,
                         "open": 6.7,
                         "previous_close": 6.71,
+                        "regular_trading_change": -0.6,
+                        "regular_trading_change_percent": -0.5,
                         "volume": 67
                       },
                       "ticker": "O:NCLH221014C00005000",
@@ -27003,6 +27859,15 @@
                     },
                     {
                       "fmv": 0.05,
+                      "last_minute": {
+                        "close": 412.05,
+                        "high": 412.1,
+                        "low": 412.05,
+                        "open": 412.1,
+                        "transactions": 26,
+                        "volume": 610,
+                        "vwap": 412.0881
+                      },
                       "last_quote": {
                         "ask": 21.25,
                         "ask_exchange": 300,
@@ -27058,9 +27923,11 @@
                       "type": "string"
                     },
                     "request_id": {
+                      "description": "A request id assigned by the server.",
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "break_even_price": {
@@ -27319,6 +28183,7 @@
                             "type": "number"
                           },
                           "session": {
+                            "description": "Comprehensive trading session metrics, detailing price changes, trading volume, and key price points (open, close, high, low) for the asset within the current trading day. Includes specific changes during early, regular, and late trading periods to enable detailed performance analysis and trend tracking.",
                             "properties": {
                               "change": {
                                 "description": "The value of the price change for the asset from the previous trading day.",
@@ -28070,10 +28935,13 @@
                       "type": "string"
                     },
                     "request_id": {
+                      "description": "A request id assigned by the server.",
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
+                        "description": "Contains the requested snapshot data for the specified contract.",
                         "properties": {
                           "break_even_price": {
                             "description": "The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid).",
@@ -28516,7 +29380,7 @@
           },
           {
             "description": "The option contract identifier.",
-            "example": "O:EVRI240920P00012500",
+            "example": "O:EVRI260116C00015000",
             "in": "path",
             "name": "optionContract",
             "required": true,
@@ -28600,9 +29464,11 @@
                       "type": "string"
                     },
                     "request_id": {
+                      "description": "A request id assigned by the server.",
                       "type": "string"
                     },
                     "results": {
+                      "description": "Contains the requested snapshot data for the specified contract.",
                       "properties": {
                         "break_even_price": {
                           "description": "The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid).",
@@ -29154,6 +30017,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "conditions": {
@@ -29399,6 +30263,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "conditions": {
@@ -29657,6 +30522,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "conditions": {
@@ -30602,7 +31468,7 @@
                 "asc",
                 "desc"
               ],
-              "example": "asc",
+              "example": "desc",
               "type": "string"
             }
           },
@@ -30643,7 +31509,8 @@
                 "primary_exchange",
                 "lot_size",
                 "security_description",
-                "ipo_status"
+                "ipo_status",
+                "announced_date"
               ],
               "example": "listing_date",
               "type": "string"
@@ -30659,6 +31526,7 @@
                   "request_id": "6a7e466379af0a71039d60cc78e72282",
                   "results": [
                     {
+                      "announced_date": "2024-06-01",
                       "currency_code": "USD",
                       "final_issue_price": 17,
                       "highest_offer_price": 17,
@@ -30698,6 +31566,12 @@
                       "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
+                          "announced_date": {
+                            "description": "The date when the IPO event was announced.",
+                            "example": "2023-01-01",
+                            "format": "date",
+                            "type": "string"
+                          },
                           "currency_code": {
                             "description": "Underlying currency of the security.",
                             "example": "USD",
@@ -30810,12 +31684,11 @@
                           }
                         },
                         "required": [
-                          "name",
                           "last_updated",
-                          "primary_exchange",
+                          "issuer_name",
                           "security_type",
-                          "security_description",
-                          "ipo_status"
+                          "ipo_status",
+                          "ticker"
                         ],
                         "type": "object",
                         "x-polygon-go-type": {
@@ -30850,7 +31721,8 @@
             "max": 1000
           },
           "order": {
-            "default": "desc"
+            "default": "desc",
+            "example": "desc"
           },
           "sort": {
             "default": "listing_date",
@@ -30873,7 +31745,8 @@
               "primary_exchange",
               "lot_size",
               "security_description",
-              "ipo_status"
+              "ipo_status",
+              "announced_date"
             ]
           }
         }
@@ -31024,7 +31897,7 @@
                             "type": "string"
                           },
                           "tag": {
-                            "description": "A specific type within a category. For example \u201cproduct_sales\u201d is a type of revenue stream. A company may have multiple tags within a given category. A taxonomy of tags are determined based on 10k filings.",
+                            "description": "A specific type within a category. For example “product_sales” is a type of revenue stream. A company may have multiple tags within a given category. A taxonomy of tags are determined based on 10k filings.",
                             "type": "string"
                           },
                           "ticker": {
@@ -31728,6 +32601,16 @@
             "/v1/indicators/macd/{stockTicker}",
             "/v1/indicators/rsi/{stockTicker}"
           ]
+        },
+        {
+          "paths": [
+            "/futures/vX/quotes/{ticker}"
+          ]
+        },
+        {
+          "paths": [
+            "/futures/vX/trades/{ticker}"
+          ]
         }
       ],
       "reference": [
@@ -31824,6 +32707,36 @@
           "paths": [
             "/vX/reference/short-interest/{identifier_type}/{identifier}"
           ]
+        },
+        {
+          "paths": [
+            "/futures/vX/contracts"
+          ]
+        },
+        {
+          "paths": [
+            "/futures/vX/contracts/{ticker}"
+          ]
+        },
+        {
+          "paths": [
+            "/futures/vX/schedules"
+          ]
+        },
+        {
+          "paths": [
+            "/futures/vX/schedules/{product_code}"
+          ]
+        },
+        {
+          "paths": [
+            "/futures/vX/products"
+          ]
+        },
+        {
+          "paths": [
+            "/futures/vX/products/{product_code}"
+          ]
         }
       ]
     }
@client-library-maintainer client-library-maintainer bot added the spec The client may need an update due to API spec changes label Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec The client may need an update due to API spec changes
Projects
None yet
Development

No branches or pull requests

0 participants