4. Assets

Get Todays Dispatch Schedule

Changed on

Get today's dispatch plan for a battery: the ordered periods describing how the inverter and battery are scheduled to operate today (in UK time), each with a start time, an end time and an action of CHARGE, DISCHARGE, LOCK, FEED_IN or SELF_USE. LOCK holds the battery at its current state of charge.

Each period may carry a plain-language reason, and the plan a summary of the day. Either is null when no explanation is available. The first request after a plan is built or rebuilt prepares these explanations, so it can take several seconds longer than later requests.

Plans are only generated in the production environment: anywhere else, including the sandbox, this returns an empty plan ({"summary": null, "periods": []}).

The asset_id is the one returned when the asset was onboarded, and can also be found via GET /entities/asset. Only batteries have a plan of this shape, so any other asset type is a 404, indistinguishable from an unknown asset.

An empty plan is also returned when a battery has no plan for today: it is not optimised (no asset model recorded, or no full schedule control or wholesale market consent), or today's plan has not been generated yet. The response does not distinguish between these.

get/entities/asset/{asset_id}/todays-dispatch-schedule

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/entities/asset/{asset_id}/todays-dispatch-schedule
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Path parameters

asset_idstring uuid required

Response

Today's dispatch plan retrieved

summarystring

Changes