polygon-io / client-jvm

The official JVM client library SDK, written in Kotlin, for accessing the Polygon REST and WebSocket API.
49 stars 33 forks source link

Client update needed to match REST spec changes #218

Open client-library-maintainer[bot] opened 1 month ago

client-library-maintainer[bot] commented 1 month ago

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
@@ -63,7 +63,7 @@
       },
       "AggregateTimeTo": {
         "description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.",
-        "example": "2023-01-09",
+        "example": "2023-02-10",
         "in": "path",
         "name": "to",
         "required": true,
@@ -153,7 +153,7 @@
       },
       "IndicesAggregateTimeFrom": {
         "description": "The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.",
-        "example": "2023-03-10",
+        "example": "2023-03-13",
         "in": "path",
         "name": "from",
         "required": true,
@@ -163,7 +163,7 @@
       },
       "IndicesAggregateTimeTo": {
         "description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.",
-        "example": "2023-03-10",
+        "example": "2023-03-24",
         "in": "path",
         "name": "to",
         "required": true,
@@ -13911,8 +13911,7 @@
                           "files_count",
                           "source_url",
                           "download_url",
-                          "entities",
-                          "acceptance_datetime"
+                          "entities"
                         ],
                         "type": "object",
                         "x-polygon-go-type": {
@@ -13982,121 +13981,125 @@
                 "example": {},
                 "schema": {
                   "properties": {
-                    "acceptance_datetime": {
-                      "description": "The datetime when the filing was accepted by EDGAR in EST (format: YYYYMMDDHHMMSS)",
-                      "type": "string"
-                    },
-                    "accession_number": {
-                      "description": "Filing Accession Number",
-                      "type": "string"
-                    },
-                    "entities": {
-                      "description": "Entities related to the filing (e.g. the document filers).",
-                      "items": {
-                        "description": "A filing entity (e.g. the document filer).",
-                        "properties": {
-                          "company_data": {
+                    "results": {
+                      "properties": {
+                        "acceptance_datetime": {
+                          "description": "The datetime when the filing was accepted by EDGAR in EST (format: YYYYMMDDHHMMSS)",
+                          "type": "string"
+                        },
+                        "accession_number": {
+                          "description": "Filing Accession Number",
+                          "type": "string"
+                        },
+                        "entities": {
+                          "description": "Entities related to the filing (e.g. the document filers).",
+                          "items": {
+                            "description": "A filing entity (e.g. the document filer).",
                             "properties": {
-                              "cik": {
-                                "description": "Central Index Key (CIK) Number",
-                                "type": "string"
+                              "company_data": {
+                                "properties": {
+                                  "cik": {
+                                    "description": "Central Index Key (CIK) Number",
+                                    "type": "string"
+                                  },
+                                  "name": {
+                                    "example": "Facebook Inc",
+                                    "type": "string"
+                                  },
+                                  "sic": {
+                                    "description": "Standard Industrial Classification (SIC)",
+                                    "type": "string"
+                                  },
+                                  "ticker": {
+                                    "description": "Ticker",
+                                    "type": "string"
+                                  }
+                                },
+                                "required": [
+                                  "name",
+                                  "cik",
+                                  "sic"
+                                ],
+                                "type": "object",
+                                "x-polygon-go-type": {
+                                  "name": "SECCompanyData",
+                                  "path": "github.com/polygon-io/go-lib-models/v2/globals"
+                                }
                               },
-                              "name": {
-                                "example": "Facebook Inc",
+                              "relation": {
+                                "description": "Relationship of this entity to the filing.",
+                                "enum": [
+                                  "filer"
+                                ],
                                 "type": "string"
-                              },
-                              "sic": {
-                                "description": "Standard Industrial Classification (SIC)",
-                                "type": "string"
-                              },
-                              "ticker": {
-                                "description": "Ticker",
-                                "type": "string"
                               }
                             },
                             "required": [
-                              "name",
-                              "cik",
-                              "sic"
+                              "relation"
                             ],
                             "type": "object",
                             "x-polygon-go-type": {
-                              "name": "SECCompanyData",
+                              "name": "SECFilingEntity",
                               "path": "github.com/polygon-io/go-lib-models/v2/globals"
                             }
                           },
-                          "relation": {
-                            "description": "Relationship of this entity to the filing.",
-                            "enum": [
-                              "filer"
-                            ],
-                            "type": "string"
-                          }
+                          "type": "array"
                         },
-                        "required": [
-                          "relation"
-                        ],
-                        "type": "object",
-                        "x-polygon-go-type": {
-                          "name": "SECFilingEntity",
-                          "path": "github.com/polygon-io/go-lib-models/v2/globals"
+                        "files_count": {
+                          "description": "The number of files associated with the filing.",
+                          "format": "int64",
+                          "type": "integer"
+                        },
+                        "filing_date": {
+                          "description": "The date when the filing was filed in YYYYMMDD format.",
+                          "example": "20210101",
+                          "pattern": "^[0-9]{8}$",
+                          "type": "string"
+                        },
+                        "id": {
+                          "description": "Unique identifier for the filing.",
+                          "type": "string"
+                        },
+                        "period_of_report_date": {
+                          "description": "The period of report for the filing in YYYYMMDD format.",
+                          "example": "20210101",
+                          "pattern": "^[0-9]{8}$",
+                          "type": "string"
+                        },
+                        "source_url": {
+                          "description": "The source URL is a link back to the upstream source for this filing\ndocument.",
+                          "example": "https://www.sec.gov/Archives/edgar/data/0001326801/000132680119000037/0001326801-19-000037-index.html",
+                          "format": "uri",
+                          "type": "string"
+                        },
+                        "type": {
+                          "description": "Filing Type",
+                          "enum": [
+                            "10-K",
+                            "10-Q"
+                          ],
+                          "type": "string"
                         }
                       },
-                      "type": "array"
-                    },
-                    "files_count": {
-                      "description": "The number of files associated with the filing.",
-                      "format": "int64",
-                      "type": "integer"
-                    },
-                    "filing_date": {
-                      "description": "The date when the filing was filed in YYYYMMDD format.",
-                      "example": "20210101",
-                      "pattern": "^[0-9]{8}$",
-                      "type": "string"
-                    },
-                    "id": {
-                      "description": "Unique identifier for the filing.",
-                      "type": "string"
-                    },
-                    "period_of_report_date": {
-                      "description": "The period of report for the filing in YYYYMMDD format.",
-                      "example": "20210101",
-                      "pattern": "^[0-9]{8}$",
-                      "type": "string"
-                    },
-                    "source_url": {
-                      "description": "The source URL is a link back to the upstream source for this filing\ndocument.",
-                      "example": "https://www.sec.gov/Archives/edgar/data/0001326801/000132680119000037/0001326801-19-000037-index.html",
-                      "format": "uri",
-                      "type": "string"
-                    },
-                    "type": {
-                      "description": "Filing Type",
-                      "enum": [
-                        "10-K",
-                        "10-Q"
+                      "required": [
+                        "id",
+                        "accession_number",
+                        "type",
+                        "filing_date",
+                        "period_of_report_date",
+                        "files_count",
+                        "source_url",
+                        "download_url",
+                        "entities"
                       ],
-                      "type": "string"
+                      "type": "object",
+                      "x-polygon-go-type": {
+                        "name": "SECFiling",
+                        "path": "github.com/polygon-io/go-lib-models/v2/globals"
+                      }
                     }
                   },
-                  "required": [
-                    "id",
-                    "accession_number",
-                    "type",
-                    "filing_date",
-                    "period_of_report_date",
-                    "files_count",
-                    "source_url",
-                    "download_url",
-                    "entities",
-                    "acceptance_datetime"
-                  ],
-                  "type": "object",
-                  "x-polygon-go-type": {
-                    "name": "SECFiling",
-                    "path": "github.com/polygon-io/go-lib-models/v2/globals"
-                  }
+                  "type": "object"
                 }
               }
             },
@@ -14487,6 +14472,114 @@
       },
       "x-polygon-draft": true
     },
+    "/v1/related-companies/{ticker}": {
+      "get": {
+        "description": "Get a list of tickers related to the queried ticker based on News and Returns data.",
+        "operationId": "GetRelatedCompanies",
+        "parameters": [
+          {
+            "description": "The ticker symbol to search.",
+            "example": "AAPL",
+            "in": "path",
+            "name": "ticker",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "example": {
+                  "request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
+                  "results": [
+                    {
+                      "ticker": "MSFT"
+                    },
+                    {
+                      "ticker": "GOOGL"
+                    },
+                    {
+                      "ticker": "AMZN"
+                    },
+                    {
+                      "ticker": "FB"
+                    },
+                    {
+                      "ticker": "TSLA"
+                    },
+                    {
+                      "ticker": "NVDA"
+                    },
+                    {
+                      "ticker": "INTC"
+                    },
+                    {
+                      "ticker": "ADBE"
+                    },
+                    {
+                      "ticker": "NFLX"
+                    },
+                    {
+                      "ticker": "PYPL"
+                    }
+                  ],
+                  "status": "OK",
+                  "stock_symbol": "AAPL"
+                },
+                "schema": {
+                  "properties": {
+                    "request_id": {
+                      "description": "A request id assigned by the server.",
+                      "type": "string"
+                    },
+                    "results": {
+                      "items": {
+                        "description": "The tickers related to the requested ticker.",
+                        "properties": {
+                          "ticker": {
+                            "description": "A ticker related to the requested ticker.",
+                            "type": "string"
+                          }
+                        },
+                        "required": [
+                          "ticker"
+                        ],
+                        "type": "object"
+                      },
+                      "type": "array"
+                    },
+                    "status": {
+                      "description": "The status of this request's response.",
+                      "type": "string"
+                    },
+                    "ticker": {
+                      "description": "The ticker being queried.",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              }
+            },
+            "description": "Related Companies."
+          },
+          "401": {
+            "description": "Unauthorized - Check our API Key and account status"
+          }
+        },
+        "summary": "Related Companies",
+        "tags": [
+          "reference:related:companies"
+        ],
+        "x-polygon-entitlement-data-type": {
+          "description": "Reference data",
+          "name": "reference"
+        }
+      }
+    },
     "/v1/summaries": {
       "get": {
         "description": "Get everything needed to visualize the tick-by-tick movement of a list of tickers.",
@@ -15711,7 +15804,7 @@
           },
           {
             "description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.",
-            "example": "2023-01-09",
+            "example": "2023-02-10",
             "in": "path",
             "name": "to",
             "required": true,
@@ -16164,7 +16257,7 @@
           },
           {
             "description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.",
-            "example": "2023-01-09",
+            "example": "2023-02-10",
             "in": "path",
             "name": "to",
             "required": true,
@@ -16560,7 +16653,7 @@
           },
           {
             "description": "The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.",
-            "example": "2023-03-10",
+            "example": "2023-03-13",
             "in": "path",
             "name": "from",
             "required": true,
@@ -16570,7 +16663,7 @@
           },
           {
             "description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.",
-            "example": "2023-03-10",
+            "example": "2023-03-24",
             "in": "path",
             "name": "to",
             "required": true,
@@ -16983,7 +17076,7 @@
           },
           {
             "description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.",
-            "example": "2023-01-09",
+            "example": "2023-02-10",
             "in": "path",
             "name": "to",
             "required": true,
@@ -17431,7 +17524,7 @@
           },
           {
             "description": "The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.",
-            "example": "2023-01-09",
+            "example": "2023-02-10",
             "in": "path",
             "name": "to",
             "required": true,
@@ -18201,7 +18294,7 @@
         "operationId": "ListNews",
         "parameters": [
           {
-            "description": "Return results that contain this ticker.",
+            "description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.",
             "in": "query",
             "name": "ticker",
             "schema": {
@@ -18385,52 +18478,35 @@
                   "request_id": "831afdb0b8078549fed053476984947a",
                   "results": [
                     {
-                      "amp_url": "https://amp.benzinga.com/amp/content/20784086",
-                      "article_url": "https://www.benzinga.com/markets/cryptocurrency/21/04/20784086/cathie-wood-adds-more-coinbase-skillz-trims-square",
-                      "author": "Rachit  Vats",
-                      "description": "<p>Cathie Wood-led Ark Investment Management on Friday snapped up another 221,167 shares of the cryptocurrency exchange <strong>Coinbase Global Inc </strong>(NASDAQ <a class=\"ticker\" href=\"https://www.benzinga.com/stock/coin#NASDAQ\">COIN</a>) worth about $64.49 million on the stock&rsquo;s Friday&rsquo;s dip and also its fourth-straight loss.</p>\n<p>The investment firm&rsquo;s <strong>Ark Innovation ETF</strong> (NYSE <a class=\" ticker\" href=\"https://www.benzinga.com/stock/arkk#NYSE\">ARKK</a>) bought the shares of the company that closed 0.63% lower at $291.60 on Friday, giving the cryptocurrency exchange a market cap of $58.09 billion. Coinbase&rsquo;s market cap has dropped from $85.8 billion on its blockbuster listing earlier this month.</p>\n<p>The New York-based company also added another 3,873 shares of the mobile gaming company <strong>Skillz Inc</strong> (NYSE <a class=\" ticker\" href=\"https://www.benzinga.com/stock/sklz#NYSE\">SKLZ</a>), <a href=\"http://www.benzinga.com/markets/cryptocurrency/21/04/20762794/cathie-woods-ark-loads-up-another-1-2-million-shares-in-skillz-also-adds-coinbase-draftkin\" >just a day after</a> snapping 1.2 million shares of the stock.</p>\n <p>ARKK bought the shares of the company which closed ...</p><p><a href=https://www.benzinga.com/markets/cryptocurrency/21/04/20784086/cathie-wood-adds-more-coinbase-skillz-trims-square alt=Cathie Wood Adds More Coinbase, Skillz, Trims Square>Full story available on Benzinga.com</a></p>",
-                      "id": "nJsSJJdwViHZcw5367rZi7_qkXLfMzacXBfpv-vD9UA",
-                      "image_url": "https://cdn2.benzinga.com/files/imagecache/og_image_social_share_1200x630/images/story/2012/andre-francois-mckenzie-auhr4gcqcce-unsplash.jpg?width=720",
+                      "amp_url": "https://m.uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968?ampMode=1",
+                      "article_url": "https://uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968",
+                      "author": "Sam Boughedda",
+                      "description": "UBS analysts warn that markets are underestimating the extent of future interest rate cuts by the Federal Reserve, as the weakening economy is likely to justify more cuts than currently anticipated.",
+                      "id": "8ec638777ca03b553ae516761c2a22ba2fdd2f37befae3ab6fdab74e9e5193eb",
+                      "image_url": "https://i-invdn-com.investing.com/news/LYNXNPEC4I0AL_L.jpg",
+                      "insights": [
+                        {
+                          "sentiment": "positive",
+                          "sentiment_reasoning": "UBS analysts are providing a bullish outlook on the extent of future Federal Reserve rate cuts, suggesting that markets are underestimating the number of cuts that will occur.",
+                          "ticker": "UBS"
+                        }
+                      ],
                       "keywords": [
-                        "Sector ETFs",
-                        "Penny Stocks",
-                        "Cryptocurrency",
-                        "Small Cap",
-                        "Markets",
-                        "Trading Ideas",
-                        "ETFs"
+                        "Federal Reserve",
+                        "interest rates",
+                        "economic data"
                       ],
-                      "published_utc": "2021-04-26T02:33:17Z",
+                      "published_utc": "2024-06-24T18:33:53Z",
                       "publisher": {
-                        "favicon_url": "https://s3.polygon.io/public/public/assets/news/favicons/benzinga.ico",
-                        "homepage_url": "https://www.benzinga.com/",
-                        "logo_url": "https://s3.polygon.io/public/public/assets/news/logos/benzinga.svg",
-                        "name": "Benzinga"
+                        "favicon_url": "https://s3.polygon.io/public/assets/news/favicons/investing.ico",
+                        "homepage_url": "https://www.investing.com/",
+                        "logo_url": "https://s3.polygon.io/public/assets/news/logos/investing.png",
+                        "name": "Investing.com"
                       },
                       "tickers": [
-                        "DOCU",
-                        "DDD",
-                        "NIU",
-                        "ARKF",
-                        "NVDA",
-                        "SKLZ",
-                        "PCAR",
-                        "MASS",
-                        "PSTI",
-                        "SPFR",
-                        "TREE",
-                        "PHR",
-                        "IRDM",
-                        "BEAM",
-                        "ARKW",
-                        "ARKK",
-                        "ARKG",
-                        "PSTG",
-                        "SQ",
-                        "IONS",
-                        "SYRS"
+                        "UBS"
                       ],
-                      "title": "Cathie Wood Adds More Coinbase, Skillz, Trims Square"
+                      "title": "Markets are underestimating Fed cuts: UBS By Investing.com - Investing.com UK"
                     }
                   ],
                   "status": "OK"
@@ -18476,6 +18546,32 @@
                             "description": "The article's image URL.",
                             "type": "string"
                           },
+                          "insights": {
+                            "description": "The insights related to the article.",
+                            "items": {
+                              "properties": {
+                                "sentiment": {
+                                  "description": "The sentiment of the insight.",
+                                  "type": "string"
+                                },
+                                "sentiment_reasoning": {
+                                  "description": "The reasoning behind the sentiment.",
+                                  "type": "string"
+                                },
+                                "ticker": {
+                                  "description": "The ticker symbol associated with the insight.",
+                                  "type": "string"
+                                }
+                              },
+                              "required": [
+                                "ticker",
+                                "sentiment",
+                                "sentiment_reasoning"
+                              ],
+                              "type": "object"
+                            },
+                            "type": "array"
+                          },
                           "keywords": {
                             "description": "The keywords associated with the article (which will vary depending on\nthe publishing source).",
                             "items": {
@@ -18556,7 +18652,7 @@
                 }
               },
               "text/csv": {
-                "example": "id,publisher_name,publisher_homepage_url,publisher_logo_url,publisher_favicon_url,title,author,published_utc,article_url,tickers,amp_url,image_url,description,keywords\nnJsSJJdwViHZcw5367rZi7_qkXLfMzacXBfpv-vD9UA,Benzinga,https://www.benzinga.com/,https://s3.polygon.io/public/public/assets/news/logos/benzinga.svg,https://s3.polygon.io/public/public/assets/news/favicons/benzinga.ico,\"Cathie Wood Adds More Coinbase, Skillz, Trims Square\",Rachit  Vats,2021-04-26T02:33:17Z,https://www.benzinga.com/markets/cryptocurrency/21/04/20784086/cathie-wood-adds-more-coinbase-skillz-trims-square,\"DOCU,DDD,NIU,ARKF,NVDA,SKLZ,PCAR,MASS,PSTI,SPFR,TREE,PHR,IRDM,BEAM,ARKW,ARKK,ARKG,PSTG,SQ,IONS,SYRS\",https://amp.benzinga.com/amp/content/20784086,https://cdn2.benzinga.com/files/imagecache/og_image_social_share_1200x630/images/story/2012/andre-francois-mckenzie-auhr4gcqcce-unsplash.jpg?width=720,\"<p>Cathie Wood-led Ark Investment Management on Friday snapped up another 221,167 shares of the cryptocurrency exchange <strong>Coinbase Global Inc </strong>(NASDAQ <a class=\\\"ticker\\\" href=\\\"https://www.benzinga.com/stock/coin#NASDAQ\\\">COIN</a>) worth about $64.49 million on the stock&rsquo;s Friday&rsquo;s dip and also its fourth-straight loss.</p> <p>The investment firm&rsquo;s <strong>Ark Innovation ETF</strong> (NYSE <a class=\\\" ticker\\\" href=\\\"https://www.benzinga.com/stock/arkk#NYSE\\\">ARKK</a>) bought the shares of the company that closed 0.63% lower at $291.60 on Friday, giving the cryptocurrency exchange a market cap of $58.09 billion. Coinbase&rsquo;s market cap has dropped from $85.8 billion on its blockbuster listing earlier this month.</p> <p>The New York-based company also added another 3,873 shares of the mobile gaming company <strong>Skillz Inc</strong> (NYSE <a class=\\\" ticker\\\" href=\\\"https://www.benzinga.com/stock/sklz#NYSE\\\">SKLZ</a>), <a href=\\\"http://www.benzinga.com/markets/cryptocurrency/21/04/20762794/cathie-woods-ark-loads-up-another-1-2-million-shares-in-skillz-also-adds-coinbase-draftkin\\\" >just a day after</a> snapping 1.2 million shares of the stock.</p> <p>ARKK bought the shares of the company which closed ...</p><p><a href=https://www.benzinga.com/markets/cryptocurrency/21/04/20784086/cathie-wood-adds-more-coinbase-skillz-trims-square alt=Cathie Wood Adds More Coinbase, Skillz, Trims Square>Full story available on Benzinga.com</a></p>\",\"Sector ETFs,Penny Stocks,Cryptocurrency,Small Cap,Markets,Trading Ideas,ETFs\"\n",
+                "example": "id,publisher_name,publisher_homepage_url,publisher_logo_url,publisher_favicon_url,title,author,published_utc,article_url,ticker,amp_url,image_url,description,keywords,sentiment,sentiment_reasoning\n8ec638777ca03b553ae516761c2a22ba2fdd2f37befae3ab6fdab74e9e5193eb,Investing.com,https://www.investing.com/,https://s3.polygon.io/public/assets/news/logos/investing.png,https://s3.polygon.io/public/assets/news/favicons/investing.ico,Markets are underestimating Fed cuts: UBS By Investing.com - Investing.com UK,Sam Boughedda,1719254033000000000,https://uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968,UBS,https://m.uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968?ampMode=1,https://i-invdn-com.investing.com/news/LYNXNPEC4I0AL_L.jpg,\"UBS analysts warn that markets are underestimating the extent of future interest rate cuts by the Federal Reserve, as the weakening economy is likely to justify more cuts than currently anticipated.\",\"Federal Reserve,interest rates,economic data\",positive,\"UBS analysts are providing a bullish outlook on the extent of future Federal Reserve rate cuts, suggesting that markets are underestimating the number of cuts that will occur.\"\n",
                 "schema": {
                   "type": "string"
                 }
@@ -22753,11 +22849,11 @@
             }
           },
           {
-            "description": "Limit the number of results returned, default is 10 and max is 50000.",
+            "description": "Limit the number of results returned, default is 1000 and max is 50000.",
             "in": "query",
             "name": "limit",
             "schema": {
-              "default": 10,
+              "default": 1000,
               "example": 10,
               "maximum": 50000,
               "minimum": 1,
@@ -22882,6 +22975,8 @@
         },
         "x-polygon-paginate": {
           "limit": {
+            "default": 1000,
+            "example": 10,
             "max": 50000
           },
           "order": {
@@ -22978,11 +23073,11 @@
             }
           },
           {
-            "description": "Limit the number of results returned, default is 10 and max is 50000.",
+            "description": "Limit the number of results returned, default is 1000 and max is 50000.",
             "in": "query",
             "name": "limit",
             "schema": {
-              "default": 10,
+              "default": 1000,
               "example": 10,
               "maximum": 50000,
               "minimum": 1,
@@ -23129,6 +23221,8 @@
         },
         "x-polygon-paginate": {
           "limit": {
+            "default": 1000,
+            "example": 10,
             "max": 50000
           },
           "order": {
@@ -23218,11 +23312,11 @@
             }
           },
           {
-            "description": "Limit the number of results returned, default is 10 and max is 50000.",
+            "description": "Limit the number of results returned, default is 1000 and max is 50000.",
             "in": "query",
             "name": "limit",
             "schema": {
-              "default": 10,
+              "default": 1000,
               "example": 10,
               "maximum": 50000,
               "minimum": 1,
@@ -23430,6 +23521,8 @@
         },
         "x-polygon-paginate": {
           "limit": {
+            "default": 1000,
+            "example": 10,
             "max": 50000
           },
           "order": {
@@ -25395,7 +25488,7 @@
         "parameters": [
           {
             "description": "Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/).",
-            "example": "O:EVRI240119C00002500",
+            "example": "O:SPY251219C00650000",
             "in": "path",
             "name": "options_ticker",
             "required": true,
@@ -28954,11 +29047,11 @@
             }
           },
           {
-            "description": "Limit the number of results returned, default is 10 and max is 50000.",
+            "description": "Limit the number of results returned, default is 1000 and max is 50000.",
             "in": "query",
             "name": "limit",
             "schema": {
-              "default": 10,
+              "default": 1000,
               "example": 10,
               "maximum": 50000,
               "minimum": 1,
@@ -29104,6 +29194,8 @@
         },
         "x-polygon-paginate": {
           "limit": {
+            "default": 1000,
+            "example": 10,
             "max": 50000
           },
           "order": {
@@ -29200,11 +29292,11 @@
             }
           },
           {
-            "description": "Limit the number of results returned, default is 10 and max is 50000.",
+            "description": "Limit the number of results returned, default is 1000 and max is 50000.",
             "in": "query",
             "name": "limit",
             "schema": {
-              "default": 10,
+              "default": 1000,
               "example": 10,
               "maximum": 50000,
               "minimum": 1,
@@ -29356,6 +29445,8 @@
         },
         "x-polygon-paginate": {
           "limit": {
+            "default": 1000,
+            "example": 10,
             "max": 50000
           },
           "order": {
@@ -29445,11 +29536,11 @@
             }
           },
           {
-            "description": "Limit the number of results returned, default is 10 and max is 50000.",
+            "description": "Limit the number of results returned, default is 1000 and max is 50000.",
             "in": "query",
             "name": "limit",
             "schema": {
-              "default": 10,
+              "default": 1000,
               "example": 10,
               "maximum": 50000,
               "minimum": 1,
@@ -29645,6 +29733,8 @@
         },
         "x-polygon-paginate": {
           "limit": {
+            "default": 1000,
+            "example": 10,
             "max": 50000
           },
           "order": {
@@ -30499,7 +30589,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": {
@@ -31284,6 +31374,11 @@
           "paths": [
             "/v3/reference/exchanges"
           ]
+        },
+        {
+          "paths": [
+            "/v1/related-companies/{ticker}"
+          ]
         }
       ]
     }