Skip to main content
POST
/
entities
/
site
/
initialise
Initialise Site
curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site/initialise \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "site": {
    "mpan": "1234567890123",
    "postcode": "SW1A 1AA",
    "street_address": "10 Downing Street",
    "email": "resident@example.com",
    "gave_boundary_meter_consent_at": "2026-01-15T10:30:00Z"
  },
  "assets": [
    {
      "external_id": "<string>",
      "type": "charger",
      "properties": {
        "power_kw": 7.4
      },
      "asset_model": "<string>",
      "installation_date": "2023-12-25"
    }
  ]
}
'
{
  "site": {
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "site_created": true,
    "fields_updated": [
      "<string>"
    ],
    "warnings": [
      "<string>"
    ]
  },
  "assets": [
    {
      "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "asset_created": true,
      "fields_updated": [
        "<string>"
      ],
      "warnings": [
        "<string>"
      ]
    }
  ],
  "eligibility": {
    "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "site_properties": {
      "is_half_hourly_settled": false,
      "has_meter_consent": true
    },
    "eligible_propositions": [],
    "assets": []
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.axle.energy/llms.txt

Use this file to discover all available pages before exploring further.

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 initialising a site with one or more assets.

Upserts the site and assets, returning eligibility information. No enrollment side effects (no dispatch consent, no bonus, no email).

​
site
Site · object
required

Site information

Example:
{
  "mpan": "1234567890123",
  "postcode": "SW1A 1AA",
  "street_address": "10 Downing Street",
  "email": "resident@example.com",
  "gave_boundary_meter_consent_at": "2026-01-15T10:30:00Z"
}
​
assets
OnboardingAssetRequest · object[]
required

One or more assets to register at the site

Example:
[
  {
    "external_id": "charger-001",
    "type": "charger",
    "asset_model": "zappi",
    "installation_date": "2025-06-15",
    "properties": { "power_kw": 7.4 }
  }
]

Response

Successfully initialised site and assets

Response model for the initialise endpoint.

​
site
Site · object
required

Site result metadata

​
assets
InitialiseAssetResult · object[]
required

Per-asset result metadata

​
eligibility
Eligibility · object
required

Eligibility information for the site and its assets