Markets

API Reference

Signup Flow

axle energy

Get Started

Home

Post availability events for assets. This provides a single endpoint
to which you can post an event stream.

Note that you can also use callbacks on individual assets to update
their availability.

Post updated asset availabilities

Periods

Availability

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.

Kwh Available

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.

Max Power Kw

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.

Min Power Kw

Period End

Period Start

kW (at the end of the time period). This value should be positive when referring to import and negative when referring to export.

Power Kw

Updated At

AvailabilityPeriod

Location

Message

Error Type

ValidationError

Updates to the availability of an asset or aggregate

AvailabilityUpdateEvent

HTTPValidationError

Update Availability

Register and prequalify assets, participate in flexibility markets, and monetize. 

Introduction

Access flexibility markets with ease

Learn the building blocks of market flexibility

Core concepts

How to use axle

Setting up an environment

Add an asset

Check qualified markets

Tell us when the availability of your assets changes

Updating asset availability

Execute optimal bidding for selected markets

Submit bids

Authentication

Retrieve a list of all assets for a given user

Get all assets

Get asset

Create asset

Update an existing assets properties or controller.

Note that to update availability you should use the POST /availability route

Update asset

Add to an existing asset availability's, including power and
energy readings.

This can be used to provide historical data, or your own forecasts.

Note that there is no deduplication here. If you post a new availability
update for a timepoint for which we already have an availability record,
we'll use the latest one, but the original one will not be overwritten.

Update asset availability

Provide an update on the handling of a given event by a given asset

Update event status

Delete asset

Get all markets

Get market

Retrieve all assets eligible for a specified market

Get pool of eligible assets for market

Get market prices

Retrieve all assets registered to a specified market

Get pool of registered assets for market

List geographies

Get markets for geography

List all valid bidding zones for a geography

Get bidding zones for geography

Get the forecast demand for this portfolio, including the maximum and minimum demand for each time period,
based upon known constraints such as existing schedules.

Get forecast demand for portfolio

Based on the current demand forecast for a given portfolio, return the optimal set of positions given prices
on the specified market.

Returns suggested positions, along with appropriate market (day ahead or continuous, based upon the selected time
period)

Get optimal positions for portfolio

Add an asset to the active pool for a market

Register asset to pool

Get probabilistic forecasts of availability for this pool, describing
the available flexibility at varying probabilities.

Get pool availabilty

Returns the optimal set of bids for a given pool for the next `time_horizon_hours`, accounting
for uncertainty in flex availability.

Get optimal bids for pool

Place bids for pool

Get bids for pool

Get example dispatch event

Register a webhook to receive and acknowledge dispatch events,
to be signed with your secret.

API Documentation

Post updated asset availabilities

Body

Response