Skip to main content
GET
Get a wallet statement

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
string
required
Example:

"cus_1A2b3C4d5E6f7G8h9I0jKl"

walletId
string
required
Example:

"wlt_1A2b3C4d5E6f7G8h9I0jKl"

Query Parameters

from
string
required

The first UTC day the statement covers, as YYYY-MM-DD. The day is included.

to
string
required

The last UTC day the statement covers, as YYYY-MM-DD. The day is included and must be fully in the past. The period holds at most 92 days.

cursor
string

Opaque cursor from a previous response. Send meta.nextCursor with the same query to read the next page. A statement reads forward only.

asset
enum<string>
required

The asset the statement covers, as an asset code. Case-insensitive. The wallet is on one chain, so the chain is not a parameter.

Available options:
USD,
EUR,
GBP,
CHF,
JPY,
CAD,
AUD,
NZD,
SGD,
HKD,
CNY,
KRW,
INR,
BRL,
MXN,
ARS,
CLP,
COP,
PEN,
ZAR,
NGN,
KES,
GHS,
EGP,
AED,
SAR,
ILS,
TRY,
PLN,
CZK,
HUF,
SEK,
NOK,
DKK,
THB,
IDR,
MYR,
PHP,
VND,
TWD,
USDC,
USDT,
DAI,
EURC,
PYUSD,
OUSD,
BTC,
ETH,
SOL,
TRX,
XLM,
POL

Response

Every transaction that completed on an account over a period, with what the account held before and after.

account
object
required

The account the statement covers.

asset
object
required
period
object
required

The UTC days the statement covers. Both days are included.

openingBalance
object
required

What the account held when the period began.

closingBalance
object
required

What the account held when the period ended.

totals
object
required

The movement over the whole period.

lines
object[]
required

One page of lines, oldest first. openingBalance, closingBalance and totals cover the whole period on every page.

meta
object
required