Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.axle.energy/llms.txt

Use this file to discover all available pages before exploring further.

onboard covers the standard flow in a single call. If you need to do work between site creation and enrolment, you can call the constituent endpoints — initialise and enrol — separately.

​
How it works

The flow splits into two API calls:
  1. Initialise — creates/upserts the site and assets, and returns eligibility information. No enrolment side effects.
  2. Enrol — the commitment point. Allows scheduling and begins market participation.
Reach for this flow if you need to do something between site creation and enrolment. Otherwise, most use cases should be covered by onboard.
To reverse enrolment, use the unenrol endpoint — this stops the specified proposition without deleting the site, leaving other propositions and the option for the same user to re-enrol later intact. To remove the site entirely, use offboard instead.

Initialise

Create/upsert site and assets

Enrol

Enrol site in a proposition

Unenrol

Unenrol from a proposition