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

Get Escrow

Read one escrow in full: state, participants, timeline and deposits.

Headers

Name
Value

Content-Type

application/json

x-api-key

<token>

Open API

GET /escrows/{contractId}

Reads one escrow in full: current state, participants, event timeline and deposits.

Name
Type
In
Description

contractId

string

path

On-chain escrow address (C…, 56 chars)

What this Endpoint returns?

{
  "escrow": { /* state + snapshot + asset + balance */ },
  "events": [ /* first 200 */ ],
  "eventsHasMore": true,
  "deposits": [ ]
}

If eventsHasMore is true, page the rest with GET /escrows/{contractId}/events.

A 404 ESCROW_NOT_FOUND means the contract is unknown on this network.

Use Example:

There is also GET /escrow/<family>/v2/{contractId}, which reads the same escrow directly from the contract. That one is authoritative but slower and returns only contract state. Use this page's endpoint for speed, history and deposits; use the contract read when the value is about to drive a decision.

These reads come from the read-model, which is eventually consistent. Right after submitting a transaction a 404 usually means "not projected yet", not "does not exist" — poll briefly instead of treating it as an error.