GET /v1/analytics/summary 通过一次调用返回您账户(个人或企业)
概览页所需的全部数据:可直接绘图的时间序列、每个服务及其所有维度
(国家、货币、方式、状态、链、商户)的明细、您在服务上的支出以及
按美元估值的余额。
请求
您只能看到自己账户的数据。所有金额均为美元十进制字符串;
没有活动的时间桶会以零填充,因此可以直接绘图。
全局区块(头部 KPI 与三大主图表)
gross_volume:所有流入(收款、加密货币充值、收到的转账)与 流出(付款、提现、发出的转账、卡片消费)的美元价值。退款会与其 所属服务对冲净额计算——绝不会虚增交易量。兑换(swap)属于内部 转换,有其独立板块。transactions:操作笔数(不含费用与退款)。new_users:您的企业注册的第三方银行用户(个人账户的序列 为零)。change_pct:与紧邻的、等长的上一周期相比的变化率——用于 ▲▼ 涨跌标识(上一周期为 0 时为null)。BTC/GOLD按当前参考价格估值;若价格不可用,该资产会列在unpriced_assets中,其金额不计入美元总额(我们绝不虚构价格)。
by_country — 按国家的全局视图
付款与收款合并,按交易量排序——用于地图或按国家的柱状图:
sections — 每一项服务的明细
每个板块都包含总计、按时间桶的序列及其自有维度:
payouts — 法币付款
payouts — 法币付款
by_status 提供成功率;by_country 包含按货币划分的当地货币交易量;
by_method 按 pix、bank_transfer、yape 等方式拆分。失败的付款不计入
交易量(其款项已退回)。payins — 法币收款
payins — 法币收款
deposits / withdrawals — 链上加密货币
deposits / withdrawals — 链上加密货币
transfers、swaps 与 cards
transfers、swaps 与 cards
banking、verifications(KYC/KYB)、aml 与 contacts
banking、verifications(KYC/KYB)、aml 与 contacts
deposits 板块还包含 wallet_fees_usd(加密货币产品的钱包创建
费用),而在 balances.items 中,银行镜像余额带有
custody: "banking"(权威余额存放在银行)。new_third_parties 与”新增用户”图表是同一指标:您的企业注册的
银行用户。banking.volume 是经由您的银行账户流动的资金(流入与流出,按
美元估值):它同样计入账户的全局 gross_volume,其明细与
对账单中的 BANK_USD/BANK_EUR 板块相互
勾稽。spending — 您在服务上的消费
您在该期间支付的每一笔显性费用,以及每项服务的计费次数:
balances — 您的估值余额
余额变动趋势 — GET /v1/balances/history
用于带图表的余额卡片(“近 30 天余额”及其 ▲▼):
每种资产的每日序列,包含每天的收盘余额,外加聚合的美元序列
及该期间的流入/流出。
- 每个数据点是当日收盘时的可用余额(UTC);没有变动的日子会 沿用前一天的余额,因此序列没有缺口,可直接绘图。
assets还包含银行账户镜像(BANK_USD、BANK_EUR),以其自身 货币(2 位小数)作为独立序列提供——适合在图表上做”Bank USD”/ “Bank EUR”筛选项。它们不计入total_usd聚合,该聚合仅覆盖 运营余额。total_usd按每一天的历史价格为 BTC/GOLD 估值。若某天尚无 历史价格,则使用今日现货价格,并在spot_priced_dates中披露 该日期(绝不虚构数值)。period.in_usd/out_usd是该范围内的总流入与总流出(与gross_volume的分类一致)——即卡片上的”↗ 254.8K”。current是今日快照,同时包含available和held(历史序列只记录可用余额:冻结金额没有历史记录)。
您的汇率变动 — GET /v1/rates/history
您账户的外汇汇率时间序列(与 GET /v1/rates 相同的汇率,已应用
您的配置),用于带”+3.4% / −3.0%“标识的汇率走势图:
rate是付款侧,payin_rate是入金侧——与当前快照相同的两种 汇率,逐点对应。change_pct带符号返回("3.43"表示上涨,"-3.00"表示下跌): 可直接用它为标识着色(绿色/红色)。- 没有数据的时间桶会沿用最后一个已知值;历史记录开始之前的日子 则直接缺席。
错误
常见问题
时间桶使用哪个时区?
时间桶使用哪个时区?
UTC,与整个 API 中的
from/to 过滤器一致。若您的前端展示其他
时区,请在渲染时转换标签。哪些计入交易量,哪些不计入?
哪些计入交易量,哪些不计入?
所有向您账户流入/流出资金的操作:收款、加密货币充值和收到的转账
(流入);付款、提现、发出的转账和卡片消费(流出)。退款会对冲
净额计算,费用在
spending 中单独报告,兑换(您自己余额之间的
转换)有其独立板块。BTC 和 GOLD 如何估值?
BTC 和 GOLD 如何估值?
按查询时生效的参考价格(与
GET /v1/rates 相同)。这是一种展示
用途的估值:若价格不可用,该资产会出现在 unpriced_assets 中,
且不计入美元总额。总额与账户对账单一致吗?
总额与账户对账单一致吗?
一致:两者来自同一账本。对账单(
GET /v1/reports/statement)是
逐行的会计文件;分析端点则是用于绘图的聚合视图。数据的时效性如何?
数据的时效性如何?
实时:每一笔已入账的操作都会出现在下一次调用中。
汇率历史从何时开始可用?
汇率历史从何时开始可用?
汇率历史持续记录(每次汇率变化时),并包含约 90 天每日汇率的初始
回填。若您请求的范围早于历史记录开始的时间,这些日子在序列中直接
缺席——绝不虚构数值。
余额历史包含冻结金额吗?
余额历史包含冻结金额吗?
不包含:序列记录的是每天收盘时的可用余额。冻结金额(在途付款、
卡片预授权冻结)没有历史记录;今日的
held 在 current 区块中
返回。为什么我的汇率变化会和市场不同?
为什么我的汇率变化会和市场不同?
不会不同:您的汇率由市场汇率经您的商务配置推导而来,该配置是一个
常数因子——百分比变化是相同的。图表所示正是您在每一天实际操作时
本会得到的汇率。