GET /v1/analytics/summary returns in a single call everything the
summary page of your account (person or company) needs: chart-ready time
series, the detail of every service with all its dimensions (country,
currency, method, status, chain, merchant), what you spent on services and
your balances valued in USD.
Request
You only see your own account’s data. All amounts are USD decimal
strings; buckets without activity come zero-filled so you can chart
directly.
Global blocks (header KPIs and the 3 main charts)
gross_volume: USD value of everything that came IN (payins, crypto deposits, received transfers) and went OUT (payouts, withdrawals, sent transfers, card purchases). Refunds are netted against their service — they never inflate volume. Swaps are internal conversion and have their own section.transactions: operation count (fees and refunds excluded).new_users: third-party banking users your company registered (zero series for person accounts).change_pct: variation vs the immediately previous period of the same length — for the ▲▼ deltas (nullwhen the previous period was 0).BTC/GOLDare valued at the current reference price; if a price is unavailable the asset is listed inunpriced_assetsand its amounts stay out of the USD totals (we never invent a price).
by_country — global view per country
Payouts and payins combined, ordered by volume — for the map or per-country
bars:
sections — the detail of EVERY service
Each section carries totals, its per-bucket series and its own dimensions:
payouts — fiat sends
payouts — fiat sends
by_status gives you the success rate; by_country includes local
currency volume per currency; by_method splits pix, bank_transfer, yape,
etc. Failed payouts are excluded from volume (they were refunded).payins — fiat collections
payins — fiat collections
deposits / withdrawals — on-chain crypto
deposits / withdrawals — on-chain crypto
transfers, swaps and cards
transfers, swaps and cards
banking, verifications (KYC/KYB), aml and contacts
banking, verifications (KYC/KYB), aml and contacts
deposits section also includes wallet_fees_usd (the wallet creation
fees of the crypto product), and inside balances.items the banking mirror
balances carry custody: "banking" (the authoritative balance lives at the
bank).new_third_parties is the same metric as the “new users” chart: the
banking users your company registered.banking.volume is the money moved through your bank accounts (inbound and
outbound, valued in USD): it also adds to the account’s global
gross_volume, and its detail reconciles in the BANK_USD/BANK_EUR
sections of the statement.spending — what you consumed in services
Every explicit fee you paid in the period, with how many times each service
was billed:
balances — your balances valued
Balance evolution — GET /v1/balances/history
For the balance card with a chart (the “last 30 days balance” with its ▲▼):
a daily series per asset with each day’s closing balance, plus the
aggregated USD series and the period’s inflows/outflows.
- Each point is the available balance at that day’s close (UTC); days without movements carry the previous day’s balance forward, so the series has no gaps and charts directly.
assetsalso includes the banking account mirrors (BANK_USD,BANK_EUR) as their own series in their own currency (2 decimals) — handy for a “Bank USD”/“Bank EUR” chip on the chart. They are not part of thetotal_usdaggregate, which only covers the operational balances.total_usdvalues BTC/GOLD at each day’s historical price. When a day has no historical price yet, today’s spot is used and that day is disclosed inspot_priced_dates(values are never invented).period.in_usd/out_usdare the range’s total inflows and outflows (same classification asgross_volume) — the ”↗ 254.8K” of the card.currentis today’s snapshot with bothavailableandheld(the historical series only tracks the available balance: holds have no history).
Your rates over time — GET /v1/rates/history
The time series of your account’s FX rates (the same rates as
GET /v1/rates, with your configuration already applied), for the rate
evolution chart with its “+3.4% / −3.0%” badge:
rateis the payout side andpayin_ratethe deposit side — the same two rates as the current snapshot, point by point.change_pctcomes signed ("3.43"up,"-3.00"down): use it directly to color the badge green/red.- Buckets without data carry the last known value forward; days before history started are simply absent.
Errors
FAQ
Which timezone are buckets in?
Which timezone are buckets in?
UTC, same as the
from/to filters across the whole API. If your front
shows another timezone, convert the labels when rendering.What counts as volume and what does not?
What counts as volume and what does not?
Everything that moved money to/from your account: payins, crypto deposits
and received transfers (in); payouts, withdrawals, sent transfers and card
purchases (out). Refunds are netted, fees are reported separately in
spending, and swaps (conversion between your own balances) have their own
section.How are BTC and GOLD valued?
How are BTC and GOLD valued?
At the reference price in force at query time (the same as
GET /v1/rates). It is a display valuation: if a price is unavailable, the
asset appears in unpriced_assets and is not added to the USD totals.Do totals match the account statement?
Do totals match the account statement?
Yes: both come from the same ledger. The statement
(
GET /v1/reports/statement) is the line-by-line accounting document; the
analytics endpoint is the aggregated view for charts.How fresh is the data?
How fresh is the data?
Real time: every credited operation appears in the next call.
Since when is rate history available?
Since when is rate history available?
Rate history is recorded continuously (every time the rate changes) and
includes an initial backfill of ~90 days of daily rates. If you request a
range before history started, those days are simply absent from the
series — values are never invented.
Does the balance history include holds?
Does the balance history include holds?
No: the series tracks the available balance at each day’s close. Holds
(in-flight payouts, card holds) have no history; today’s
held comes in
the current block.Why would my rate's change differ from the market's?
Why would my rate's change differ from the market's?
It doesn’t: your rate derives from the market rate through your commercial
configuration, which is a constant factor — the percentage change is the
same. What you see charted is exactly what you would have gotten operating
each day.