8000 Client update needed to match WebSocket spec changes · Issue #577 · polygon-io/client-python · GitHub
[go: up one dir, main page]
Skip to content

Client update needed to match WebSocket spec changes #577

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.

Sign up for GitHub

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

Jump to bottom
Closed
client-library-maintainer bot opened this issue Dec 25, 2023 · 1 comment
Closed

Client update needed to match WebSocket spec changes #577

client-library-maintainer bot opened this issue Dec 25, 2023 · 1 comment
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/websocket.json
+++ https://api.polygon.io/specs/websocket.json
@@ -539,11 +539,11 @@
                         },
                         "s": {
                           "type": "integer",
-                          "description": "The timestamp of the starting tick for this aggreg
8000
ate window in Unix Milliseconds."
+                          "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                         },
                         "e": {
                           "type": "integer",
-                          "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                          "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                         },
                         "otc": {
                           "type": "boolean",
@@ -686,11 +683,11 @@
                         },
                         "s": {
                           "type": "integer",
-                          "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                          "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                         },
                         "e": {
                           "type": "integer",
-                          "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                          "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                         },
                         "otc": {
                           "type": "boolean",
@@ -1104,11 +1098,11 @@
                     },
                     "s": {
                       "type": "integer",
-                      "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                      "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "e": {
                       "type": "integer",
-                      "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                      "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                     }
                   }
                 },
@@ -1513,11 +1504,11 @@
                         },
                         "s": {
                           "type": "integer",
-                          "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                          "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                         },
                         "e": {
                           "type": "integer",
-                          "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                          "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                         }
                       }
                     },
@@ -1656,11 +1644,11 @@
                         },
                         "s": {
                           "type": "integer",
-                          "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                          "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                         },
                         "e": {
                           "type": "integer",
-                          "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                          "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                         }
                       }
                     },
@@ -1870,11 +1855,11 @@
                     },
                     "s": {
                       "type": "integer",
-                      "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                      "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "e": {
                       "type": "integer",
-                      "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                      "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                     }
                   }
                 },
@@ -2148,11 +2130,11 @@
                     },
                     "s": {
                       "type": "integer",
-                      "description": "The start time for this aggregate window in Unix Milliseconds."
+                      "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "e": {
                       "type": "integer",
-                      "description": "The end time for this aggregate window in Unix Milliseconds."
+                      "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                     }
                   }
                 },
@@ -2248,11 +2227,11 @@
                     },
                     "s": {
                       "type": "integer",
-                      "description": "The start time for this aggregate window in Unix Milliseconds."
+                      "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "e": {
                       "type": "integer",
-                      "description": "The end time for this aggregate window in Unix Milliseconds."
+                      "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                     }
                   }
                 },
@@ -2440,11 +2416,11 @@
                     },
                     "s": {
                       "type": "integer",
-                      "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                      "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "e": {
                       "type": "integer",
-                      "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                      "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                     }
                   }
                 },
@@ -2805,7 +2778,7 @@
                     },
                     "b": {
                       "type": "array",
-                      "description": "An array of bid prices with a maximum depth of 100.",
+                      "description": "An array of bid prices, where each entry contains two elements: the first is the bid price, and the second is the size, with a maximum depth of 100.",
                       "items": {
                         "type": "array",
                         "description": "An array where the first item is bid price and the second item is size.",
@@ -2817,7 +2790,7 @@
                     },
                     "a": {
                       "type": "array",
-                      "description": "An array of ask prices with a maximum depth of 100.",
+                      "description": "An array of ask prices, where each entry contains two elements: the first is the ask price, and the second is the size, with a maximum depth of 100.",
                       "items": {
                         "type": "array",
                         "description": "An array where the first item is ask price and the second item is size.",
@@ -2950,11 +2923,11 @@
                     },
                     "s": {
                       "type": "integer",
-                      "description": "The start time for this aggregate window in Unix Milliseconds."
+                      "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "e": {
                       "type": "integer",
-                      "description": "The end time for this aggregate window in Unix Milliseconds."
+                      "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "vw": {
                       "type": "number",
@@ -3062,11 +3032,11 @@
                     },
                     "s": {
                       "type": "integer",
-                      "description": "The start time for this aggregate window in Unix Milliseconds."
+                      "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "e": {
                       "type": "integer",
-                      "description": "The end time for this aggregate window in Unix Milliseconds."
+                      "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "vw": {
                       "type": "number",
@@ -3266,11 +3233,11 @@
                     },
                     "s": {
                       "type": "integer",
-                      "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                      "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                     },
                     "e": {
                       "type": "integer",
-                      "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                      "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                     }
                   }
                 },
@@ -3448,11 +3412,11 @@
                         },
                         "s": {
                           "type": "integer",
-                          "description": "The timestamp of the starting index for this aggregate window in Unix Milliseconds."
+                          "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                         },
                         "e": {
                           "type": "integer",
-                          "description": "The timestamp of the ending index for this aggregate window in Unix Milliseconds."
+                          "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                         }
                       }
                     },
@@ -3564,11 +3525,11 @@
                         },
                         "s": {
                           "type": "integer",
-                          "description": "The timestamp of the starting index for this aggregate window in Unix Milliseconds."
+                          "description": "The start timestamp of this aggregate window in Unix Milliseconds."
                         },
                         "e": {
                           "type": "integer",
-                          "description": "The timestamp of the ending index for this aggregate window in Unix Milliseconds."
+                          "description": "The end timestamp of this aggregate window in Unix Milliseconds."
                         }
                       }
                     },
@@ -3919,11 +3877,11 @@
       },
       "AggsStartTime": {
         "type": "integer",
-        "description": "The start time for this aggregate window in Unix Milliseconds."
+        "description": "The start timestamp of this aggregate window in Unix Milliseconds."
       },
       "AggsEndTime": {
         "type": "integer",
-        "description": "The end time for this aggregate window in Unix Milliseconds."
+        "description": "The end timestamp of this aggregate window in Unix Milliseconds."
       },
       "StockTradeEvent": {
         "type": "object",
@@ -4109,11 +4064,11 @@
           },
           "s": {
             "type": "integer",
-            "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+            "description": "The start timestamp of this aggregate window in Unix Milliseconds."
           },
           "e": {
             "type": "integer",
-            "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+            "description": "The end timestamp of this aggregate window in Unix Milliseconds."
           },
           "otc": {
             "type": "boolean",
@@ -4182,11 +4134,11 @@
               },
               "s": {
                 "type": "integer",
-                "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                "description": "The start timestamp of this aggregate window in Unix Milliseconds."
               },
               "e": {
                 "type": "integer",
-                "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                "description": "The end timestamp of this aggregate window in Unix Milliseconds."
               },
               "otc": {
                 "type": "boolean",
@@ -4267,11 +4216,11 @@
               },
               "s": {
                 "type": "integer",
-                "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                "description": "The start timestamp of this aggregate window in Unix Milliseconds."
               },
               "e": {
                 "type": "integer",
-                "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                "description": "The end timestamp of this aggregate window in Unix Milliseconds."
               },
               "otc": {
                 "type": "boolean",
@@ -4547,11 +4493,11 @@
           },
           "s": {
             "type": "integer",
-            "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+            "description": "The start timestamp of this aggregate window in Unix Milliseconds."
           },
           "e": {
             "type": "integer",
-            "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+            "description": "The end timestamp of this aggregate window in Unix Milliseconds."
           }
         }
       },
@@ -4616,11 +4559,11 @@
               },
               "s": {
                 "type": "integer",
-                "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                "description": "The start timestamp of this aggregate window in Unix Milliseconds."
               },
               "e": {
                 "type": "integer",
-                "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                "description": "The end timestamp of this aggregate window in Unix Milliseconds."
               }
             }
           },
@@ -4697,11 +4637,11 @@
               },
               "s": {
                 "type": "integer",
-                "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+                "description": "The start timestamp of this aggregate window in Unix Milliseconds."
               },
               "e": {
                 "type": "integer",
-                "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+                "description": "The end timestamp of this aggregate window in Unix Milliseconds."
               }
             }
           },
@@ -4837,11 +4774,11 @@
           },
           "s": {
             "type": "integer",
-            "description": "The start time for this aggregate window in Unix Milliseconds."
+            "description": "The start timestamp of this aggregate window in Unix Milliseconds."
           },
           "e": {
             "type": "integer",
-            "description": "The end time for this aggregate window in Unix Milliseconds."
+            "description": "The end timestamp of this aggregate window in Unix Milliseconds."
           }
         }
       },
@@ -4885,11 +4819,11 @@
           },
           "s": {
             "type": "integer",
-            "description": "The start time for this aggregate window in Unix Milliseconds."
+            "description": "The start timestamp of this aggregate window in Unix Milliseconds."
           },
           "e": {
             "type": "integer",
-            "description": "The end time for this aggregate window in Unix Milliseconds."
+            "description": "The end timestamp of this aggregate window in Unix Milliseconds."
           }
         }
       },
@@ -5031,11 +4962,11 @@
           },
           "s": {
             "type": "integer",
-            "description": "The start time for this aggregate window in Unix Milliseconds."
+            "description": "The start timestamp of this aggregate window in Unix Milliseconds."
           },
           "e": {
             "type": "integer",
-            "description": "The end time for this aggregate window in Unix Milliseconds."
+            "description": "The end timestamp of this aggregate window in Unix Milliseconds."
           },
           "vw": {
             "type": "number",
@@ -5088,11 +5016,11 @@
           },
           "s": {
             "type": "integer",
-            "description": "The start time for this aggregate window in Unix Milliseconds."
+            "description": "The start timestamp of this aggregate window in Unix Milliseconds."
           },
           "e": {
             "type": "integer",
-            "description": "The end time for this aggregate window in Unix Milliseconds."
+            "description": "The end timestamp of this aggregate window in Unix Milliseconds."
           },
           "vw": {
             "type": "number",
@@ -5121,7 +5046,7 @@
           },
           "b": {
             "type": "array",
-            "description": "An array of bid prices with a maximum depth of 100.",
+            "description": "An array of bid prices, where each entry contains two elements: the first is the bid price, and the second is the size, with a maximum depth of 100.",
             "items": {
               "type": "array",
               "description": "An array where the first item is bid price and the second item is size.",
@@ -5133,7 +5058,7 @@
           },
           "a": {
             "type": "array",
-            "description": "An array of ask prices with a maximum depth of 100.",
+            "description": "An array of ask prices, where each entry contains two elements: the first is the ask price, and the second is the size, with a maximum depth of 100.",
             "items": {
               "type": "array",
               "description": "An array where the first item is ask price and the second item is size.",
@@ -5206,11 +5131,11 @@
           },
           "s": {
             "type": "integer",
-            "description": "The timestamp of the starting index for this aggregate window in Unix Milliseconds."
+            "description": "The start timestamp of this aggregate window in Unix Milliseconds."
           },
           "e": {
             "type": "integer",
-            "description": "The timestamp of the ending index for this aggregate window in Unix Milliseconds."
+            "description": "The end timestamp of this aggregate window in Unix Milliseconds."
           }
         }
       },
@@ -5253,11 +5175,11 @@
               },
               "s": {
                 "type": "integer",
-                "description": "The timestamp of the starting index for this aggregate window in Unix Milliseconds."
+                "description": "The start timestamp of this aggregate window in Unix Milliseconds."
               },
               "e": {
                 "type": "integer",
-                "description": "The timestamp of the ending index for this aggregate window in Unix Milliseconds."
+                "description": "The end timestamp of this aggregate window in Unix Milliseconds."
               }
             }
           },
@@ -5312,11 +5231,11 @@
               },
               "s": {
                 "type": "integer",
-                "description": "The timestamp of the starting index for this aggregate window in Unix Milliseconds."
+                "description": "The start timestamp of this aggregate window in Unix Milliseconds."
               },
               "e": {
                 "type": "integer",
-                "description": "The timestamp of the ending index for this aggregate window in Unix Milliseconds."
+                "description": "The end timestamp of this aggregate window in Unix Milliseconds."
               }
             }
           },
@@ -5412,11 +5328,11 @@
           },
           "s": {
             "type": "integer",
-            "description": "The timestamp of the starting tick for this aggregate window in Unix Milliseconds."
+            "description": "The start timestamp of this aggregate window in Unix Milliseconds."
           },
           "e": {
             "type": "integer",
-            "description": "The timestamp of the ending tick for this aggregate window in Unix Milliseconds."
+            "description": "The end timestamp of this aggregate window in Unix Milliseconds."
           }
         }
       },
@client-library-maintainer client-library-maintainer bot added the spec The client may need an update due to API spec changes label Dec 25, 2023
@justinpolygon
Copy link
Contributor

Dupe of #573.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
spec The client may need an update due to API spec changes
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@justinpolygon
0