Skip to main content
This guide walks you through integrating the Axle VPP into your battery management platform. This assumes that you have access to batteries with a supported third party Original Equipment Manufacturer (OEM).
  • FoxESS
  • Givenergy
  • Sigenergy
  • Solis
If you are an OEM and want to allow access to your customers’ batteries, we do offer bespoke OEM integrations. Please get in touch to discuss further.

​
Prerequisites

  • An Axle API token (see Authentication)
  • Basic site information (MPAN, address, postcode)
  • Confirmed user consent
  • Batteries that belong to one of our supported OEMs

​
Step 1: Onboard your user and asset

First, you need to register the user’s site and battery with Axle. Note that the relevant dispatch consent depends on what mode you’ve selected.
  • Grid Event Mode requires vpp_limited_control consent, which allows us to send commands during grid events.
  • Fully Optimised Mode requires full_asset_control consent, which allows us to send daily schedules

Onboard site and asset

View the OpenAPI spec with interactive request examples and response schemas.

​
Example request for registering a Battery

{
  "site": {
    "mpan": "1234567890123",
    "postcode": "SW1A 1AA",
    "street_address": "10 Downing Street",
    "gave_boundary_meter_consent_at": "2025-01-01T12:00:00Z",
    "email": "user@example.com"
  },
  "asset": {
    "external_id": "battery-001",
    "type": "battery",
    "properties": {
      "power_kw": 5.0,
      "capacity_kwh": 10.0
    }
  },
  "dispatch_consent": {
    "dispatch_methods": ["full_asset_control"]
  }
}
The API returns a site.id value which you’ll need for querying balance/rewards and offboardingOtherwise it is still possible to retrieve these ids using the asset’s external_id
Include the user’s email in the site data if you want us to notify the customer of grid events.

​
Step 2: Provide access to the OEM

Rather than routing commands through your platform, we can communicate directly with the OEM’s cloud API — provided they’re on our supported list. To allow us to dispatch commands via the OEM, you need to supply the user’s OEM credentials using the token endpoint:

Provide OEM token

Submit OEM credentials for a site so Axle can dispatch commands via the OEM’s API.

​
Example request for providing OEM credentials

{
  "access_token": "example_api_key_123",
  "token_type": "API_KEY",
  "expires_utc": "2030-01-01T00:00:00Z"
}
For some OEMs we also support OAuth2 authentication flows, removing the need to handle credentials directly. Get in touch to find out more.
We will pull readings and send out dispatch commands via the OEM’s API based on the configured dispatch consent.

​
Offboarding

When a user withdraws consent or removes their battery, offboard the site and asset:

Offboard site and assets

Remove sites and assets from the Axle platform.
The offboarding endpoint removes the site and all associated assets, ensuring:
  • All dispatch consents are revoked
  • VPP participation is stopped
  • User data is handled according to retention policies