René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Client update needed to match rest.json spec changes","articleBody":"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:\n```diff\n--- https://raw.githubusercontent.com/polygon-io/client-python/master/.polygon/rest.json\n+++ https://api.polygon.io/specs/rest.json\n@@ -512,7 +512,17 @@\n                 \"WARRANT\",\n                 \"INDEX\",\n                 \"ETF\",\n-                \"ETN\"\n+                \"ETN\",\n+                \"OS\",\n+                \"GDR\",\n+                \"OTHER\",\n+                \"NYRS\",\n+                \"AGEN\",\n+                \"EQLK\",\n+                \"BOND\",\n+                \"ADRW\",\n+                \"BASKET\",\n+                \"LT\"\n               ]\n             }\n           },\n@@ -526,7 +536,8 @@\n               \"enum\": [\n                 \"stocks\",\n                 \"crypto\",\n-                \"fx\"\n+                \"fx\",\n+                \"otc\"\n               ]\n             }\n           },\n@@ -661,7 +672,7 @@\n                       \"properties\": {\n                         \"results\": {\n                           \"type\": \"array\",\n-                          \"description\": \"An array of tickers that match your query.\\n\\nNote: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response.                                                                                                                                                                                                                                                                                                   \\n\",\n+                          \"description\": \"An array of tickers that match your query.\\n\\nNote: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response.\\n\",\n                           \"items\": {\n                             \"type\": \"object\",\n                             \"properties\": {\n@@ -679,7 +690,8 @@\n                                 \"enum\": [\n                                   \"stocks\",\n                                   \"crypto\",\n-                                  \"fx\"\n+                                  \"fx\",\n+                                  \"otc\"\n                                 ]\n                               },\n                               \"locale\": {\n@@ -872,7 +884,8 @@\n                               \"enum\": [\n                                 \"stocks\",\n                                 \"crypto\",\n-                                \"fx\"\n+                                \"fx\",\n+                                \"otc\"\n                               ]\n                             },\n                             \"locale\": {\n@@ -2637,6 +2650,10 @@\n                       \"format\": \"double\",\n                       \"description\": \"The trading volume of the symbol in the given time period.\"\n                     },\n+                    \"otc\": {\n+                      \"type\": \"boolean\",\n+                      \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n+                    },\n                     \"preMarket\": {\n                       \"type\": \"integer\",\n                       \"description\": \"The open price of the ticker symbol in pre-market trading.\"\n@@ -2704,6 +2721,15 @@\n               \"type\": \"boolean\"\n             },\n             \"example\": true\n+          },\n+          {\n+            \"name\": \"include_otc\",\n+            \"in\": \"query\",\n+            \"description\": \"Include OTC securities in the response. Default is false (don't include OTC securities).\\n\",\n+            \"required\": false,\n+            \"schema\": {\n+              \"type\": \"boolean\"\n+            }\n           }\n         ],\n         \"responses\": {\n@@ -2787,6 +2813,10 @@\n                               \"n\": {\n                                 \"type\": \"number\",\n                                 \"description\": \"The number of transactions in the aggregate window.\"\n+                              },\n+                              \"otc\": {\n+                                \"type\": \"boolean\",\n+                                \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                               }\n                             }\n                           }\n@@ -3199,6 +3229,10 @@\n                               \"n\": {\n                                 \"type\": \"number\",\n                                 \"description\": \"The number of transactions in the aggregate window.\"\n+                              },\n+                              \"otc\": {\n+                                \"type\": \"boolean\",\n+                                \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                               }\n                             }\n                           }\n@@ -3272,6 +3306,15 @@\n                 \"type\": \"string\"\n               }\n             }\n+          },\n+          {\n+            \"name\": \"include_otc\",\n+            \"in\": \"query\",\n+            \"description\": \"Include OTC securities in the response. Default is false (don't include OTC securities).\\n\",\n+            \"required\": false,\n+            \"schema\": {\n+              \"type\": \"boolean\"\n+            }\n           }\n         ],\n         \"responses\": {\n@@ -3335,6 +3378,10 @@\n                                     \"type\": \"number\",\n                                     \"format\": \"double\",\n                                     \"description\": \"The volume weighted average price.\"\n+                                  },\n+                                  \"otc\": {\n+                                    \"type\": \"boolean\",\n+                                    \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                                   }\n                                 }\n                               },\n@@ -3437,6 +3484,10 @@\n                                     \"type\": \"number\",\n                                     \"format\": \"double\",\n                                     \"description\": \"The volume weighted average price.\"\n+                                  },\n+                                  \"otc\": {\n+                                    \"type\": \"boolean\",\n+                                    \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                                   }\n                                 }\n                               },\n@@ -3473,6 +3524,10 @@\n                                     \"type\": \"number\",\n                                     \"format\": \"double\",\n                                     \"description\": \"The volume weighted average price.\"\n+                                  },\n+                                  \"otc\": {\n+                                    \"type\": \"boolean\",\n+                                    \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                                   }\n                                 }\n                               },\n@@ -3666,6 +3721,10 @@\n                                   \"type\": \"number\",\n                                   \"format\": \"double\",\n                                   \"description\": \"The volume weighted average price.\"\n+                                },\n+                                \"otc\": {\n+                                  \"type\": \"boolean\",\n+                                  \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                                 }\n                               }\n                             },\n@@ -3768,6 +3827,10 @@\n                                   \"type\": \"number\",\n                                   \"format\": \"double\",\n                                   \"description\": \"The volume weighted average price.\"\n+                                },\n+                                \"otc\": {\n+                                  \"type\": \"boolean\",\n+                                  \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                                 }\n                               }\n                             },\n@@ -3804,6 +3867,10 @@\n                                   \"type\": \"number\",\n                                   \"format\": \"double\",\n                                   \"description\": \"The volume weighted average price.\"\n+                                },\n+                                \"otc\": {\n+                                  \"type\": \"boolean\",\n+                                  \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                                 }\n                               }\n                             },\n@@ -3991,6 +4058,10 @@\n                                     \"type\": \"number\",\n                                     \"format\": \"double\",\n                                     \"description\": \"The volume weighted average price.\"\n+                                  },\n+                                  \"otc\": {\n+                                    \"type\": \"boolean\",\n+                                    \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                                   }\n                                 }\n                               },\n@@ -4093,6 +4164,10 @@\n                                     \"type\": \"number\",\n                                     \"format\": \"double\",\n                                     \"description\": \"The volume weighted average price.\"\n+                                  },\n+                                  \"otc\": {\n+                                    \"type\": \"boolean\",\n+                                    \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                                   }\n                                 }\n                               },\n@@ -4129,6 +4204,10 @@\n                                     \"type\": \"number\",\n                                     \"format\": \"double\",\n                                     \"description\": \"The volume weighted average price.\"\n+                                  },\n+                                  \"otc\": {\n+                                    \"type\": \"boolean\",\n+                                    \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                                   }\n                                 }\n                               },\n@@ -4490,6 +4569,10 @@\n                       \"format\": \"double\",\n                       \"description\": \"The trading volume of the symbol in the given time period.\"\n                     },\n+                    \"otc\": {\n+                      \"type\": \"boolean\",\n+                      \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n+                    },\n                     \"preMarket\": {\n                       \"type\": \"integer\",\n                       \"description\": \"The open price of the ticker symbol in pre-market trading.\"\n@@ -9664,6 +9747,10 @@\n         \"type\": \"number\",\n         \"description\": \"The number of transactions in the aggregate window.\"\n       },\n+      \"OTC\": {\n+        \"type\": \"boolean\",\n+        \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n+      },\n       \"Open\": {\n         \"type\": \"number\",\n         \"format\": \"double\",\n@@ -9856,12 +9943,71 @@\n                 \"n\": {\n                   \"type\": \"number\",\n                   \"description\": \"The number of transactions in the aggregate window.\"\n+                },\n+                \"otc\": {\n+                  \"type\": \"boolean\",\n+                  \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                 }\n               }\n             }\n           }\n         }\n       },\n+      \"StocksTickerResultsOTC\": {\n+        \"type\": \"object\",\n+        \"properties\": {\n+          \"results\": {\n+            \"type\": \"array\",\n+            \"items\": {\n+              \"type\": \"object\",\n+              \"properties\": {\n+                \"o\": {\n+                  \"type\": \"number\",\n+                  \"format\": \"double\",\n+                  \"description\": \"The open price for the symbol in the given time period.\"\n+                },\n+                \"h\": {\n+                  \"type\": \"number\",\n+                  \"format\": \"double\",\n+                  \"description\": \"The highest price for the symbol in the given time period.\"\n+                },\n+                \"l\": {\n+                  \"type\": \"number\",\n+                  \"format\": \"double\",\n+                  \"description\": \"The lowest price for the symbol in the given time period.\"\n+                },\n+                \"c\": {\n+                  \"type\": \"number\",\n+                  \"format\": \"double\",\n+                  \"description\": \"The close price for the symbol in the given time period.\"\n+                },\n+                \"v\": {\n+                  \"type\": \"number\",\n+                  \"format\": \"double\",\n+                  \"description\": \"The trading volume of the symbol in the given time period.\"\n+                },\n+                \"vw\": {\n+                  \"type\": \"number\",\n+                  \"format\": \"double\",\n+                  \"description\": \"The volume weighted average price.\"\n+                },\n+                \"t\": {\n+                  \"type\": \"integer\",\n+                  \"description\": \"The Unix Msec timestamp for the start of the aggregate window.\"\n+                },\n+                \"n\": {\n+                  \"type\": \"number\",\n+                  \"description\": \"The number of transactions in the aggregate window.\"\n+                },\n+                \"otc\": {\n+                  \"type\": \"boolean\",\n+                  \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n+                }\n+              }\n+            }\n+          }\n+        }\n+      },\n       \"ForexGroupedResults\": {\n         \"type\": \"object\",\n         \"properties\": {\n@@ -10121,6 +10261,45 @@\n           }\n         }\n       },\n+      \"SnapshotOHLCVVWOtc\": {\n+        \"type\": \"object\",\n+        \"properties\": {\n+          \"o\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The open price for the symbol in the given time period.\"\n+          },\n+          \"h\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The highest price for the symbol in the given time period.\"\n+          },\n+          \"l\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The lowest price for the symbol in the given time period.\"\n+          },\n+          \"c\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The close price for the symbol in the given time period.\"\n+          },\n+          \"v\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The trading volume of the symbol in the given time period.\"\n+          },\n+          \"vw\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The volume weighted average price.\"\n+          },\n+          \"otc\": {\n+            \"type\": \"boolean\",\n+            \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n+          }\n+        }\n+      },\n       \"StocksSnapshotLastQuote\": {\n         \"type\": \"object\",\n         \"properties\": {\n@@ -10187,6 +10366,49 @@\n           }\n         }\n       },\n+      \"StocksSnapshotMinuteOTC\": {\n+        \"type\": \"object\",\n+        \"properties\": {\n+          \"av\": {\n+            \"type\": \"integer\",\n+            \"description\": \"The accumulated volume.\"\n+          },\n+          \"o\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The open price for the symbol in the given time period.\"\n+          },\n+          \"h\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The highest price for the symbol in the given time period.\"\n+          },\n+          \"l\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The lowest price for the symbol in the given time period.\"\n+          },\n+          \"c\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The close price for the symbol in the given time period.\"\n+          },\n+          \"v\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The trading volume of the symbol in the given time period.\"\n+          },\n+          \"vw\": {\n+            \"type\": \"number\",\n+            \"format\": \"double\",\n+            \"description\": \"The volume weighted average price.\"\n+          },\n+          \"otc\": {\n+            \"type\": \"boolean\",\n+            \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n+          }\n+        }\n+      },\n       \"StocksSnapshotTickers\": {\n         \"type\": \"object\",\n         \"properties\": {\n@@ -10228,6 +10450,10 @@\n                       \"type\": \"number\",\n                       \"format\": \"double\",\n                       \"description\": \"The volume weighted average price.\"\n+                    },\n+                    \"otc\": {\n+                      \"type\": \"boolean\",\n+                      \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                     }\n                   }\n                 },\n@@ -10330,6 +10556,10 @@\n                       \"type\": \"number\",\n                       \"format\": \"double\",\n                       \"description\": \"The volume weighted average price.\"\n+                    },\n+                    \"otc\": {\n+                      \"type\": \"boolean\",\n+                      \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                     }\n                   }\n                 },\n@@ -10366,6 +10596,10 @@\n                       \"type\": \"number\",\n                       \"format\": \"double\",\n                       \"description\": \"The volume weighted average price.\"\n+                    },\n+                    \"otc\": {\n+                      \"type\": \"boolean\",\n+                      \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                     }\n                   }\n                 },\n@@ -10431,6 +10665,10 @@\n                     \"type\": \"number\",\n                     \"format\": \"double\",\n                     \"description\": \"The volume weighted average price.\"\n+                  },\n+                  \"otc\": {\n+                    \"type\": \"boolean\",\n+                    \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                   }\n                 }\n               },\n@@ -10533,6 +10771,10 @@\n                     \"type\": \"number\",\n                     \"format\": \"double\",\n                     \"description\": \"The volume weighted average price.\"\n+                  },\n+                  \"otc\": {\n+                    \"type\": \"boolean\",\n+                    \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                   }\n                 }\n               },\n@@ -10569,6 +10811,10 @@\n                     \"type\": \"number\",\n                     \"format\": \"double\",\n                     \"description\": \"The volume weighted average price.\"\n+                  },\n+                  \"otc\": {\n+                    \"type\": \"boolean\",\n+                    \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n                   }\n                 }\n               },\n@@ -11433,7 +11679,7 @@\n         \"properties\": {\n           \"results\": {\n             \"type\": \"array\",\n-            \"description\": \"An array of tickers that match your query.\\n\\nNote: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response.                                                                                                                                                                                                                                                                                                   \\n\",\n+            \"description\": \"An array of tickers that match your query.\\n\\nNote: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response.\\n\",\n             \"items\": {\n               \"type\": \"object\",\n               \"properties\": {\n@@ -11451,7 +11697,8 @@\n                   \"enum\": [\n                     \"stocks\",\n                     \"crypto\",\n-                    \"fx\"\n+                    \"fx\",\n+                    \"otc\"\n                   ]\n                 },\n                 \"locale\": {\n@@ -11532,7 +11779,8 @@\n                 \"enum\": [\n                   \"stocks\",\n                   \"crypto\",\n-                  \"fx\"\n+                  \"fx\",\n+                  \"otc\"\n                 ]\n               },\n               \"locale\": {\n@@ -12236,6 +12484,10 @@\n             \"format\": \"double\",\n             \"description\": \"The trading volume of the symbol in the given time period.\"\n           },\n+          \"otc\": {\n+            \"type\": \"boolean\",\n+            \"description\": \"Whether or not this aggregate is for an OTC ticker. This field will be left off if false.\"\n+          },\n           \"preMarket\": {\n             \"type\": \"integer\",\n             \"description\": \"The open price of the ticker symbol in pre-market trading.\"\n@@ -13259,6 +13511,15 @@\n         },\n         \"example\": \"gainers\"\n       },\n+      \"IncludeOTC\": {\n+        \"name\": \"include_otc\",\n+        \"in\": \"query\",\n+        \"description\": \"Include OTC securities in the response. Default is false (don't include OTC securities).\\n\",\n+        \"required\": false,\n+        \"schema\": {\n+          \"type\": \"boolean\"\n+        }\n+      },\n       \"LimitMax50000\": {\n         \"name\": \"limit\",\n         \"in\": \"query\",\n\n```","author":{"url":"https://github.com/client-library-maintainer[bot]","@type":"Person","name":"client-library-maintainer[bot]"},"datePublished":"2022-06-20T09:00:21.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/223/client-python/issues/223"}