Skip to main content
GET
/
rewards
/
{site_id}
/
info
Get Balance Info
curl --request GET \
  --url https://api-sandbox.axle.energy/rewards/{site_id}/info \
  --header 'Authorization: Bearer <token>'
{
  "current_balance_pence": 123,
  "total_earnings_pence": 123,
  "minimum_withdrawal_threshold_pence": 123,
  "withdrawal_min_wait_days": 123,
  "can_withdraw": true
}

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.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
site_id
string<uuid>
required

Response

Successful Response

Response model for site balance information.

​
current_balance_pence
integer
required

Current balance of the site in pence (total earnings minus total withdrawals)

​
total_earnings_pence
integer
required

Lifetime earnings of the site in pence

​
minimum_withdrawal_threshold_pence
integer
required

The minimum a user can withdraw in one transaction, in pence

​
withdrawal_min_wait_days
integer
required

The number of days a user must wait to withdraw after their first reward

​
can_withdraw
boolean
required

Whether the user can withdraw their balance