BlockReq
在 GitHub 编辑

BlockReq API

BlockReq 在 Web（https://blockreq.com/api/...）提供 REST API，用于管理账户、RPC 端点、Request Count、用量、钱包、API Key、通知与设置。管理请求不要发到 *-rpc.blockreq.com。

快速开始

  1. 前往 Dashboard → Settings 创建 API Key
  2. 在请求头 Authorization 中使用 Bearer Token
  3. 在公开 OpenAPI 文档中查看全部可用接口

交互式 API 文档 — 查看 BlockReq REST API 的确定性公开 OpenAPI 文档

Dashboard 设置页 — 创建并管理 API Key

鉴权方式

使用 Dashboard → Settings 的 Management API Key（akv1_...）。它与已登录 Dashboard 会话是同一所有者。{chain}-rpc.blockreq.com/v1/rpc/... 路径里的 RPC Endpoint Key 只用于 JSON-RPC。

curl -H "Authorization: Bearer akv1_YOUR_MANAGEMENT_API_KEY" \
  https://blockreq.com/api/dashboard/credits

主要资源

资源说明
Endpoints列出、创建、删除
网络可用链
用量Stats / analytics / overview
Request Count 与钱包余额与 Request Pack
Billing查看付款历史与支付方式
Teams管理团队成员与邀请
API Keys创建与吊销 API Key
Plans查看 effective plan 并切换自助计费模式

完整公开接口列表和请求/响应结构见 交互式 API 文档。创建或轮换 API Key 请前往 Dashboard Settings。

错误

/api/dashboard/* 的所有错误都用同一个 JSON 结构返回，HTTP 状态为 4xx 或 5xx：

{ "ok": false, "error": "team_not_found", "code": 100010 }
字段含义
ok出错时恒为 false。成功响应是 { "ok": true, "data": ... }。
errorsnake_case 业务错误码，如 team_not_found、rate_limited。请按这个值分支处理。
code数字类别：100000 服务端错误、100001 未认证、100003 无权限、100004 请求错误（限流也用它）、100010 不存在、100011 冲突。
data可选的附加明细，例如校验问题。

/api/auth/* 下的登录接口使用 Better Auth 自己的错误结构，不是上面这种。维护期间所有 API 返回 HTTP 503，正文为 { "error": { "code": "MAINTENANCE_MODE", "message": "..." } }，请稍后重试。

弃用说明

以下字段在 2027-01-01 移除，此前仍可使用，请在此之前改用替代字段。

弃用替代
GET /api/dashboard/chains：chains[].gateway.publicRpcUrl 与 chains[].gateway.publicWssUrlchains[].publicRpcUrl 与 chains[].publicWssUrl（取值相同）
POST /api/dashboard/alert-rules：type: "ru_usage"type: "usage_percent"（用别名创建的规则已按 usage_percent 存储）