splitwise_get_balances
Summarize who owes you and whom you owe per friend and currency, plus net totals for settling up.
Instructions
Summarise who owes you and whom you owe, per friend and per currency.
Calls GET /get_friends once and, from each friend's balance list, renders every
non-zero balance per currency, plus per-currency totals: how much you are owed, how
much you owe, and the net. Friend balances already combine group and non-group
expenses. Sign convention: positive = the friend owes you (owed to you); negative =
you owe the friend. Zero balances are hidden unless include_zero is true; the
optional currency filter keeps a single currency (applied locally — the endpoint
takes no filter). An amount Splitwise sends that is not a plain decimal, or an entry
with no currency, is shown raw and flagged, and left out of the totals.
When to Use:
"How much am I owed / do I owe overall?", "who owes me money?", "my USD balance".
Before settling up, to see every open balance in one call.
When NOT to Use:
For balances inside ONE group and who pays whom there (use
splitwise_get_group_balances).For friend profiles, e-mails or per-group breakdowns (use
splitwise_get_friends/splitwise_get_friend).To find a friend's id from a name (use
splitwise_resolve_friend).
Returns:
Markdown: the sign convention, a totals table (Currency | You are owed | You owe | Net)
and a table of friends (First Last (id N) with e.g. +12.50 USD, -3.00 PEN; with
include_zero, settled up or no USD balance), capped at 50 rows (totals cover every
friend except the flagged entries). JSON: {sign_convention, currency_filter, totals: {CUR: {owed_to_you, you_owe, net}}, unparsed: [{friend_id, currency_code, amount, reason}], friend_count, friends: [raw friend objects]} with you_owe as a positive magnitude and
money as 2-decimal strings.
Examples:
params = {}
params = {"currency": "USD"}
params = {"include_zero": true, "response_format": "json"}
Error Handling:
A bad currency (not 3 letters) is rejected before any call. 401 means the API key is
missing or was regenerated; 429 means back off (Retry-After). Errors come back as an
Error ... string.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |