Retrieves a paginated list of balances. Supports basic pagination and advanced filtering through query parameters.
Query Parameters Maximum number of balances to return per request. Range: 1-1000Example: ?limit=50
Number of balances to skip before starting to return results. Example: ?offset=20
Advanced Filtering You can filter balances using query parameters in the format field_operator=value.
Supported Operators:
eq: Equalsneq: Not equalsgt: Greater thangte: Greater than or equallt: Less thanlte: Less than or equalin: In list (comma-separated values)like: Pattern matching
Filterable Fields:
currencyledger_ididentity_idindicatorcreated_at
Filter by exact currency match. Example: ?currency_eq=USD
Filter by multiple ledger IDs (comma-separated). Example: ?ledger_id_in=ldg_123,ldg_456
Filter by specific identity ID. Example: ?identity_id_eq=usr_789
Filter balances created on or after this date (ISO 8601 format). Example: ?created_at_gte=2024-01-01
Filter balances created on or before this date (ISO 8601 format). Example: ?created_at_lte=2024-12-31
Response Returns an array of balance objects.
Array of balance objects matching the query. Unique identifier for the balance.
The ledger ID this balance belongs to.
The identity ID associated with this balance.
Optional indicator value for the balance.
The currency code for this balance.
Current balance amount as a big integer string.
Total credits applied to this balance.
Total debits applied to this balance.
Total balance in inflight transactions.
The precision multiplier for this balance.
Version number for concurrency control.
Whether fund lineage tracking is enabled.
The allocation strategy (FIFO, LIFO, or PROPORTIONAL).
ISO 8601 timestamp when created.
Custom metadata attached to the balance.
Examples Basic Pagination
Filter by Currency
Filter by Multiple Ledgers
Filter by Date Range
Combine Filters
curl "https://api.blnk.io/balances?limit=20&offset=0" \ -H "Authorization: Bearer YOUR_API_KEY"
[ { "balance_id" : "bal_123abc" , "ledger_id" : "ldg_456def" , "identity_id" : "usr_789ghi" , "currency" : "USD" , "balance" : "50000" , "credit_balance" : "100000" , "debit_balance" : "50000" , "inflight_balance" : "0" , "currency_multiplier" : 100 , "version" : 15 , "track_fund_lineage" : false , "allocation_strategy" : "FIFO" , "created_at" : "2024-01-15T10:30:00Z" , "meta_data" : {} }, { "balance_id" : "bal_456def" , "ledger_id" : "ldg_456def" , "identity_id" : "usr_321zyx" , "currency" : "USD" , "balance" : "25000" , "credit_balance" : "75000" , "debit_balance" : "50000" , "inflight_balance" : "5000" , "currency_multiplier" : 100 , "version" : 8 , "track_fund_lineage" : true , "allocation_strategy" : "LIFO" , "created_at" : "2024-01-16T14:20:00Z" , "meta_data" : { "account_type" : "savings" } } ]
For large datasets, use limit and offset for pagination:
# Page 1 (first 50 items) curl "https://api.blnk.io/balances?limit=50&offset=0" # Page 2 (next 50 items) curl "https://api.blnk.io/balances?limit=50&offset=50" # Page 3 (next 50 items) curl "https://api.blnk.io/balances?limit=50&offset=100"
Advanced Filtering For complex filtering needs with sorting and count capabilities, use the Filter Balances endpoint which accepts filters in a JSON request body and provides more advanced options. 