Component token - axle energy

POST

auth

component-token

Create Component Token

curl --request POST \
  --url https://api-sandbox.axle.energy/auth/component-token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'external_user_id=<string>' \
  --data 'allowed_origin=<string>'

{
  "access_token": "<string>",
  "token_type": "<string>"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/x-www-form-urlencoded

external_user_id

string

required

allowed_origin

string

required

Response

Successfully authenticated with a user-scoped access token

access_token

string

required

token_type

string

required

Search metersSearch for all electricity meters in the vicinity of a given postcode/ address. This endpoint allows searching for meters by postcode and optionally by building identifier. For data protection and contractual reasons, meter details are returned in an encrypted format that can be used in subsequent API calls to retrieve the full meter information. The search works in three steps: 1. Search for meters at the specified address using this endpoint 2. Ask the end-user to select the correct address from the list 3. Call the `/meter/by-ref/{meter_ref}` endpoint with the corresponding reference to get the full meter details NB: This should not be used with procedural address matching; it is intended for end-user interaction only. For precise address matching, use the `/meter` endpoint instead, which will perform matching for you.

Create Component Token

curl --request POST \
  --url https://api-sandbox.axle.energy/auth/component-token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'external_user_id=<string>' \
  --data 'allowed_origin=<string>'

{
  "access_token": "<string>",
  "token_type": "<string>"
}

API Documentation

Authorizations

Body

Response