Polygon.io Official Python Client (Deprecated)

1.16.3 · deprecated · verified Mon Apr 13

The official Python client for Polygon.io's REST and Websocket APIs. This package (`polygon-api-client`) reached its end of life at version `1.16.3` and is no longer maintained. For active development, new features, and bug fixes, users should migrate to the successor library, `massive-api-client`.

Warnings

breaking This `polygon-api-client` package is deprecated and no longer receives updates. The official client has been rebranded and released as `massive-api-client` (version `2.x.x` and higher). All users are strongly advised to migrate to the new package (`massive-api-client`) to receive critical updates, new features, and bug fixes.
Fix: Uninstall `polygon-api-client` (`pip uninstall polygon-api-client`) and install the successor `massive-api-client` (`pip install massive-api-client`). Update your code to use the new package. The core `from polygon import ...` import structure generally remains the same, but new features and endpoint changes in `massive-api-client` may require code adjustments.
breaking Upon migrating from `polygon-api-client` (v1.x) to `massive-api-client` (v2.x+), the default API base URL changes from `https://api.polygon.io` to `https://api.massive.com`. While `https://api.polygon.io` still functions, ensure your code explicitly sets `base_url='https://api.polygon.io'` if you must connect to the old endpoint, or adapt your systems to the new `api.massive.com` default.
Fix: When initializing the client with `massive-api-client`, either allow the new `https://api.massive.com` default or explicitly specify `RESTClient(API_KEY, base_url='https://api.polygon.io')`.
gotcha An API key is required for authentication with the Polygon.io API. The client will raise an error if an API key is not provided or is invalid.
Fix: Pass your Polygon.io API key to the `RESTClient` or `WebSocketClient` constructor, or ensure it's available as the `POLYGON_API_KEY` environment variable.

Install

pip install polygon-api-client==1.16.3 Install Last Maintained Version
pip install massive-api-client Recommended: Install Successor Library

Imports

RESTClient
```
from polygon import RESTClient
```

WebSocketClient

from polygon.websocket import WebSocketClient

Quickstart

Initialize the REST client and fetch basic reference data. Ensure your API key is set via environment variable or directly in the code. This version of the client defaults to the `api.polygon.io` endpoint.

import os
from polygon import RESTClient

# Your Polygon API key
API_KEY = os.environ.get("POLYGON_API_KEY", "YOUR_API_KEY_HERE")

def main():
    if not API_KEY or API_KEY == "YOUR_API_KEY_HERE":
        print("Please set the POLYGON_API_KEY environment variable or replace 'YOUR_API_KEY_HERE' in the code.")
        return

    try:
        with RESTClient(API_KEY) as client:
            # Example: Get ticker types (endpoint availability depends on your API plan)
            resp = client.reference_ticker_types()
            print(f"Ticker Types: {resp.results}")
    except Exception as e:
        print(f"An error occurred: {e}")

if __name__ == "__main__":
    main()

view raw JSON →