Download a report
GET /api/v1/account/reports/{report}/orders, /account/history, …) page
through records; this one builds the finished spreadsheet or document.
Content-Disposition: attachment naming
it (tronrental_purchases_2026-08-01_2026-08-31.xlsx).
Reports
Query parameters
to is inclusive: to=2026-08-31 covers that whole day up to 23:59:59.999
in your time zone, and nothing from 1 September.The same
from, to and tz narrow the list endpoints — /orders,
/invoices/my, /account/activations, /account/history and
/account/deposits — so a list and a report over the same period hold the
same records. A list has no one-year cap, because it is paginated.Sections
A report can hold more than one table.purchases, energy and bandwidth
carry the address activations they paid for as a second table; everything
carries four. In XLSX each section is its own sheet; in PDF they follow one
after another, each starting a new page.
A section you have no right to read is absent rather than empty — with a
view-only key, everything simply has no Deposits sheet.
everything does not include invoices. Invoices are scoped to the
authenticated user, while every other section is scoped to the account named
by X-Account-Id, and one file should not mix the two. Request invoices
separately.Totals
Every report ends with aTOTAL row, and purchases add a reference line
beneath it:
- TOTAL sums what was actually charged — orders whose status is
failedare excluded, and any partial refund is already subtracted. - of which failed counts those excluded orders and their price, so the
difference is never silent. The refund for them appears in the
historyreport. - Activation covers every row including failed ones: the recipient address was created and paid for whether or not the energy arrived.
The invoice total counts only invoices that were actually paid; unpaid and
expired ones stay in the file and are summed separately under of which
never paid.
Limits
Errors
Reports are written in English regardless of your account language, and
amounts are in TRX.