From f1e8256b25496684ffc9bf314c93217e145301b3 Mon Sep 17 00:00:00 2001 From: justinpolygon <123573436+justinpolygon@users.noreply.github.com> Date: Wed, 31 Jan 2024 14:09:50 -0800 Subject: [PATCH 1/2] Add API key usage note to Getting Started section --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 89716551..330dc05f 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ pip install -U polygon-api-client To get started, please see the [Getting Started](https://polygon-api-client.readthedocs.io/en/latest/Getting-Started.html) section in our docs, view the [examples](./examples) directory for code snippets, or view the [blog post with videos](https://polygon.io/blog/polygon-io-with-python-for-stock-market-data/) to learn more. +When using a free API key, please be mindful that it supports up to 5 API calls per minute. Exceeding this limit will throw an error message related to rate limits. For uninterrupted access and higher limits, consider upgrading to our [Starter plan](https://polygon.io/pricing), which offers unlimited API calls. This ensures a smoother experience, especially when working with real-time data or building applications that require higher request volumes. + ## REST API Client Import the RESTClient. ```python From 62f87afb3043c0f8e295167045a558723e15e7b4 Mon Sep 17 00:00:00 2001 From: justinpolygon <123573436+justinpolygon@users.noreply.github.com> Date: Thu, 1 Feb 2024 11:59:17 -0800 Subject: [PATCH 2/2] Update free vs paid tier wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 330dc05f..81494a78 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ pip install -U polygon-api-client To get started, please see the [Getting Started](https://polygon-api-client.readthedocs.io/en/latest/Getting-Started.html) section in our docs, view the [examples](./examples) directory for code snippets, or view the [blog post with videos](https://polygon.io/blog/polygon-io-with-python-for-stock-market-data/) to learn more. -When using a free API key, please be mindful that it supports up to 5 API calls per minute. Exceeding this limit will throw an error message related to rate limits. For uninterrupted access and higher limits, consider upgrading to our [Starter plan](https://polygon.io/pricing), which offers unlimited API calls. This ensures a smoother experience, especially when working with real-time data or building applications that require higher request volumes. +The free tier of our API comes with usage limitations, potentially leading to rate limit errors if these are exceeded. For uninterrupted access and to support larger data requirements, we recommend reviewing our [subscription plans](https://polygon.io/pricing), which are tailored for a wide range of needs from development to high-demand applications. Refer to our pricing page for detailed information on limits and features to ensure a seamless experience, especially for real-time data processing. ## REST API Client Import the RESTClient.