Include inactive tokens in balance response (default: false)
PERS-api Documentation (2.0.12)
PERS API Documentation
This RESTful API enables seamless integration of Web3 loyalty, token management, and engagement features into your applications.
Usage Guidelines:
- RESTful Design: Resources are accessed via standard HTTP methods (GET, POST, PUT, DELETE) with predictable, resource-oriented URLs.
- Authentication: Secure access is enforced via Bearer Tokens (JWT) and Project Keys (defining the Tenant context).
- Data Format: All requests and responses utilize standard JSON formatting.
Explore the modules below for detailed endpoint specifications, schemas, and testing capabilities.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger
Production API
https://api.pers.ninja/v2
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
- Mock serverhttps://docs.pers.ninja/_mock/swagger/balances/accounts/{accountAddress}
- Production APIhttps://api.pers.ninja/v2/balances/accounts/{accountAddress}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/balances/accounts/{accountAddress}?includeInactive=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "accountAddress": "string", "tokenBalances": [ { … } ] }