From 2f24ad600c0bdb9fc539461c26be62d1c54ac4bc Mon Sep 17 00:00:00 2001 From: Josh Pigford Date: Fri, 12 Jan 2024 09:33:03 -0600 Subject: [PATCH] Polygon instruction --- .env.example | 3 +++ README.md | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/.env.example b/.env.example index 30aa114d..586e5df8 100644 --- 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 index 900a4ef7..dde3a3e6 100644 --- 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