🛠️ Step-by-step guide (Enphase API setup using Watt plan)

\n\n### ✅ Using the free tier from Enphase (plan named Watt)\n\n---\n\n#### 1. Create an Enphase Developer Account\n\nSign up for free at:\n\n🔗 [https://developer-v4.enphase.com/signup](https://developer-v4.enphase.com/signup)\n\n---\n\n#### 2. Create a new app\n\n* Go to the **Applications** tab.\n* Click **Create Application**.\n* Select the **Watt** free plan.\n* Choose a name (e.g. `Enphasy`).\n* Under **Access Control**, select **all the permissions**.\n\n---\n\n#### 3. Gather credentials\n\n* Copy your **API Key** → Set as `ENPHASE_API_KEY` in your environment.\n* Copy your **Client ID** and **Client Secret**.\n* Create your `ENPHASE_BASIC_AUTH` value like this:\n\n```bash\n# Replace below with your actual client ID and secret\necho -n \"your_client_id:your_client_secret\" | base64\n```\n\nUse the result in your `.env` or `docker-compose.yml`:\n\n```env\nENPHASE_BASIC_AUTH=\n```\n\n---\n\n#### 4. Get the initial refresh token\n\nYou’ll only need this **once**—afterward, Enphasy will auto-refresh it.\n\n##### 🔐 Authorize your app with an Enphase consumer account:\n\nTake the **Authorization URL** and append the required redirect URI:\n\nJust add `redirect_uri=https://api.enphaseenergy.com/oauth/redirect_uri` to the end of the URL:\n\n```text\nBase: https://api.enphaseenergy.com/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID\nFinal: https://api.enphaseenergy.com/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=https://api.enphaseenergy.com/oauth/redirect_uri\n```\n\n* Open the final URL in your browser (or share it with the Enphase account holder).\n* Log in and authorize the app.\n* You’ll see something like:\n\n > **Authorization code (XXX) is generated**\n\n* Copy the code and paste it into the `curl` request below.\n---\n\n#### 5. Exchange the code for a refresh token\n\nMake this `curl` request to retrieve your first token:\n\n```bash\ncurl --location --request POST 'https://api.enphaseenergy.com/oauth/token?grant_type=authorization_code&redirect_uri=https://api.enphaseenergy.com/oauth/redirect_uri&code=XXX' \\\n--header 'Authorization: Basic XXXXXX='\n```\n\n* Replace the code `XXX` with the authorization code from the previous step.\n* Replace the basic authorization header `XXXXXX=` with your `ENPHASE_BASIC_AUTH` value from earlier.\n\nThis will return a JSON like:\n\n```json\n{\n \"refresh_token\": \"your-refresh-token\",\n ...\n}\n```\n\n---\n\n#### 6. Add it to your environment\n\nSet it in your `.env` or `docker-compose.yml`:\n\n```env\nENPHASE_INITIAL_REFRESH_TOKEN=your-refresh-token\n```\n\n---\n\n🎉 You're done! Enphasy will now handle data syncing and token refreshing automatically.\n\n---\n\n📚 **Further Documentation:**\n\n* [Quick Start Guide](https://developer-v4.enphase.com/docs/quickstart.html#step_1)\n* [Full API Reference](https://developer-v4.enphase.com/docs.html)\n\n

\n\n---\n\n## 🕰️ Scheduled Tasks\n\n| Task | Schedule |\n| --------------------- |------------------------|\n| Refresh access token | Daily @ 00:00 |\n| Sync lifetime data | Daily @ 03:00 |\n| Cache current summary | Every hour (on demand) |\n\n---\n\n## 🧪 Dev Server\n\nNote: This project uses [Bun](https://bun.sh). Install it with `curl -fsSL https://bun.sh/install | bash`\n\n```bash\nbun install\nbun run src/index.ts\n```\n\n---\n\n## 📌 Notes\n\n* SQLite writes must have write permissions. When running in Docker, always bind the DB to a host directory.\n* The Enphase free tier (Watt) limits API calls to 1000 per month — make sure to set `REQ_CACHE_MINUTES` to a sensible value to avoid hitting rate limits.\n* All critical errors are logged in the container console.\n\n---\n\n

📺 How to add Enphasy as a Homepage widget

\n\nTo show Enphasy data in your Homepage dashboard, you can use the built-in `customapi` widget. Below is an example configuration that shows:\n\n- Real-time power data\n- Lifetime energy metrics\n- Yesterday's solar, consumption, import/export data\n\nAdd this block to your `homepage/config/services.yaml` file:\n\n```yaml\n - Enphase Enlighten:\n icon: /img/enphase.png\n href: https://enlighten.enphaseenergy.com/web/\n description: Solar Power\n widgets:\n - type: customapi\n url: http://enphasy:3000/current\n method: GET\n mappings:\n - field: current_power\n label: Current Power\n format: number\n suffix: \"W\"\n - field: energy_today\n label: Energy Today\n format: number\n suffix: \"Wh\"\n - field: energy_lifetime\n label: Energy Lifetime\n format: number\n scale: 0.001\n suffix: \"kWh\"\n - type: customapi\n url: http://enphasy:3000/daily/yesterday\n method: GET\n mappings:\n - field: production\n label: Prod Yest\n format: number\n suffix: \"Wh\"\n - field: consumption\n label: Cons Yest\n format: number\n suffix: \"Wh\"\n - field: import\n label: Import Yest\n format: number\n suffix: \"Wh\"\n - field: export\n label: Export Yest\n format: number\n suffix: \"Wh\"\n```\n\nPreview:\n\n![Enphasy widget](https://raw.githubusercontent.com/Drarox/Enphasy/master/img/homepage.png)\n

\n\n---\n\n## 📃 License\n\n[GPL-3.0 license](https://github.com/Drarox/Enphasy/blob/master/LICENSE)\n\n","has_starred","hub_user","immutable_tags_settings",{"_85":11,"_86":87},"enabled","rules",[88],".*","is_automated","permissions",{"_92":21,"_93":11,"_94":11},"read","write","admin","user","storage_size",138233001,"orgData","recentTags",[101],{"_102":55,"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_61":145,"_146":104,"_147":33,"_148":67,"_43":149,"_150":151,"_152":120,"_153":145,"_154":76,"_155":21},"content_type","creator",6107281,"digest","sha256:571804b14e4a214512a73c71b59836e4201fca455ed5eb8f3833684a81ab14eb","full_size",68702692,"id",916555596,"images",[113,129,135,141],{"_114":115,"_105":116,"_117":118,"_119":120,"_121":122,"_123":124,"_125":118,"_126":-5,"_127":108,"_73":76,"_128":-5},"architecture","amd64","sha256:1dc493fdfb3de666f68b2900a59b1f068d9fc893b4db6d1ad6ad8e8bb427ac65","features","","last_pulled","2026-10-05T22:37:07.529705623Z","last_pushed","2025-06-18T14:19:24.664387234Z","os","linux","os_features","os_version","size","variant",{"_114":130,"_105":131,"_117":118,"_119":132,"_121":133,"_123":124,"_125":118,"_126":-5,"_127":134,"_73":76,"_128":-5},"arm64","sha256:f2c8a85105084966fb53581042f217b5c96eed131a3b69cf9f07f6b51d4ecf42","2026-10-04T16:26:31.98695545Z","2025-06-18T14:19:26.144315742Z",67753742,{"_114":136,"_105":137,"_117":118,"_119":138,"_121":139,"_123":136,"_125":118,"_126":-5,"_127":140,"_73":76,"_128":-5},"unknown","sha256:50deacae689a2bf17f4557f0694e374241e0a51fa302e059b804932c7bff5753","2026-10-04T16:26:32.010328453Z","2025-06-18T14:19:25.574515385Z",1164,{"_114":136,"_105":142,"_117":118,"_119":143,"_121":144,"_123":136,"_125":118,"_126":-5,"_127":140,"_73":76,"_128":-5},"sha256:bb5aab86c8a0b43e7e0cdd3496291722288b20d67936ab7a4232a3a487750869","2026-10-04T16:26:32.015065501Z","2025-06-18T14:19:27.056823192Z","2025-06-18T14:19:27.885145Z","last_updater","last_updater_username","media_type","latest","repository",27699425,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":169,"_179":180,"_163":192,"_193":11},{"_40":170,"_53":174,"_56":57,"_58":59,"_60":11,"_61":62,"_63":64,"_65":175,"_43":35,"_32":33,"_68":69,"_70":-5,"_71":72,"_73":74,"_75":76,"_77":-5,"_78":72,"_79":80,"_81":11,"_82":33,"_83":176,"_89":11,"_90":178,"_95":33,"_96":97},[171,172,173],{"_43":44,"_45":46},{"_43":48,"_45":49},{"_43":51,"_45":52},[55],[67],{"_85":11,"_86":177},[88],{"_92":21,"_93":11,"_94":11},"tags",{"_181":74,"_182":-5,"_183":-5,"_184":185},"count","next","previous","results",[186],{"_102":55,"_103":104,"_105":106,"_107":108,"_109":110,"_111":187,"_61":145,"_146":104,"_147":33,"_148":67,"_43":149,"_150":151,"_152":120,"_153":145,"_154":76,"_155":21},[188,189,190,191],{"_114":115,"_105":116,"_117":118,"_119":120,"_121":122,"_123":124,"_125":118,"_126":-5,"_127":108,"_73":76,"_128":-5},{"_114":130,"_105":131,"_117":118,"_119":132,"_121":133,"_123":124,"_125":118,"_126":-5,"_127":134,"_73":76,"_128":-5},{"_114":136,"_105":137,"_117":118,"_119":138,"_121":139,"_123":136,"_125":118,"_126":-5,"_127":140,"_73":76,"_128":-5},{"_114":136,"_105":142,"_117":118,"_119":143,"_121":144,"_123":136,"_125":118,"_126":-5,"_127":140,"_73":76,"_128":-5},[],"canDeleteTags","actionData","errors"]

Digest	OS/ARCH	Compressed size
1dc493fdfb3d	linux/amd64	65.52 MB
f2c8a8510508	linux/arm64	64.62 MB

drarox/enphasy

Tags for drarox/enphasy