Your Fox ESS API key is required to connect third-party applications like Check My Solar to your Fox ESS solar system. This guide shows you how to generate and retrieve your API key from the FoxCloud OpenPlatform.
What is a Fox ESS API Key?
The Fox ESS API (Application Programming Interface) key is a unique authentication credential that allows authorized applications to securely access your solar system data from the Fox ESS Cloud platform. This key enables real-time monitoring of your inverter, battery status, energy production, and consumption data through third-party apps like Check My Solar.
Step-by-Step Instructions
Open the FoxCloud OpenPlatform
Go to the FoxCloud OpenPlatform developer portal. If you are outside Europe, check the region selector on the sign-in page for the correct portal.
Sign in
Sign in with your Fox Cloud account credentials. If you do not have an account yet, use Sign up as Independent Dev to create one. Your inverter must already be registered on Fox Cloud.
Open API Keys
After signing in, go to the API Keys page from the portal navigation.
Generate an API key
Click Generate key and confirm the security notice. Each account can have one active API key at a time.
Copy and save your API key
Use Reveal Key to show the key (you will be asked to enter your login password). Copy it immediately and store it in a secure location. Important: the full key may not be shown again after you leave the page.
Important Notes
- Keep your API key confidential: treat your API key like a password. Never share it publicly or commit it to public repositories.
- API rate limits: Fox ESS Cloud applies daily rate limits per account. Check My Solar caches heavily to keep usage low - see Fox Cloud API usage for how that works.
Using Your API Key with Check My Solar
If you’re already signed in
If you’re already using Check My Solar and want to link an additional Fox Cloud account, or switch to API key authentication:
- Open the app, open the sidebar menu, then open Account Settings.
- Select the Fox Cloud Accounts tab.
- Tap Link Another Account.
- In the Link Your Fox Cloud Account screen that appears, select the API Key tab.
- Optionally, enter an Account Name (e.g. “My Fox Cloud Account”). If left blank, it defaults to “API Key Account”.
- Paste your Fox Cloud API key into the Fox Cloud API Key field.
- Tap Link API Key to connect.
If you’re signing in for the first time
After signing in to Check My Solar, you’ll be taken directly to the Link Your Fox Cloud Account screen:
- Select the API Key tab (the default is Quick Connect - see tip below).
- Optionally, enter an Account Name.
- Paste your Fox Cloud API key into the Fox Cloud API Key field.
- Tap Link API Key to connect.
Your API key is encrypted and stored securely. After a successful link, you’ll be redirected to your dashboard automatically.
After connecting, Check My Solar will begin syncing your solar system data, giving you access to real-time monitoring, energy forecasts, battery status, and analytics.
Lost Your API Key?
If you’ve lost your API key, sign in to the FoxCloud OpenPlatform and generate a new one on the API Keys page. Note that generating a new key will invalidate the previous one, so you’ll need to update all applications using the old key.