Reports

Download Account Statement

Changed on

Returns a PDF statement of one distribution account for a period: the payments the account sent and received on the Stellar ledger, per asset, with opening and closing balances. The statement is built from the account's most recent 10,000 ledger payments (any asset, counting back from now), so a period that reaches further back is refused.

get/reports/statement

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Query parameters

from_datestring date required

First day of the period, YYYY-MM-DD, UTC.

to_datestring date required

Last day of the period, inclusive (to 23:59:59 UTC). Must not be before from_date.

asset_codestring

Asset to report on, matched case-sensitively against the tenant's active assets; XLM or NATIVE selects the native asset. Omit it to cover every asset the account currently holds.

Headers

X-Wallet-Idstring

Names the distribution account the statement covers. Archived accounts can be named. Can be omitted only when the caller can reach exactly one account (archived ones count).

Response

The statement PDF.

Changes