Updated User Interface

We've updated the user interface on our WebSocket documentation according to our latest design patterns. An updated wscat example makes connecting to streaming data from stocks, forex, and crypto as easy as 1,2,3.  New inputs make it easier to define parameters, and the updated scrolling behavior ensures everything you need is always within view.

Better Content & Examples

Channel, parameter, and response attribute descriptions now have much more thorough and descriptive content. Response object examples have all been updated and accurately reflect the format of each response. Each response attribute is now thoroughly documented with the appropriate data type and description.

New Status Indicators

Each channel now includes a status indicator representing the channel's system status in the sidebar. The indicator will glow purple if you need to upgrade your subscription to access particular endpoints.

🟢 OK   🟡 Down   ⚪ Deprecated   🟣 Upgrade Required

Open API Spec

Anyone can view and contribute to the source for our documentation. Contributors can quickly point out inconsistencies or typos and submit edits if they feel inclined. https://github.com/polygon-io/platform-open-api-specs

Visit the new documentation at https://polygon.io/docs/websockets