JUjubjubapp
v2 - Wallet

Get Unified Balance

Aggregate the user's spendable USDC: smart wallet balance + every catalogue's claimable amount. Used by the frontend to render a single balance number and to drive silent auto-claim before a spend.

get/v2/wallet/unified-balance

Request

  • Base URL
    https://api.jubjubapp.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Headers

Authorizationstring
X-JubJub-Service-Keystring
X-JubJub-Agent-Keystring
X-JubJub-Platform-Keystring
Originstring
Refererstring
X-JubJub-Trial-Tokenstring

Response

Successful Response

total_usdcnumber required

wallet_balance + sum(pending_in_catalogues), in DECIMAL USDC (4.25 means $4.25), the same unit as every other total_usdc. This is the single number the frontend displays as the user's balance.

total_microinteger

The same total in raw USDC units (6 decimals): 4250000 == $4.25. wallet_balance and pending_in_catalogues[].amount are raw too.

wallet_balanceinteger nullable

USDC.balanceOf(wallet) in raw units, or NULL when that read failed. Null is not zero: a zero here would be a specific, spendable-looking claim about a balance nobody could read. Check wallet_balance_read before treating it as a number.

wallet_balance_readboolean

False when USDC.balanceOf failed. total_usdc then excludes the wallet leg entirely and is a floor, not a total.

partialboolean

True when EITHER leg was incomplete — the wallet balance could not be read, or one or more catalogues were skipped. A consumer summing total_usdc has no other way to know something is missing. Auto-claim in particular must not treat a partial picture as a complete one: claiming against it is acting on a number known to be short.

skipped_cataloguesobject[]

Catalogues left out of the sum, each with the reason. Populated for codeless addresses (pre-cutover leftovers); a live catalogue that fails to answer produces a 503 instead of an entry here.

wallet_addressstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.