Getting Started
Offboard site and assets
Offboard a site and all its associated assets in a single operation.
curl --request POST \
--url https://api-sandbox.axle.energy/entities/site/{site_id}/offboard-site-and-assets \
--header 'Authorization: Bearer <token>'{
"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
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
Successfully offboarded site and asset
Response model for onboarding operation.
Created site details
Show child attributes
Show child attributes
Axle's internal UUID for the site
Meter Point Administration Number for the site
UK postcode for the site
Full address for the site
List of asset IDs associated with this site
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
cm, dfs, dno, lcm, sffr, wholesale Dispatch methods allowed for the site
Dispatch methods that a site can consent to.
cm_infrequent_dispatch, full_asset_schedule_control, limited_pause Tariff information for the site
Show child attributes
Show child attributes
Timestamp when boundary meter consent was given
Created asset details
Show child attributes
Show child attributes
Axle's internal UUID for the asset
Vendor-specific identifier for the asset
Type of asset
boundary meter, charger, battery, heat pump, hot water tank, frequency meter, electric_vehicle ID of the site where the asset is located
Was this page helpful?
curl --request POST \
--url https://api-sandbox.axle.energy/entities/site/{site_id}/offboard-site-and-assets \
--header 'Authorization: Bearer <token>'{
"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
}
}
}