Sites

Onboard site and asset

Onboard a site with an asset and dispatch consent in a single operation.

This composite endpoint combines the functionality of creating a site, creating an asset, and adding dispatch consent. The operations are performed in sequence:

Create the site
Create the asset associated with the site
Add dispatch consent to the site
Add boundary meter consent to the site (if provided)

If any step fails, the operation will be rolled back.

Note: You cannot onboard sites without a valid MPAN. Use /meter/ endpoints to obtain MPANs.

POST

entities

site

onboard-site-and-asset

Onboard Site And Asset

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/onboard-site-and-asset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "site": {
    "mpan": "1234567890123",
    "postcode": "SW1A 1AA",
    "street_address": "10 Downing Street",
    "gave_boundary_meter_consent_at": "2025-01-01T12:00:00Z"
  },
  "asset": {
    "external_id": "charger-001",
    "type": "charger",
    "properties": {
      "power_kw": 7.4
    }
  },
  "dispatch_consent": {
    "dispatch_methods": [
      "limited_pause"
    ]
  }
}
'

{
  "site": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mpan": "<string>",
    "postcode": "<string>",
    "address": "<string>",
    "asset_ids": [],
    "markets": [
      "cm"
    ],
    "dispatch_methods": [
      "cm_infrequent_dispatch"
    ],
    "tariff": {
      "tariff_type": "single_rate",
      "tariff_cheap_start_time": "<string>",
      "tariff_cheap_end_time": "<string>"
    },
    "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
  },
  "asset": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "type": "boundary meter",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "properties": {
      "power_kw": 1,
      "capacity_kwh": 1
    }
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Request model for onboarding a site with an asset and dispatch consent in a single call.

site

Site · object

required

Site information

Show child attributes

site.mpan

string

required

Meter Point Administration Number

site.postcode

string

required

UK postcode for the site

site.street_address

string

Street address for the site

Timestamp at which the household gave consent to access readings from their boundary meter, if consent was given

Example:

{
  "mpan": "1234567890123",
  "postcode": "SW1A 1AA",
  "street_address": "10 Downing Street",
  "gave_boundary_meter_consent_at": "2025-01-01T12:00:00Z"
}

asset

Asset · object

required

Asset information

Show child attributes

asset.external_id

string

required

Vendor-specific identifier for the asset

asset.type

enum<string>

required

Type of asset being created

Available options:

charger,

battery,

heat pump,

electric_vehicle,

hot water tank

asset.properties

Properties · object

Optional asset properties

Show child attributes

asset.properties.power_kw

number

Power rating in kW

Required range: x >= 0

asset.properties.capacity_kwh

number

Capacity in kWh

Required range: x >= 0

Example:

{
  "external_id": "charger-001",
  "type": "charger",
  "properties": { "power_kw": 7.4 }
}

Dispatch consent methods

Show child attributes

Dispatch methods to consent to or remove consent from. Leave empty to not consent to any dispatch methods.

Dispatch methods that a site can consent to.

Available options:

cm_infrequent_dispatch,

full_asset_schedule_control,

limited_pause

Example:

{ "dispatch_methods": ["limited_pause"] }

Response

Successfully onboarded site and asset

Response model for onboarding operation.

site

Site · object

required

Created site details

Show child attributes

site.id

string<uuid>

required

Axle's internal UUID for the site

site.mpan

string

Meter Point Administration Number for the site

site.postcode

string

UK postcode for the site

site.address

string

Full address for the site

site.asset_ids

string<uuid>[]

List of asset IDs associated with this site

site.markets

enum<string>[]

Markets the site is participating in

Market types available for participation.

CM: Capacity Market
DFS: Dynamic Frequency Service
DNO: Distribution Network Operator flexibility services
LCM: Local Capacity Market
SFFR: Static Firm Frequency Response
WHOLESALE: Wholesale energy market

Available options:

cm,

dfs,

dno,

lcm,

sffr,

wholesale

site.dispatch_methods

enum<string>[]

Dispatch methods allowed for the site

Dispatch methods that a site can consent to.

Available options:

cm_infrequent_dispatch,

full_asset_schedule_control,

limited_pause

site.tariff

Tariff · object

Tariff information for the site

Show child attributes

site.tariff.tariff_type

enum<string>

Type of tariff

Available options:

single_rate,

dual_rate,

dynamic,

smart,

unknown

site.tariff.tariff_cheap_start_time

string<time>

Start time for off-peak/cheap rate period

site.tariff.tariff_cheap_end_time

string<time>

End time for off-peak/cheap rate period

Timestamp when boundary meter consent was given

asset

Asset · object

required

Created asset details

Show child attributes

asset.id

string<uuid>

required

Axle's internal UUID for the asset

asset.external_id

string

required

Vendor-specific identifier for the asset

asset.type

enum<string>

required

Type of asset

Available options:

boundary meter,

charger,

battery,

heat pump,

hot water tank,

frequency meter,

electric_vehicle

asset.site_id

string<uuid>

required

ID of the site where the asset is located

asset.properties

Properties · object

Optional asset properties

Show child attributes

asset.properties.power_kw

number

Power rating in kW

Required range: x >= 0

asset.properties.capacity_kwh

number

Capacity in kWh

Required range: x >= 0

Offboard site and assetsOffboard a site and all its associated assets in a single operation.

⌘I

Onboard Site And Asset

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/onboard-site-and-asset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "site": {
    "mpan": "1234567890123",
    "postcode": "SW1A 1AA",
    "street_address": "10 Downing Street",
    "gave_boundary_meter_consent_at": "2025-01-01T12:00:00Z"
  },
  "asset": {
    "external_id": "charger-001",
    "type": "charger",
    "properties": {
      "power_kw": 7.4
    }
  },
  "dispatch_consent": {
    "dispatch_methods": [
      "limited_pause"
    ]
  }
}
'

{
  "site": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mpan": "<string>",
    "postcode": "<string>",
    "address": "<string>",
    "asset_ids": [],
    "markets": [
      "cm"
    ],
    "dispatch_methods": [
      "cm_infrequent_dispatch"
    ],
    "tariff": {
      "tariff_type": "single_rate",
      "tariff_cheap_start_time": "<string>",
      "tariff_cheap_end_time": "<string>"
    },
    "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
  },
  "asset": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "type": "boundary meter",
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "properties": {
      "power_kw": 1,
      "capacity_kwh": 1
    }
  }
}

API Documentation

Authorizations

Body

Response