Provide an auth token to Axle, for dispatching the site's assets.

This token should provide access to all of the assets registered against the specified site.

This is only required where Axle is not able to access this site via an aggregated API in your systems.

Add site auth token

Location

Message

Error Type

ValidationError

Request model for providing an auth token to enable Axle to access assets at a site.

SiteAuthTokenRequest

OAuth2PasswordBearer

Site not found or not authorized to access

HTTPValidationError

Add Site Auth Token

axle energy

Register and prequalify assets, participate in flexibility markets, and monetize. 

Introduction

Access flexibility markets with ease

The flex lifecycle

Participating in flexibility markets

Planning your integration

Registering users and assets

What data we need to participate, and how to send it

Asset and boundary metering

Optimisation and dispatch

Chargers

Batteries

HVAC

Identifying user MPANs and their eligibility

Retrieving meter details

Monetize flexibility through managed charging

EV smart charging

Battery optimisation

Great Britain

We'll help register your end customers for flexibility services

Implementing

Implementing Signup

Testing Signup

Testing the integration

Address Collection

Tariff

Smart charging intent

Wallet

Payments

Setting up an environment

Authenticate using username and password submitted via form data.

This endpoint is compatible with standard OAuth2 clients that use form-based authentication. Returns an access token upon successful authentication.

Authentication

Learn the building blocks of market flexibility

Core concepts

How to use axle

Add an asset

Check qualified markets

Tell us when the availability of your assets changes

Updating asset availability

Execute optimal bidding for selected markets

Submit bids

Search for electricity meters at a specific 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 two steps:
1. Search for meters at the specified address using this endpoint
2. Call the /meter/by-ref/{meter_ref} endpoint with the returned reference to get the full meter details.

Search meters

Retrieve detailed information about a meter using its MPAN.

This endpoint allows direct lookup of meter information when the MPAN is already known.

Get meter info by MPAN

Retrieve meter information using an encrypted reference.

Get meter info by meter ref

Retrieve detailed information about a meter using its address.

This endpoint allows direct lookup of meter information by address, when the MPAN is not already known (if the MPAN is known, use the /meter/{mpan} endpoint).

Get meter info by address

Retrieve sites, optionally filtering by MPAN or postcode.

Returns a page of sites with the total count and the requested subset of site records. Use the limit and offset parameters to navigate through pages of results.

Get all sites

Retrieve a specific site by its UUID.

Returns the site details if it exists.

Get site

Register a new site.

The site must have a valid address and postcode. If a site with the same address already exists, a 409 error will be returned with the existing site ID.

Create site

Delete an existing site by its UUID.

The site will only be deleted if it has no associated assets or other objects. Returns a confirmation message upon successful deletion.

Delete site

Update an existing site's information.

Only fields included in the request will be updated. Returns the updated site details.

Update site

Add market consent for a site to participate in specific markets.

This enables the site to participate in the specified market types. Returns the updated site details with the new consent information.

Add site market consent

Remove market consent for a site to stop participation in specific markets.

This disables the site's participation in the specified market types. Returns the updated site details with the consent information removed.

Remove site market consent

Get all assets with pagination.

Returns a page of assets with the total count and the requested subset of asset records. Use the limit and offset parameters to navigate through pages of results.

Get all assets

Get a specific asset by its Axle UUID.

Returns the asset details if it exists.

Get asset

Get a specific asset by its external ID (vendor-specific identifier).

Returns the asset details if it exists. This is useful for integrations where the external system ID is known but not the Axle UUID.

Get asset by external id

Create a new asset.

The asset must be associated with an existing site. Returns the created asset details including the assigned UUID.

Create asset

Delete an asset by its Axle UUID.

The asset will be deleted if it exists. Returns a confirmation message upon successful deletion.

Delete asset

Handle notification of an event happening on an asset.

This endpoint allows reporting various events related to an asset, such as:
- Plug-in/plug-out events
- Updates to charging intent
- Charge now events

If a tariff is included, it must comply with the OSM opening hours standard (https://wiki.openstreetmap.org/wiki/Key:opening_hours) for off-peak times and have a valid timezone, or a 400 error will be returned.

Handle asset event

Provide an update on the handling of a given event by a given asset.

This endpoint allows asset controllers to report back the status of event handling. The `asset_id` can be either the Axle UUID or an external ID if `asset_id_is_external` is true.

Note: This will not work for non-UUID external asset IDs.

Update event status

Send asset readings data to Axle.

This endpoint accepts compressed data using gzip encoding. Returns statuses of the processed data, indicating whether the data were accepted or rejected.

API Documentation

Add site auth token

Authorizations

Path Parameters

Body

Response