API reference · v1
The Flowion API
One REST API for your whole energy platform: chargers, sites and circuits, prices, sessions and live events. It's the same API the console runs on, and every endpoint here is generated from the code that serves it, so what you read is what's live.
- endpoints
- 470
- resources
- 37
- stable error codes
- 263
# once per shell: where the API is, and your key
# every request carries your key as a bearer credential
Authenticating
Every endpoint takes Authorization: Bearer <credential>, and two kinds of credential work, sent the same way: an ID token from signing in to the console, which identifies a person and is short-lived, and an API key (flw_ak_…), which identifies a program. The resource in the path decides which organization a request is about, checked against real membership. More on authentication
How the API behaves
Every error carries a stable error code to switch on, and a message written for people, which may change.
Lists page by cursor: pass nextCursor back as cursor until it comes back null, up to 100 at a time.
Bursts of up to 30 requests, and two a second sustained, per IP address. Every response tells you how much is left.
Commands take an Idempotency-Key, so a retried request never starts a second session.
One event stream per project tells you the moment a charger, a session or a meter reading changes.
A command returns at once and reports the charger's answer when it comes, even if the charger is offline when you send it. Reading or changing a setting waits for the answer.