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 #278

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

Client update needed to match REST spec changes #278

client-library-maintainer bot opened this issue Feb 3, 2025 · 0 comments
Labels

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-jvm/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": {
@@ -12415,6 +12434,7 @@
                   "symbol": "BTC-USD"
                 },
                 "schema": {
+                  "description": "Contains the requested trade data for the specified ticker.",
                   "properties": {
                     "last": {
                       "properties": {
@@ -12554,6 +12574,7 @@
                   "symbol": "AUD/USD"
                 },
                 "schema": {
+                  "description": "Contains the requested quote data for the specified ticker.",
                   "properties": {
                     "last": {
                       "properties": {
@@ -14834,6 +14855,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 +15103,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -15278,6 +15301,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -15483,6 +15507,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -15675,6 +15700,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -15944,6 +15970,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -16387,6 +16414,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -16553,6 +16581,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -16782,6 +16811,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -16952,6 +16982,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -17217,6 +17248,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -17400,6 +17432,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -17665,6 +17698,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of results containing the requested data.",
                       "properties": {
                         "results": {
                           "items": {
@@ -17811,6 +17845,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "Contains the requested quote data for the specified ticker.",
                       "properties": {
                         "P": {
                           "description": "The ask price.",
@@ -17997,6 +18032,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 +18213,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 +18840,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of snapshot data for the specified tickers.",
                       "properties": {
                         "tickers": {
                           "items": {
@@ -19170,6 +19208,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "Contains the requested snapshot data for the specified ticker.",
                       "properties": {
                         "ticker": {
                           "properties": {
@@ -19710,6 +19749,7 @@
                       "type": "string"
                     },
                     {
+                      "description": "An array of snapshot data for the specified tickers.",
                       "properties": {
                         "tickers": {
                           "items": {
@@ -21038,6 +21078,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of snapshot data for the specified tickers.",
                       "properties": {
                         "tickers": {
                           "items": {
@@ -21450,6 +21491,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "Contains the requested snapshot data for the specified ticker.",
                       "properties": {
                         "ticker": {
                           "properties": {
@@ -21859,6 +21901,7 @@
                       "type": "object"
                     },
                     {
+                      "description": "An array of snapshot data for the specified tickers.",
                       "properties": {
                         "tickers": {
                           "items": {
@@ -22937,6 +22980,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "ask_exchange": {
@@ -23170,6 +23214,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "ask_exchange": {
@@ -23422,6 +23467,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "ask_exchange": {
@@ -26989,6 +27035,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 +27051,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 +27115,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 +27375,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 +28127,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 +28572,7 @@
           },
           {
             "description": "The option contract identifier.",
-            "example": "O:EVRI240920P00012500",
+            "example": "O:EVRI260116C00015000",
             "in": "path",
             "name": "optionContract",
             "required": true,
@@ -28600,9 +28656,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 +29209,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "conditions": {
@@ -29399,6 +29455,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "conditions": {
@@ -29657,6 +29714,7 @@
                       "type": "string"
                     },
                     "results": {
+                      "description": "An array of results containing the requested data.",
                       "items": {
                         "properties": {
                           "conditions": {
@@ -30602,7 +30660,7 @@
                 "asc",
                 "desc"
               ],
-              "example": "asc",
+              "example": "desc",
               "type": "string"
             }
           },
@@ -30643,7 +30701,8 @@
                 "primary_exchange",
                 "lot_size",
                 "security_description",
-                "ipo_status"
+                "ipo_status",
+                "announced_date"
               ],
               "example": "listing_date",
               "type": "string"
@@ -30659,6 +30718,7 @@
                   "request_id": "6a7e466379af0a71039d60cc78e72282",
                   "results": [
                     {
+                      "announced_date": "2024-06-01",
                       "currency_code": "USD",
                       "final_issue_price": 17,
                       "highest_offer_price": 17,
@@ -30691,11 +30751,19 @@
                       "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": {
+                          "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",
@@ -30714,7 +30777,7 @@
                             "type": "number"
                           },
                           "ipo_status": {
-                            "description": "The status of the IPO event.",
+                            "description": "The status of the IPO event. IPO events start out as status \"rumor\" or \"pending\". On listing day, the status changes to \"new\". After the listing day, the status changes to \"history\".\n\nThe status \"direct_listing_process\" corresponds to a type of offering where, instead of going through all the IPO processes, the company decides to list its shares directly on an exchange, without using an investment bank or other intermediaries. This is called a direct listing, direct placement, or direct public offering (DPO).",
                             "enum": [
                               "direct_listing_process",
                               "history",
@@ -30808,12 +30871,11 @@
                           }
                         },
                         "required": [
-                          "name",
                           "last_updated",
-                          "primary_exchange",
+                          "issuer_name",
                           "security_type",
-                          "security_description",
-                          "ipo_status"
+                          "ipo_status",
+                          "ticker"
                         ],
                         "type": "object",
                         "x-polygon-go-type": {
@@ -30848,7 +30908,8 @@
             "max": 1000
           },
           "order": {
-            "default": "desc"
+            "default": "desc",
+            "example": "desc"
           },
           "sort": {
             "default": "listing_date",
@@ -30871,7 +30932,8 @@
               "primary_exchange",
               "lot_size",
               "security_description",
-              "ipo_status"
+              "ipo_status",
+              "announced_date"
             ]
           }
         }
@@ -31022,7 +31084,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": {
@@ -31726,6 +31788,16 @@
             "/v1/indicators/macd/{stockTicker}",
             "/v1/indicators/rsi/{stockTicker}"
           ]
+        },
+        {
+          "paths": [
+            "/futures/vX/quotes/{ticker}"
+          ]
+        },
+        {
+          "paths": [
+            "/futures/vX/trades/{ticker}"
+          ]
         }
       ],
       "reference": [
@@ -31822,6 +31894,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}"
+          ]
         }
       ]
     }
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

0 participants