Updated User Interface

We've updated the user interface and navigation on our API documentation according to our latest design patterns. New inputs make it easier to define parameters, and the updated scrolling behavior ensures everything you need is always within view.

Better Content & Examples

Endpoint, 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, and every endpoint runs with the click of a button using the default parameters.

Improved Response Modals

The new response modals will now truncate responses that are too large to display and allow you to navigate to the full response directly in the browser.

New Status Indicators

Each endpoint now includes a status indicator representing the endpoint'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/