Get Escrow Balances

Read token balances of up to 20 escrows directly from the chain.

Reads the current token balance of one or more escrow contracts directly from the chain. Authoritative — for a bulk financial view with deposits, releases and fees included, prefer GET /escrows/financial.

The reference below is generated from the live API spec — if anything on this page disagrees with it, the reference wins.

Endpoint

Read token balances of one or more deployed escrow contracts

get

Invokes get_multiple_escrow_balances on the multi-release-v2 factory. Each address must be a deployed multi-release-v2 escrow. Maximum 20 addresses per call.

Authorizations

x-api-keystringRequired

Query parameters

addressesstring[]Required

Up to 20 deployed multi-release-v2 escrow addresses to query.

Example: ["CDHAZ2RTE2MDHYQQ7NATF5IVKIFVGLX6FHJ66OPK6MUXBSTRRXFXJ6QB"]

Responses

200

Balances read successfully.

application/json

addressstringRequired

Escrow contract address whose balance was queried.

Example: CDHAZ2RTE2MDHYQQ7NATF5IVKIFVGLX6FHJ66OPK6MUXBSTRRXFXJ6QB

balancenumberRequired

Token balance held by the escrow, in human-readable decimals (already scaled by the trustline decimals).

Example: 1000.5

decimalsnumberRequired

Trustline decimals (e.g. 7 for Stellar USDC). Useful for clients that need to format the value with a fixed precision.

Example: 7

400

Request body or query params fail schema validation (wrong type, missing required field, unknown property).

application/json

401

Missing, malformed, expired, revoked or invalid API key.

application/json

403

API key is valid but does not have the role required for this operation.

application/json

422

Payload is well-formed but a business rule rejects it (e.g. amount out of range, role not allowed for this user).

application/json

500

Unexpected server-side failure. Use the traceId to look up the incident in server logs or contact support.

application/json

get/escrow/multi-release/v2/escrow-balances

GET /escrow/multi-release/v2/escrow-balances?addresses=CDHAZ2RTE2MDHYQQ7NATF5IVKIFVGLX6FHJ66OPK6MUXBSTRRXFXJ6QB HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "address": "CDHAZ2RTE2MDHYQQ7NATF5IVKIFVGLX6FHJ66OPK6MUXBSTRRXFXJ6QB",
    "balance": 1000.5,
    "decimals": 7
  }
]

Field notes

• Up to 20 contract addresses per request.

• Read-only: nothing to sign, nothing to submit.