API Documentation
- POSTAuthentication
- Assets
- Markets
- Geographies
- Portfolio
- Flexibility Pools
- Webhooks
Create asset
Register a new asset with flexible load
curl --request POST \
--url https://sandbox.axle.energy/entities/asset \
--header 'Content-Type: application/json' \
--data '{
"type": "Vehicle",
"is_aggregate": false,
"alias": "<string>",
"bidding_zone": "DE_TENNET",
"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>"
},
"availability": {
"periods": [
{
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"min_power_kw": 123,
"max_power_kw": 123,
"power_kw": 123,
"kwh_available": 123,
"updated_at": "2024-07-11T09:28:23.183984+00:00"
}
]
}
}'{
"id": "<string>"
}Body
An enumeration.
Vehicle, Charger, HVAC, Solar Inverter, Storage An enumeration.
DE_TENNET, DE_TRANSNET, DE_AMPRION, DE_50HZ, DK1, DK2, SE1, SE2, SE3, SE4, NO1, NO2, NO3, NO4, NO5, UK, NL, FR, IE, IT, FI, BE, ES, AT, BG, HU, HR, CZ, EE, GR, LV, PT, PL Properties of an asset that are relevant to participation in markets
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
Whether this asset is an aggregate of other assets
Alias for this asset or aggregate, for instance the name of the site(s) or specific competitions to which it is targeted.
Webhook for controlling the asset; can use webhook event stream instead if preferred
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.
Start of the time period (UTC)
End of the time period (UTC)
Minimum available kW (at the end of the time period). This value is equivalent to the power of the asset if all available turn down is performed. This value should be positive when referring to import and negative when referring to export.
Maximum available kW (at the end of the time period). This value is equivalent to the power of the asset if all available turn up is performed. This value should be positive when referring to import and negative when referring to export.
kW (at the end of the time period). This value should be positive when referring to import and negative when referring to export.
Expected kwh of flexibility available until asset becomes unavailable. If, for instance, the asset has a charge limit of 50kwh and a current SOC of 25kwh, then the kwh_available would be 25.
Response
curl --request POST \
--url https://sandbox.axle.energy/entities/asset \
--header 'Content-Type: application/json' \
--data '{
"type": "Vehicle",
"is_aggregate": false,
"alias": "<string>",
"bidding_zone": "DE_TENNET",
"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>"
},
"availability": {
"periods": [
{
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"min_power_kw": 123,
"max_power_kw": 123,
"power_kw": 123,
"kwh_available": 123,
"updated_at": "2024-07-11T09:28:23.183984+00:00"
}
]
}
}'{
"id": "<string>"
}