Skip to content

Reclaim energy early

POST
/energy/reclaim/{orderId}

Returns delegated energy to the pool before the rental period ends. The operation is voluntary: rentals expire on their own, you never have to call this method.

Nothing is refunded. Renting and returning are separate operations: you paid when you placed the order, and returning the resource early does not undo it.

Reclaim works per order, not per address. One address may hold energy from several orders, including other accounts'. A batch over many addresses produces one order number per address, and a large amount for a single address may be split across several orders — to free that address completely, reclaim each of them.

An order can only be reclaimed with the key that created it: another key of the same account will not work.

Calling it twice is safe — the same hash is returned; this also covers rentals that already expired on their own.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Parameters

Header Parameters

X-Real-IP*

An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.

Type
string
Required
Example"203.0.113.10"
Format
"ipv4"

Path Parameters

orderId*

Order number: 1H… for hourly rentals, 5M… for five-minute ones.

Type
string
Required
Example"1Hb252feadcc"

Responses

Energy reclaimed, or already reclaimed earlier (10004).

application/json
JSON
{
  
"detail": {
  
  
"code": 10004,
  
  
"status": "reclaimed",
  
  
"msg": "Energy reclaimed",
  
  
"data": {
  
  
  
"orderId": "string",
  
  
  
"reclaimHash": "3636f97dde244fca17cdc0b2cf7fd157a4b0de94d8fbd4c190d5378ba911dfae"
  
  
}
  
}
}

Playground

Authorization
Headers
Variables
Key
Value

Samples

Powered by VitePress OpenAPI