For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Escrows Financial

Balances, deposits, releases and fees for up to 50 escrows via GET /escrows/financial.

This endpoint replaces GET /helper/get-multiple-escrow-balance. It returns more than the balance — the whole financial picture of each escrow.

Headers

Name
Value

Content-Type

application/json

x-api-key

<token>

Open API

GET /escrows/financial

Returns the financial view of up to 50 escrows in a single request.

Query parameters

Name
Type
Description

contractIds

string[] (1–50)

Contract addresses (C…). Repeat the parameter once per id.

What this Endpoint returns?

For each escrow:

Field
Meaning

balance

Projected current balance held by the escrow

totalDeposited

Everything ever deposited

totalReleased

Everything already released

pendingRelease

Approved but not yet released

nextRelease

The next release due, when determinable

fee

Platform fee configured for the escrow

asset

Resolved asset: name, address, contractId, decimals

All amounts are decimal strings, not floats — parse them with a decimal library rather than Number() if you intend to do arithmetic on them.

Unknown ids are silently absent from the response.

Use Example:

Last updated