API reference

Blocks and transfers

Read blocks, transfers, confidential accounts, proof of balances and compliance events.

List blocks

GET/blocks
QueryDefaultMeaning
limit20Number of blocks, up to 100
beforeNewestStart at this height and count down, inclusive. For the next page, pass the lowest height you have minus 1.

Returns an array of blocks, newest first, without their transfers. GET /blocks/latest returns just the newest block.

Get a block

GET/block/:height

Returns the block and a transactions array with every transaction it contains, in order, in their public view (see below). Transfers between accounts show only their hash, status, time, block and fee. Returns 404 if the block does not exist yet. See Architecture for every field.

List transfers

GET/txs
QueryDefaultMeaning
limit20Number of transfers, up to 100

Returns the most recent sealed events across the network, newest first, in their public view.

Get a transfer

GET/tx/:hash

With a read pass from its sender or recipient, the whole transaction:

200 OK
{
  "type": "transfer",
  "from": "0x1323a980c3e4736108741dacdad57d08e60bd827",
  "to": "0x38496f6877382de8255668ae407f4c0ea2acc0f7",
  "amount": "12.5",
  "fee": "0.01",
  "nonce": 0,
  "memo": "Hello from the docs",
  "time": 1793731653002,
  "sig": "0x2c96fda2…1ca36b3b0b1c",
  "salt": "9b1e04c27d3f8a6650e2b1c4d7a9f031",
  "hash": "0x85d82a5cd8488ef23a7bf9c63954243d0b2c2ec86496b5d13245d3d0d49e2d63",
  "status": "final",
  "block": 5,
  "index": 0
}
FieldMeaning
typetransfer, mint, freeze, unfreeze, bridge_in or bridge_out
statuspending, final or failed
block, indexWhere the event was sealed
errorPresent when status is failed
reasonPresent on compliance actions
sourcePresent on bridge events: { chain, tx } of the other leg
salt16 random bytes inside the hash, so a hash can't be matched to a guess of its contents

Mints and compliance actions come from the issuer address and have no signature.

Anyone else gets the public view:

200 OK (public view)
{
  "hash": "0x85d82a5cd8488ef23a7bf9c63954243d0b2c2ec86496b5d13245d3d0d49e2d63",
  "type": "transfer",
  "status": "final",
  "time": 1793731653002,
  "block": 5,
  "index": 0,
  "fee": "0.01",
  "confidential": true
}

Deposits (bridge_in) and releases (bridge_out) also show amount, source { chain, tx } and attested, the bridge signers' verdict; never the account on USD Network. Freezes and unfreezes are public in full.

The hash is 0x + SHA-256 of the canonical JSON of { chain, type, from, to, amount, fee, nonce, memo, time, sig, source, attest, salt } (sorted keys, no whitespace, absent fields left out). A receipt is exactly those fields, so whoever has it can check it against the public hash.

Get an account

GET/address/:address
QueryDefaultMeaning
limit50Number of recent transfers to include, up to 200

With a read pass signed by that address, returns address, balance, nonce, frozen, txs, firstSeen and transactions, the account's recent events in full, newest first. Unknown addresses return a zero balance rather than 404. See Accounts and addresses.

Without one it returns only { "address", "confidential": true, "frozen" }. The protocol's own accounts return their balance to anyone.

Proof of balances

GET/balances

The latest signed snapshot of every balance and the last 24: head { chain, id, height, time, root, total, count }, the sequencer's sig over it and its key, the supply at that height and matches (whether the total equals it). See Proof of balances.

GET/balances/proof/:address

With a read pass from that address: the snapshot plus leaf { address, balance, salt }, path (sibling h hash, s sum and left, from the leaf up) and included. An account with no balance at that height isn't in the tree and gets included: false.

Compliance log

GET/compliance

Returns up to 100 freeze and unfreeze events, newest first, each with the affected address in to and the reason in reason.