How to create an API key
A key lets your own code do what you do on the Buy Energy page: read prices, look up an address and place orders against your balance. It takes about a minute to make one.
2 min · 5 steps · updated September 25, 2026
- 01
Open API Keys
Keys live in the dashboard, next to the balance they spend. Nothing has to be requested from support and nothing has to be approved.
- 02
Give the key a name and create it
The name is for you: it is what you will be reading later, when there are four keys and one of them has to go. Name it after the thing that will hold it — the payout worker, the staging box, the script on your laptop.
A separate key per consumer is worth the ten seconds it costs. Revoking one then stops exactly one thing instead of all of them.
- 03
Copy it while it is on the screen
This is the only moment the key is readable. We keep a hash of it, not the key itself, so a lost key cannot be looked up or sent again — it can only be revoked and replaced.
Put it straight into whatever holds your secrets: an environment variable, a secret manager, the deployment settings. Not into the repository, not into a chat, not into a ticket.
- 04
Make the first request
The quickest check that the key works is asking who it belongs to. The same key opens the full documentation at /api/v1/docs, so there is nothing else to fetch before you start.
From there an order is one POST: an address to send the energy to, and how much of it. The balance is charged as the order is placed, and a refused order is refunded on its own.
- 05
Revoke what you no longer use
The table shows when each key was made and when it was last used — which is usually enough to spot the one nobody needs any more. Revoking takes effect at once, on the next request that key makes.
Revoke without hesitating if a key has been anywhere it should not have been. Making another one costs a minute; a key in the wrong hands spends your balance.
Questions
- What can someone do with my key?
- Place orders against your balance and read your orders, prices and account. It cannot withdraw funds, change your password or sign in as you — but a spent balance is a real loss, so treat the key as a password.
- I lost the key. Can you send it again?
- No. Only a hash of it is stored, which is what stops anyone here reading your key either. Revoke that one and create another.
- How many keys can I have?
- Ten live at a time. Revoked ones stay in the table as a record and do not count.
- Does a key expire?
- No. It works until you revoke it, or until the account is blocked.
- Is there a rate limit?
- 60 requests a minute per key. Over that the API answers 429 with a Retry-After header saying how long to wait.
- Where is the API documentation?
- At /api/v1/docs, opened with the same key. It is the single source: every endpoint, field and error is described there.