Get panel-wide payout totals

Server URLloading...

GET

/balances/summary

Send

Authorization

Available and pending payout totals across every connected account, in one query and zero platform calls.

These are last-known values, not live ones. payoutAvailable is only knowable by asking the platform, so a live panel-wide total would cost one round trip per account — the honest trade is to serve the last sample and say how old it is. GET /accounts/{of_user_id}/balances stamps a fresh sample each time it runs, so normal dashboard use keeps the figures warm at no extra cost.

Label the number with oldest_sample_at / newest_sample_at, and treat accounts_never_sampled as "not counted yet" rather than zero. currency is the panel's most common currency.

Guide: Earnings & transactions

Response Body

curl -X GET "https://example.com/balances/summary"

{  "accounts": 0,  "accounts_never_sampled": null,  "accounts_with_balance": null,  "currency": null,  "newest_sample_at": null,  "oldest_sample_at": null,  "success": true,  "total_available": 0,  "total_pending": 0}