Skip to main content

Introduction

Welcome to the Exnaton Enduser API documentation. This API allows individual users to access their own energy price data through OAuth2 authentication. You can use this to integrate with your Home Energy Management System (HEMS), Home Assistant, or other applications.

What is the Enduser API?​

  • Get Energy Rate - Complete Rate Calculation: Returns total energy rate per kWh. Aggregates future market rates and the user's rate plans.

  • Current Energy Rate - Real-Time Market Rate: Returns market energy rate per kWh. Reflects the most recent rate based on the fastest-changing component from the user's rate plans.

  • Get Current Base rate - Fixed Infrastructure Rate: Returns the currently valid base rate per billing period. These are regulatory and infrastructure costs separate from variable energy commodity pricing.

Each of these endpoints require your account ID in the URL path and your access token in the Authorization header.

You can find your account IDs in this endpoint:

Getting Started​

To get started with the API, register a redirect URL with Exnaton, and then implement the OAuth2 Authorization Code Flow:

  • Redirect users to the authorization endpoint
  • Handle the authorization code callback
  • Exchange the code for an access token
  • Use the access token to make API requests
  • Start integrating with your preferred application using the authenticated API endpoints

Base URL​

All API requests should be made to $EXNATON_URL/api/public/.

Authentication​

The API uses OAuth2 Authorization Code Flow for authentication. This is the standard flow used by third-party applications like Home Assistant. See the Authentication section for detailed information about the authentication process.