Skip to content

Account information and balance

GET
/userinfo

Returns user details, balance and accumulated statistics. The user is identified by the API key; the request takes no parameters.

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"

Responses

Account data.

application/json
JSON
{
  
"status": "success",
  
"timestamp": "2025-09-02 05:56:11",
  
"user_id": 6,
  
"user_info": {
  
  
"email": "string",
  
  
"name": "string",
  
  
"deposit_address": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE"
  
},
  
"stats": {
  
  
"balance": 28361.15,
  
  
"total_delegations": 96756,
  
  
"total_energy_delegated": 21687058023,
  
  
"total_trx_spent": 832181.95,
  
  
"total_deposit": 0,
  
  
"avg_rate_sun_energy": 38.37,
  
  
"save_by_netts_percent": 61.63,
  
  
"save_in_dollars": 453267.36
  
},
  
"network_info": {
  
  
"trx_price": 0.3391,
  
  
"network_energy_fee": 100
  
}
}

Playground

Authorization
Headers

Samples

Powered by VitePress OpenAPI