Python client for the Polygon.io API.
pip install polygon-api-client
Requires Python >= 3.8.
See the Getting Started section in our docs or view the examples directory.
Users of the Launchpad product will need to pass in certain headers in order to make API requests. Example can be found here.
If you found a bug or have an idea for a new feature, please first discuss it with us by submitting a new issue. We will respond to issues within at most 3 weeks. We're also open to volunteers if you want to submit a PR for any open issues but please discuss it with us beforehand. PRs that aren't linked to an existing issue or discussed with us ahead of time will generally be declined. If you have more general feedback or want to discuss using this client with other users, feel free to reach out on our Slack channel.
If you plan to contribute by developing new features then you will need to install certain dependencies.
Poetry is a packaging and dependency manager for Python.
Installation instructions can be found on their website.
Once installed run poetry install to install the required dependencies. This step should be run after incorporating new upstream changes.
Our Makefile has the common operations needed when developing on this repo. Running tests and linting can both be run through our Makefile. Just run make help to see the list of available commands.
This client will attempt to follow the release cadence of our API.
When endpoints are deprecated and newer versions are added, the client will
maintain two methods in a backwards compatible way
(e.g. list_trades and list_trades_v4(...)).
When deprecated endpoints are removed from the API, we'll rename the versioned
method (e.g. list_trades_v4(...) -> list_trades(...)), remove the old method,
and release a new major version of the client.
The goal is to give users ample time to upgrade to newer versions of our API before we bump the major version of the client, and in general, we'll try to bundle breaking changes like this to avoid frequent major version bumps.
Exceptions to this are:
- Methods under
client.vx. These are expiremental. - Methods that start with
_*. We use these internally. - Type annotations. We may modify these based on our JSON responses.
- We may add model fields.