Shane32.EnphaseAPI 0.4.0

Shane32.EnphaseAPI

A .NET client library for the Enphase Monitoring API v4, providing a strongly-typed, async-first interface with full dependency injection support.

Installation

dotnet add package Shane32.EnphaseAPI

Authentication

All Enphase API requests require OAuth 2.0 authentication. You must supply:

• An OAuth 2.0 access token obtained through the Enphase OAuth flow
• Your application's API key (obtained from the Enphase Developer Portal)

To obtain an access token:

1. Register your application at developer-v4.enphase.com to get a client ID and client secret.
2. Direct the user to the Enphase authorization URL to grant consent.
3. Exchange the returned authorization code for an access token and refresh token via the token endpoint.
4. Use the access token in the AccessToken property of IEnphaseClient for each API call. Refresh the token as needed using the refresh token.

Each IEnphaseClient instance carries a single AccessToken, making it straightforward to manage tokens for multiple end users by creating separate client instances per user.

Setup

Register the client in your dependency injection container:

services.AddEnphaseClient(options =>
{
    options.ApiKey = "your-api-key";
});

Then inject IEnphaseClient where needed, set the AccessToken for the active user, and call API methods:

public class MyService(IEnphaseClient enphaseClient)
{
    public async Task<GetSystemsResponse> GetSystemsAsync(string userAccessToken)
    {
        enphaseClient.AccessToken = userAccessToken;
        return await enphaseClient.GetSystemsAsync();
    }
}

Configuration

Options

Retries are triggered only by EnphaseRateLimitException (HTTP 429) or HttpRequestException (transient connectivity problems). All other exceptions are propagated immediately.

Configuration via IConfiguration

Settings can be bound directly from appsettings.json or any other configuration source. Pass the desired IConfiguration section to AddEnphaseClient (the method binds directly to the provided section, giving you full control over the section name):

services.AddEnphaseClient(configuration.GetSection("EnphaseAPI"));

Corresponding appsettings.json:

{
  "EnphaseAPI": {
    "ApiKey": "your-api-key",
    "RetryCount": 3,
    "RetryDelay": "00:00:01",
    "RetryBackoffMultiplier": 2.0
  }
}

This example retries up to 3 times, with a 1-second delay that doubles after each attempt (1 s → 2 s → 4 s).

Exceptions

All errors thrown by IEnphaseClient derive from EnphaseException.

API Reference

System Details

Site Level Production Monitoring

Site Level Consumption Monitoring

Device Level Monitoring

System Configurations

EV Charger Monitoring

EV Charger Control

License

This library is licensed under the MIT License.

Credits

Glory to Jehovah, Lord of Lords and King of Kings, creator of Heaven and Earth, who through his Son Jesus Christ, has redeemed me to become a child of God. -Shane32