Skip to main content
GET
Full agreement for one month

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Query Parameters

month
string
required
Example:

"2026-09"

client
string<uuid>[]

One client entity id, or several comma-separated.

Minimum array length: 1
Example:

"3f1c...,9a2b..."

account
string<uuid>
custodian
string

Custodian provider (dfns) or a connection id.

Maximum string length: 128
status
enum<string>
Available options:
tied,
break,
unreconcilable,
pending,
explained
network
string
Maximum string length: 128
Example:

"ethereum"

asset
string

Asset symbol or token address.

Maximum string length: 128
Example:

"USDC"

Matches the client, account, custodian, or address.

Maximum string length: 200
group_by
enum<string>
Available options:
client,
custodian,
status
limit
number
default:50
Required range: 1 <= x <= 200
cursor
string
Maximum string length: 512

Response

200 - application/json
month
string
required
Example:

"2026-09"

final
boolean
required

True once the month has been closed. Lines stay put except for a wallet-scoped rerun.

as_of
string<date-time> | null
required

Exclusive end of the latest computation. Null before any run for the month.

summary
object
required
wallets
object[]
required
meta
object
required
sign_off
object | null
required
groups
object[]

Present when group_by is set. Each group is paged with the request limit and cursor. Counts are the whole group. Top-level wallets and meta stay the flat page.