Explorer API
Explorer 后端 HTTP / WebSocket 接口文档(由 explorer-api crate 实现)。数据来自本地
SQLite 索引,索引内容从链节点(Chain API)同步;删除数据库后可从高度 0 重建。
| 环境 | Base URL |
|---|---|
| 生产(浏览器层) | https://api.auroran.io |
| 本地开发 | http://127.0.0.1:8090(环境变量 EXPLORER_LISTEN) |
Content-Type: 成功响应均为 application/json
CORS: 全开放(*),可直接在浏览器或第三方服务中调用
文档结构
| 文档 | 内容 |
|---|---|
| 概述(本页) | 公共约定摘要、接口速查 |
| REST API | 全部 REST 接口、公共约定、数据类型 |
| WebSocket | WebSocket 连接、订阅协议、推送格式 |
公共约定(摘要)
完整说明见 REST API — 公共约定。
响应包装
| 模式 | 结构 | 适用接口 |
|---|---|---|
| 分页列表 | { "data": T[], "page": { "offset", "limit", "total" } } | blocks、events、envelopes、fills、orders |
| 单条资源 | { "data": T } | block、block envelopes、tx |
| 裸数组 | T[] | markets、candles |
| 普通对象 | { ... } | health、status |
错误响应
{ "error": "human-readable message" }
| HTTP 状态码 | 场景 |
|---|---|
400 | POST /info 未知 type |
404 | 区块、交易、市场不存在 |
500 | 存储/查询失败,或缺少必填 query 参数 |
缺少必填 query 参数(如
account、owner、symbol)当前返回500,而非400。
格式约定
- 地址 / 哈希:
0x前缀十六进制 - 价格、数量、手续费:decimal 字符串(非 JSON number)
symbol:由内存中的 market cache 解析,未知时为null
接口速查
| Method | Path | 说明 | 详情 |
|---|---|---|---|
| GET | /health | 存活探针 | rest.md |
| GET | /api/v1/status | 同步状态 | rest.md |
| GET | /api/v1/blocks | 区块列表 | rest.md |
| GET | /api/v1/blocks/{id} | 区块详情 | rest.md |
| GET | /api/v1/blocks/{id}/events | 区块事件 | rest.md |
| GET | /api/v1/blocks/{id}/envelopes | 区块交易 | rest.md |
| GET | /api/v1/envelopes | 全局交易索引 | rest.md |
| GET | /api/v1/tx/{hash} | 按 hash 查交易 | rest.md |
| GET | /api/v1/markets | 市场列表 | rest.md |
| GET | /api/v1/fills | 账户成交历史 | rest.md |
| GET | /api/v1/orders | 账户订单历史 | rest.md |
| GET | /api/v1/candles | K 线(REST) | rest.md |
| POST | /info | K 线(Hyperliquid 兼容) | rest.md |
| GET | /api/v1/ws | WebSocket | websocket.md |
静态前端资源通过 catch-all 提供(EXPLORER_FRONTEND_DIR),不属于公开 API 契约。