Skip to content
Download OpenAPI description
Overview
Languages
Servers
Mock server

https://docs.pers.ninja/_mock/swagger/

https://api.pers.ninja/v2/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Account Balance Management

Real-time balance tracking and management across all token types and user accounts. Provides comprehensive balance queries and balance-related operations.
**Balance Features:**

• **Multi-Token Balances:** Track balances across different token types per user

• **Real-Time Updates:** Instant balance updates from all transaction sources

• **Balance History:** Historical balance tracking and change audit trails

• **Balance Queries:** Flexible balance lookup with filtering and aggregation

• **Balance Notifications:** Alert systems for balance changes and thresholds

Get account balance by address (Admin)

Request

Get detailed balance information including token metadata for any account address. Requires tenant admin privileges. Replaces GET /balance/admin/account/{accountAddress}

Security
tenantAdminJWT
Path
accountAddressstringrequired
Query
includeInactiveboolean

Include inactive tokens in balance response (default: false)

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/balances/accounts/{accountAddress}?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Account balance retrieved successfully

Bodyapplication/json
accountAddressstringrequired
tokenBalancesArray of objects(TokenMetadataBalanceDTO)required
tokenBalances[].​contractAddressstringrequired
tokenBalances[].​chainIdnumberrequired
tokenBalances[].​balancenumberrequired
tokenBalances[].​tokenNamestring
tokenBalances[].​tokenSymbolstring
tokenBalances[].​tokenTypestringrequired
tokenBalances[].​tokenIdstring or nullrequired
tokenBalances[].​metadataUristring or nullrequired
tokenBalances[].​metadataobjectrequired
Response
application/json
{ "accountAddress": "string", "tokenBalances": [ { … } ] }
Operations
Operations
Operations
Operations
Operations