Skip to main content
GET
This endpoint provides real-time balance information with multi-chain support and historical querying capabilities.

ssUSD Balance API

Query StateSet USD (ssUSD) balances with comprehensive filtering, multi-chain aggregation, and real-time updates.

🔑 Authentication

📋 Path Parameters

address
string
required
The blockchain address to query. Supports multiple formats:
  • StateSet: stateset1qypqxpq9qcrsszg2pvxq6rs0zqg3yyc5lzv7xu
  • Ethereum/Base: 0x742d35Cc6634C0532925a3b844Bc9e7595f6E321
  • Solana: DezXAZ8z7PnrnRJjz3wXBoRgixCa6xjnB7YaB1pPB263

🔍 Query Parameters

chains
array
Filter by specific chains or query all chainsOptions: ["stateset", "base", "solana", "cosmos"]Default: All chains where address has balance
include_pending
boolean
default:false
Include pending transactions in balance calculationUseful for showing “available” vs “total” balance
include_locked
boolean
default:true
Include locked/vesting balances in response
at_height
integer
Query historical balance at specific block heightExample: 1542389
at_timestamp
string
Query historical balance at specific timeFormat: ISO 8601 (e.g., 2024-06-25T12:00:00Z)
convert_to
string
Convert balance to another currencyOptions: USD, EUR, GBP, JPY, etc.

📤 Response

address
string
The queried blockchain address
balances
object
Balance breakdown by type and chain
chains
array
Balance breakdown by blockchain
conversions
object
Balance in other currencies (if requested)
metadata
object
Additional account information

💡 Common Use Cases

Treasury Dashboard

Payment Processing

Multi-Signature Wallet

🔔 Webhooks

Subscribe to balance change events:

🚨 Error Handling

Transfer ssUSD

Send ssUSD to another address

Transaction History

View transaction history

Analytics

Balance analytics and insights

Reserves

View backing reserves