---
title: "How to Get Your Fox ESS API Key"
description: "Step-by-step guide to retrieve your Fox ESS API key from the Fox ESS Cloud platform."
---

> Documentation Index
> Fetch the complete documentation index at: https://checkmy.solar/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# How to Get Your Fox ESS API Key

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 Fox ESS Cloud platform.

## 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

1. **Login to Fox ESS Cloud**

   Visit [foxesscloud.com](https://www.foxesscloud.com) and log in with your Fox ESS Cloud account credentials.
   If you don't have an account yet, you'll need to create one and ensure your solar system is registered.
2. **Navigate to User Profile**

   Once logged in, click on your username or profile icon in the top right corner of the dashboard.
   From the dropdown menu, select **User Profile** or **Account Settings** to access your account management area.
3. **Access API Management**

   In your User Profile section, look for **API Management** in the sidebar or navigation menu.
   Open it to access the API key management interface.
4. **Generate API Key**

   In the API Management section, find the button labeled **Generate API Key** or **Create New API Key**.
   Click it to create your unique API key. The system will generate a new key for you.
5. **Copy and Save Your API Key**

   Once generated, your API key will be displayed on the screen.
   **Important:** copy this key immediately and store it in a secure location.
   For security reasons, you may not be able to view the complete key again after leaving this 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](/docs/reference/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:

1. Open the app, open the sidebar menu, then open **Account Settings**.
2. Select the **Fox Cloud Accounts** tab.
3. Tap **Link Another Account**.
4. In the **Link Your Fox Cloud Account** screen that appears, select the **API Key** tab.
5. Optionally, enter an **Account Name** (e.g. "My Fox Cloud Account"). If left blank, it defaults to "API Key Account".
6. Paste your Fox Cloud API key into the **Fox Cloud API Key** field.
7. 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:

1. Select the **API Key** tab (the default is **Quick Connect** - see tip below).
2. Optionally, enter an **Account Name**.
3. Paste your Fox Cloud API key into the **Fox Cloud API Key** field.
4. 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.

:::tip[Quick Connect is recommended]
Instead of managing an API key manually, you can use **Quick Connect** to authenticate via Fox Cloud's OAuth flow. This handles connection renewal automatically and requires no API key management.
:::

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, you can generate a new one following the same steps above.
Note that generating a new key will invalidate the previous one, so you'll need to update all applications using the old key.

## Related Resources

- [Fox ESS Open API Documentation](https://www.foxesscloud.com/public/i18n/en/OpenApiDocument.html)
- [Fox ESS Tech Hub - App & Cloud](https://fox-ess.tech/app-cloud/)

## Related pages

- [Getting started overview](/docs/getting-started/)
- [Creating an account](/docs/getting-started/creating-an-account/)
- [Linking your inverter](/docs/getting-started/linking-your-inverter/)
- [Onboarding flow](/docs/getting-started/onboarding-flow/)
- [Dashboard overview](/docs/using-the-app/dashboard-overview/)
- [Notifications](/docs/using-the-app/notifications/)

Source: https://checkmy.solar/docs/getting-started/get-api-fox-ess-cloud-key/index.mdx