Create site - axle energy

POST

entities

site

Create Site

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpan": "<string>",
  "postcode": "<string>",
  "street_address": "<string>",
  "email": "<string>",
  "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
}
'

{
  "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"
}

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 creating a new site.

mpan

string

required

Meter Point Administration Number

postcode

string

required

UK postcode for the site

street_address

string

Street address for the site

string

Email address for the site

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

Response

Successful Response

Response model for site information.

string<uuid>

required

Axle's internal UUID for the site

mpan

string

Meter Point Administration Number for the site

postcode

string

UK postcode for the site

address

string

Full address for the site

asset_ids

string<uuid>[]

List of asset IDs associated with this 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

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

tariff

Tariff · object

Tariff information for the site

Show child attributes

tariff.tariff_type

enum<string>

Type of tariff

Available options:

single_rate,

dual_rate,

dynamic,

smart,

unknown

tariff.tariff_cheap_start_time

string<time>

Start time for off-peak/cheap rate period

tariff.tariff_cheap_end_time

string<time>

End time for off-peak/cheap rate period

Timestamp when boundary meter consent was given

Onboard site and assetOnboard 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: 1. Create the site 2. Create the asset associated with the site 3. Add dispatch consent to the site 4. 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.

⌘I

Create Site

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/site \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mpan": "<string>",
  "postcode": "<string>",
  "street_address": "<string>",
  "email": "<string>",
  "gave_boundary_meter_consent_at": "2023-11-07T05:31:56Z"
}
'

{
  "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"
}

API Documentation

Authorizations

Body

Response