Skip to main content
GET
/
api
/
reports
Get a report
curl --request GET \
  --url https://api.sandbox.tracefinance.com/api/reports \
  --header 'Authorization: Bearer <token>'
{ "period": { "start": "2026-04-01T00:00:00Z", "end": "2026-05-01T00:00:00Z" }, "totals": [ { "asset": "BRL", "inflows": { "sum": { "value": "5000.00", "asset": "BRL", "decimals": 2 }, "count": 2 }, "outflows": { "sum": { "value": "10000.00", "asset": "BRL", "decimals": 2 }, "count": 2 } }, { "asset": "USDT", "outflows": { "sum": { "value": "2000.000000", "asset": "USDT", "decimals": 6 }, "count": 2 } } ] }

Documentation Index

Fetch the complete documentation index at: https://tracefinance-docs-withdrawal-beneficiary-events.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.

Headers

​
X-Trace-Version
string

API version. Omit to use the default version.

Example:

"1"

Query Parameters

​
periodStart
string<date-time>
required

Inclusive start of the reporting window. UTC timestamp in ISO 8601 format — the Z suffix is the timezone marker and is required (e.g., 2026-04-01T00:00:00Z). See the Date and time guide for the full format.

​
periodEnd
string<date-time>
required

Exclusive end of the reporting window. UTC timestamp in ISO 8601 format — the Z suffix is the timezone marker and is required (e.g., 2026-05-01T00:00:00Z). Must be strictly greater than periodStart. See the Date and time guide for the full format.

​
filters
string

Common filters for reports:

  • account.id[eq]=a1b2c3d4-5e6f-7890-abcd-ef1234567890 — single account
  • asset[eq]=USD — specific currency
  • tags.key[eq]=psp — operations carrying a tag with this key
  • tags.value[eq]=Amazon — operations carrying a tag with this value

See the Filtering guide for the LHS Brackets syntax and the full operator catalog.

Response

Aggregated report for the requested window.

Aggregated view of operations over a time window. Generated on each request — not persisted.

​
period
object
required

The reporting window. Boundary semantics are half-open — start inclusive, end exclusive.

​
totals
object[]
required

One entry per asset that had at least one settled transaction matching the filter in the period. Empty when nothing matched.