Skip to content
GET/open/v1/dashboard

账户概览 ​

查询当前租户在当前网络的钱包余额汇总、累计到账和未完成任务。

GET /open/v1/dashboard

需要当前租户的 Bearer accessToken,并对每次请求签名。先获取 accessToken,再按签名规则调用。只返回当前账户的数据,请求不传 network 或 tenant_id。

请求头 ​

字段类型必填说明示例值
X-App-Idstring是平台分配的 appID,规范正 int64 十进制字符串,只能传一次。123456789012345001
X-Timestampstring是当前 Unix 秒级时间戳,服务器时间前后 300 秒内,只能传一次。1893456000
X-Signstring是按请求签名生成的 64 位小写 HMAC-SHA256;包含本次 accessToken、规范查询串和原始请求体。按本次请求计算
Authorizationstring是Bearer 后跟当前有效的 accessToken;只能传一次。Bearer AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

不接受 Idempotency-Key。示例中的凭据、时间戳、地址、ID 均为虚构示例,不能直接调用;实际请求必须重新生成时间戳及签名。

请求参数 ​

无路径参数、不接受 network 查询参数,无请求体。GET 的 body 必须为空;多余查询参数不会产生额外统计维度。

wallet_count、余额和任务统计限定当前租户与网络;engine 是服务运行状态,不代表某笔交易结果。pending_tasks为尚未结束的USDT归集任务数量。

成功响应 ​

HTTP 200,Content-Type: application/json。

json
{
  "code": 0,
  "message": "",
  "data": {
    "network": "nile",
    "wallet_count": 1,
    "unsynced_wallet_count": 0,
    "balance_usdt": "100000000",
    "balance_trx": "30000000",
    "collected_usdt": "0",
    "deposit_usdt": "100000000",
    "pending_tasks": 0,
    "engine": [
      {
        "component": "chain-scanner",
        "status": "running",
        "detail": "",
        "updated_at": "2030-01-01T00:00:00Z"
      }
    ]
  }
}
字段类型必填说明示例值
codeinteger是业务成功。0
messagestring是成功时为空字符串。""
dataobject是账户统计和组件状态。见 JSON 示例
data.networkstring是资产所属网络:main(主网)或 nile(测试网络)。"nile"
data.wallet_countinteger是当前租户、当前网络的钱包数。1
data.unsynced_wallet_countinteger是balance_block 为 0、尚未完成首次同步的钱包数。0
data.balance_usdtstring是当前租户、网络的钱包 USDT 余额合计;最小单位的整数字符串,六位精度,禁止用浮点数处理。"100000000"
data.balance_trxstring是当前租户、网络的钱包 TRX 余额合计,SUN;最小单位的整数字符串,六位精度,禁止用浮点数处理。"30000000"
data.collected_usdtstring是累计成功归集 USDT 金额;最小单位的整数字符串,六位精度,禁止用浮点数处理。"0"
data.deposit_usdtstring是已确认到账 USDT 金额累计;最小单位的整数字符串,六位精度,禁止用浮点数处理。"100000000"
data.pending_tasksinteger是当前租户、网络的未结束任务数,含归集。0
data.engineobject[]是服务运行状态,仅用于辅助排查同步异常;不代表某笔任务成功,无状态信息时为 []。[]
data.engine[].componentstring是服务状态项名称。"chain-scanner"
data.engine[].statusstring是服务状态文本,不是固定枚举。"running"
data.engine[].detailstring是服务状态说明。""
data.engine[].updated_atstring是状态最近更新时间。"2030-01-01T00:00:00Z"

失败响应 ​

错误时 HTTP 状态码与 code 一致,JSON 只含 code、message,不含 data。

HTTP情况message 示例
400参数或请求格式错误invalid request
401签名、时间窗口或令牌无效authentication required or expired
403租户停用、删除或过期tenant disabled or expired
413请求体超过大小限制request body exceeds configured limit
429请求频率超限;读取 Retry-After 秒数too many requests
500内部依赖或业务执行失败internal operation failed
503HTTP 并发槽已满;Retry-After 为 1 秒too many in-flight requests
504操作超过请求截止时间request timed out
json
{
  "code": 400,
  "message": "invalid request",
  "error_code": "INVALID_ARGUMENT",
  "trace_id": "0123456789abcdef0123456789abcdef"
}

完整字段格式、路由错误与重试约定见通用约定。

完整字段与状态 ​

查看全部响应字段、嵌套对象及枚举 · 业务状态与处理 · 错误码排查。