Skip to main content
GET
Account statement for a period

Authorizations

Authorization
string
header
required

OAuth 2.0 client_credentials grant. Send client_id:client_secret as HTTP Basic, or as form fields. Tokens are HS256 JWTs valid for one hour (configurable). Decode them at jwt.io.

Path Parameters

id
string
required

Query Parameters

from
string<date-time>

Inclusive lower bound on value_date.

to
string<date-time>

Exclusive upper bound on value_date. Defaults to now.

limit
integer
default:500
Required range: 1 <= x <= 5000

Response

Statement

object
enum<string>
required
Available options:
account_statement
account
string
required
Example:

"cash:usd"

currency
string
required
Example:

"USDC"

period
object
required
opening_balance
object
required
closing_balance
object
required
entries
object[]
required
entry_count
integer
required
truncated
boolean
required

True when the period held more entries than limit returned.