For the complete documentation index, see llms.txt. This page is also available as Markdown.

API reference

Every Energy Rental API endpoint and the rules that apply to all of them.

The Energy Rental API is the on-demand API described in the Overview: your system requests energy for each transaction before it broadcasts. A rental is the energy delegated to the receiver, the address that sends the transaction and receives the energy, for one transaction. For a first rental end to end, follow the Quickstart.

Endpoint
Method and path
What it does

GET /v1/capacity

Returns the energy available now and the current wait

POST /v1/estimate

Returns the energy and bandwidth a transfer needs

GET /v1/accounts/{address}

Returns the activation, free bandwidth and energy of an address

POST /v1/accounts/activate

Puts a new address on chain so it can receive energy

POST /v1/rentals

Requests energy for a transaction

GET /v1/rentals/{id}

Returns the status and on-chain record of one rental

GET /v1/rentals

Lists all your rentals, newest first

GET /v1/usage

Returns daily rentals, activations and energy over a date range

Rules for every endpoint

Topic
Page

Headers and request signing

Base URL, formats, rate limits and retries

Statuses, the 10-second window and queued requests

Error format and every code

Each endpoint page has cURL, Node.js and Python samples. The cURL samples sign the request inline and need BASE_URL, API_KEY and API_SECRET in your environment. The Node.js (18 or later) and Python (3.9 or later, with requests) samples call the signing helper from Authentication and signing. Sample IDs, addresses and hashes are illustrative.

Last updated