Skip to main content
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>",
  "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

​
gave_boundary_meter_consent_at
string<date-time>

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.

​
id
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

​
dispatch_methods
enum<string>[]

Dispatch methods allowed for the site

​
tariff
object

Tariff information for the site Response model for tariff information.

​
gave_boundary_meter_consent_at
string<date-time>

Timestamp when boundary meter consent was given