API Documentation
- POSTAuthentication
- Assets
- Markets
- Geographies
- Portfolio
- Flexibility Pools
- Webhooks
Update asset
Update an existing assets properties or controller.
Note that to update availability you should use the POST /availability route
curl --request PATCH \
--url https://sandbox.axle.energy/entities/asset/{asset_id} \
--header 'Content-Type: application/json' \
--data '{
"type": "Vehicle",
"alias": "<string>",
"properties": {
"max_import_kw": 123,
"max_export_kw": 123,
"median_response_time_s": 123,
"lat": 123,
"lng": 123,
"lat_lng_polygon": [
{
"lat": 123,
"lng": 123
}
],
"power_measurement_frequency_hz": 123,
"power_measurement_accuracy_pct": 123,
"frequency_measurement_frequency_hz": 123,
"frequency_measurement_accuracy_pct": 123,
"metering_point": "boundary",
"connection_type": "long_term_parallel",
"import_meter_ids": [
"<string>"
],
"voltage_level": 123,
"min_runtime_s": 123,
"max_runtime_s": 123,
"applicable_standards": {
"EU_MID": false,
"UK_MIR": false,
"UK_weights_and_measures_1985": false,
"UK_smart_charging_regs": false,
"UK_COP_11": false,
"UK_PAS_1878": false,
"UK_PAS_1879": false
},
"capacity_kwh": 123
},
"controller": {
"set_level_webhook": "<string>",
"get_level_webhook": "<string>"
},
"is_aggregate": true
}'"<any>"Path Parameters
Body
An enumeration.
Vehicle, Charger, HVAC, Solar Inverter, Storage Version for updates, which makes all fields optional
Latitude of asset location, if fixed
Longitude of asset location, if fixed
Frequency of power measurement, in Hz
Specified or measured accuracy of power measurement, in %
Frequency of frequency measurement, in Hz
Specified or measured accuracy of frequency measurement, in %
An enumeration.
boundary, asset An enumeration.
long_term_parallel, short_term_parallel, timed, flexible, standby, other List of unique identifiers (MPAN) of import meters associated with this asset
Voltage level at point of connection to the network
Minimum time the asset can respond for
Maximum time the asset can respond for
Standards for which this asset is certified
Standards for measuring instruments used in trade, such as electricity meters. Approved instruments will have passed specific conformity assessment procedures and have MID markings which allow the instruments to be used in any EU member state.
Transposes MID into UK law. Baseline requirements for asset participation in DSR.
A 1985 act defining regulation of units of weight and measurement, including measurements of electricity
Specifies minimum requirements for EV charge points
Specifies minimum technical requirements for electricity meters being used for settlement by Balancing and Settlement Code (BSC) parties. CoP 11 specifically for asset metering in a secondary BMU
Criteria that an electrical appliance needs to meet in order to perform and be classified as an energy smart appliance (ESA)
Common definition of demand side response (DSR) services for actors operating within the consumer energy supply chain
Collection of webhooks which we can use to control a particular asset, should a bid including this asset be accepted.
Control of assets can be either via individual AssetControllers or the main webhook.
Webhook for setting level. Will be called with a POST request containing keys level and callback_url. We will use a Bearer token of your choice to authenticate when calling this endpoint.
Webhook for retrieving current power of asset in kw. Will be called with GET. We will use a Bearer token of your choice to authenticate when calling this endpoint.
Response
The response is of type any.
curl --request PATCH \
--url https://sandbox.axle.energy/entities/asset/{asset_id} \
--header 'Content-Type: application/json' \
--data '{
"type": "Vehicle",
"alias": "<string>",
"properties": {
"max_import_kw": 123,
"max_export_kw": 123,
"median_response_time_s": 123,
"lat": 123,
"lng": 123,
"lat_lng_polygon": [
{
"lat": 123,
"lng": 123
}
],
"power_measurement_frequency_hz": 123,
"power_measurement_accuracy_pct": 123,
"frequency_measurement_frequency_hz": 123,
"frequency_measurement_accuracy_pct": 123,
"metering_point": "boundary",
"connection_type": "long_term_parallel",
"import_meter_ids": [
"<string>"
],
"voltage_level": 123,
"min_runtime_s": 123,
"max_runtime_s": 123,
"applicable_standards": {
"EU_MID": false,
"UK_MIR": false,
"UK_weights_and_measures_1985": false,
"UK_smart_charging_regs": false,
"UK_COP_11": false,
"UK_PAS_1878": false,
"UK_PAS_1879": false
},
"capacity_kwh": 123
},
"controller": {
"set_level_webhook": "<string>",
"get_level_webhook": "<string>"
},
"is_aggregate": true
}'"<any>"