GET /v1/analytics/summary entrega en una sola llamada todo lo que
necesita la página de resumen de tu cuenta (persona o empresa): series
temporales listas para graficar, el detalle de cada servicio con todas sus
dimensiones (país, moneda, método, estado, chain, comercio), lo que
gastaste en servicios y tus saldos valorizados.
Petición
Bloques globales (los KPI del header y los 3 gráficos principales)
gross_volume: valor USD de todo lo que ENTRÓ (payins, depósitos crypto, transferencias recibidas) y SALIÓ (payouts, retiros, transferencias enviadas, compras con tarjeta). Los reembolsos se netean contra su servicio — jamás inflan el volumen. Los swaps son conversión interna y tienen su propia sección.transactions: conteo de operaciones (sin fees ni reembolsos).new_users: usuarios banking de terceros que tu empresa dio de alta (para cuentas persona la serie va en cero).change_pct: variación contra el período inmediatamente anterior del mismo largo — para los deltas ▲▼ (esnullsi el período anterior fue 0).- Los saldos en
BTC/GOLDse valorizan al precio referencial vigente; si un precio no está disponible, el asset aparece enunpriced_assetsy sus montos quedan fuera del USD (nunca inventamos un precio).
by_country — vista global por país
Payouts y payins combinados, ordenados por volumen — para el mapa o las
barras por país:
sections — el detalle de CADA servicio
Cada sección trae totales, su serie por bucket y sus dimensiones propias:
payouts — envíos fiat
payouts — envíos fiat
by_status te da el success rate; by_country incluye el volumen en
moneda local por cada moneda; by_method separa pix, bank_transfer, yape,
etc. Los fallidos quedan fuera del volumen (fueron reembolsados).payins — cobros fiat
payins — cobros fiat
deposits / withdrawals — crypto on-chain
deposits / withdrawals — crypto on-chain
transfers, swaps y cards
transfers, swaps y cards
banking, verifications (KYC/KYB), aml y contacts
banking, verifications (KYC/KYB), aml y contacts
deposits incluye además wallet_fees_usd (los fees de
creación de wallets del producto crypto), y en balances.items los saldos
espejo de banking llevan custody: "banking" (el saldo autoritativo vive
en el banco).new_third_parties es la misma métrica del gráfico “usuarios nuevos”:
los usuarios banking que tu empresa dio de alta.banking.volume es el dinero movido por tus cuentas bancarias (entrante y
saliente, valorizado a USD): también suma al gross_volume global de la
cuenta, y su detalle cuadra en las secciones BANK_USD/BANK_EUR de la
cartola.spending — lo que consumiste en servicios
Todos los fees explícitos que pagaste en el período, con cuántas veces se
cobró cada servicio:
balances — tus saldos valorizados
Evolución del saldo — GET /v1/balances/history
Para la tarjeta de saldo con gráfico (el “balance de los últimos 30 días”
con su ▲▼): una serie diaria por asset con el saldo de cierre de cada
día, más la serie agregada en USD y las entradas/salidas del período.
- Cada punto es el saldo disponible al cierre del día (UTC); los días sin movimientos arrastran el saldo del día anterior, así la serie queda lista para graficar sin huecos.
assetsincluye también los espejos de las cuentas banking (BANK_USD,BANK_EUR) como serie propia en su moneda (2 decimales) — útiles para un chip “Bank USD”/“Bank EUR” en el gráfico. No entran al agregadototal_usd, que cubre solo los saldos operativos.total_usdvaloriza BTC/GOLD al precio histórico de cada día. Si un día aún no tiene precio histórico se usa el spot de hoy y ese día se declara enspot_priced_dates(jamás inventamos valores).period.in_usd/out_usdson las entradas y salidas totales del rango (misma clasificación quegross_volume) — el ”↗ 254.8K” de la tarjeta.currentes el snapshot de hoy conavailableyheld(la serie histórica solo refleja el disponible: las retenciones no tienen historia).
Evolución de tus tasas — GET /v1/rates/history
La serie temporal de las tasas de cambio de tu cuenta (las mismas de
GET /v1/rates, con tu configuración ya aplicada) para el gráfico de
evolución con su “+3.4% / −3.0%“:
ratees la punta de payouts ypayin_ratela de depósitos — las mismas dos tasas del snapshot actual, punto por punto.change_pctviene con signo ("3.43"sube,"-3.00"baja): úsalo directo para colorear el badge verde/rojo.- Los buckets sin datos arrastran el último valor conocido; los días previos al inicio del historial simplemente no aparecen.
Errores
FAQ
¿En qué zona horaria están los buckets?
¿En qué zona horaria están los buckets?
from/to de toda la API. Si tu front muestra
otra zona, convierte las etiquetas al renderizar.¿Qué cuenta como volumen y qué no?
¿Qué cuenta como volumen y qué no?
spending, y los swaps (conversión entre tus propios
saldos) tienen su sección propia.¿Cómo se valorizan BTC y GOLD?
¿Cómo se valorizan BTC y GOLD?
GET /v1/rates). Es una valorización de exhibición: si el precio no está
disponible, el asset aparece en unpriced_assets y no se suma al USD.¿Los totales cuadran con la cartola?
¿Los totales cuadran con la cartola?
GET /v1/reports/statement)
es el documento contable línea a línea; el analytics es la vista agregada
para gráficos.¿Cada cuánto se actualiza?
¿Cada cuánto se actualiza?
¿Desde cuándo hay historial de tasas?
¿Desde cuándo hay historial de tasas?
¿El historial de saldo incluye las retenciones (held)?
¿El historial de saldo incluye las retenciones (held)?
held vigente viene en el bloque current.¿Por qué la variación de mi tasa difiere de la del mercado?
¿Por qué la variación de mi tasa difiere de la del mercado?