Polygon instruction

maybe-finance · Jan 12, 2024 · 2f24ad6 · 2f24ad6
1 parent 37382ae
commit 2f24ad6
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.env.example b/.env.example
@@ -2,6 +2,9 @@
 NX_DATABASE_URL=postgresql://maybe:maybe@localhost:5433/maybe_local
 NX_DATABASE_SECRET=
 
+# Market data API keys (https://polygon.io)
+NX_POLYGON_API_KEY=
+
 # If using free ngrok account for webhooks
 NGROK_AUTH_TOKEN=
 

diff --git a/README.md b/README.md
@@ -44,6 +44,10 @@ The biggest focus at the moment is on getting the app functional without some pr
 
 You can view the current [high-priority issues here](https://github.com/maybe-finance/maybe/issues?q=is:issue+is:open+label:%22high+priority%22). Those are the most impactful issues to tackle first.
 
+## External data
+
+To pull market data in (for investments), you'll need a Polygon.io API key. You can get one for free [here](https://polygon.io/) and then add it to your `.env` file (`NX_POLYGON_API_KEY`).
+
 ## Tech stack
 
 -   Next.js