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

Read the projected financials of a batch of escrows

get

Pass up to 50 contract addresses and get, for each known escrow, the PROJECTED financial view: fee, total amount, summed deposit trail, released/pending value, next tranche and a projected balance. Derived from the read-model only (never a chain call), so figures are eventually consistent — the authoritative balance lives on-chain. Unknown ids are silently absent.

Authorizations

x-api-keystringRequired

Query parameters

contractIdsstring[] · min: 1 · max: 50Required

On-chain contract addresses (repeat the param: contractIds=C…&contractIds=C…, 1–50). Inaccessible or unknown ids are silently absent from the response.

Example: ["CAAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQC526"]

Responses

200Success

application/json

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

get/escrows/financial

GET /escrows/financial?contractIds=CAAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQC526 HTTP/1.1
Host: beta.api.trustlesswork.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "contractId": "text",
      "type": "text",
      "assetInfo": {
        "name": "USDC",
        "address": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
        "contractId": "CBIELTK6YBZJU5UP2WWQEUCYKLPU6AUNZ2BQ4WWFEIE3USCIHMXQDAMA",
        "decimals": 7,
        "resolved": true
      },
      "platformFee": "5",
      "amount": "250.5",
      "totalDeposited": "text",
      "totalReleased": "text",
      "pendingRelease": "text",
      "nextRelease": {
        "milestoneIndex": 0,
        "amount": "250.5"
      },
      "balance": "text"
    }
  ]
}

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.