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:

import axios from "axios";

const http = axios.create({
  baseURL: "https://beta.api.trustlesswork.com",
  timeout: 10000,
  headers: {
    "Content-Type": "application/json",
    "x-api-key": your_api_key,
  },
});

export const useExample = async () => {
  const contractIds = [
    "CCR6HLU3LQMXOESNA6TOS2RZKGEBWQG3EN5FMZNC43RVXZWTTDCZ...",
    "CCA7WTCVCQ5JPKNIFSHPSJLJ3FJ3GKPNEVAIHP6T..."
  ];

  const params = new URLSearchParams();
  contractIds.forEach(id => params.append("contractIds", id));

  const response = await http.get(`/escrows/financial?${params.toString()}`);
  return response.data;
}

balance comes from the read-model, which is eventually consistent. Right after funding an escrow it may still show the previous value — poll rather than treating it as an error.