Skip to content

Commit 88bc106

Browse files
committed
Add new environment variable to README
1 parent 024f188 commit 88bc106

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ The Alpaca SDK will check the environment for a number of variables which can be
6363
| APCA_RETRY_WAIT=3 | 3 | seconds to wait between each retry attempt |
6464
| APCA_RETRY_CODES=429,504 | 429,504 | comma-separated HTTP status code for which retry is attempted |
6565
| POLYGON_WS_URL | wss://alpaca.socket.polygon.io/stocks | Endpoint for streaming polygon data. You likely don't need to change this unless you want to proxy it for example |
66+
| POLYGON_KEY_ID | | Your Polygon key, if it's not the same as your Alpaca API key. Most users will not need to set this to access Polygon.|
6667

6768

6869
## REST
@@ -238,9 +239,10 @@ Deregisters the event handler function that was previously registered via `on` o
238239
---
239240
# Polygon API Service
240241

241-
Alpaca's API key ID can be used to access Polygon API whose document is found [here](https://polygon.io/docs/).
242-
This python SDK wraps their API service and seamlessly integrates with Alpaca API.
243-
`alpaca_trade_api.REST.polygon` will be the `REST` object for Polygon.
242+
Alpaca's API key ID can be used to access Polygon API, the documentation for
243+
which is found [here](https://polygon.io/docs/).
244+
This python SDK wraps their API service and seamlessly integrates it with the Alpaca
245+
API. `alpaca_trade_api.REST.polygon` will be the `REST` object for Polygon.
244246

245247
The example below gives AAPL daily OHLCV data in a DataFrame format.
246248

0 commit comments

Comments
 (0)