对外接口文档

所有接口基于 HTTPS,返回 JSON。推荐使用 API Key 认证,请勿携带 JWT。登录后在左侧菜单「API」中查看、复制和重置密钥。

🔐 认证方式:API Key

所有对外接口仅支持 API Key 认证。推荐在 Header 中使用 X-API-Key: YOUR_API_KEY,若需兼容也可放在 apiKey 字段或查询参数。若同时传递 Header 与参数,将以 Header 为准。

⚡ 地址自动激活

对接方无需先给目标地址转账开户。下单时若 receiveAddress 尚未在波场激活,系统会先自动激活,再向其委托能量。

激活成功后该笔订单额外收取 1.1 TRX,已计入询价的 estimatedCost 与订单金额。响应里 activation_fee_paid 为 true 表示本单触发了激活。

询价接口可传 receiveAddress,返回 needActivation、activationFee,便于下单前展示费用。

GET/api/external/balance

返回关联账户的余额,单位 TRX,保留六位小数。

认证: 仅支持 API Key(推荐 Header)

curl -H "X-API-Key: YOUR_API_KEY" https://021.st/api/external/balance
{
  "balance": "105.230000"
}

GET/api/external/deposit-address

返回用户专属充值地址,若尚未生成会返回 404。

认证: 仅支持 API Key

curl -H "X-API-Key: YOUR_API_KEY" https://021.st/api/external/deposit-address
{
  "depositAddress": "TWoejh9VaC7RxUCHbReXGc9DHCQLYsJehi"
}

GET/api/external/orders

获取用户订单列表,按创建时间倒序排列,支持分页。

参数 类型 必填 默认值 说明
pageinteger否1页码,从 1 开始
limitinteger否20每页数量,范围 1-100
clientRefstring否-按你方业务单号精确查单
curl -H "X-API-Key: YOUR_API_KEY" "https://021.st/api/external/orders?page=1&limit=10"
{
  "orders": [
    {
      "receiveAddress": "TRX_ADDRESS",
      "payNums": "65000",
      "orderMoney": "5.140000",
      "orderNotes": "用户备注",
      "createdAt": "2025-04-26 10:12:45",
      "activationFeePaid": true,
      "remark": "该笔订单触发了地址激活(含1.1TRX激活费)",
      "state": "成功",
      "clientRef": "你方业务单号"
    }
  ],
  "pagination": { "page": 1, "limit": 10, "total": 87, "totalPages": 9 }
}

POST/api/orders/estimate

根据能量数量计算预估租用费用(TRX)。可选传入 receiveAddress,以便判断目标地址是否需要激活并计入 1.1 TRX 激活费。

认证: 需要 API Key(在 body 中)

{
  "apiKey": "YOUR_API_KEY",
  "payNums": 65000,
  "rentTime": 1,
  "receiveAddress": "TRX_ADDRESS"
}
{
  "estimatedCost": "4.040000",
  "needActivation": true,
  "activationFee": "1.100000"
}

POST/api/orders/rent

根据提供的参数创建能量租用订单。若目标地址未激活,系统会自动激活后再委托能量(加收 1.1 TRX)。

{
  "apiKey": "YOUR_API_KEY",
  "payNums": 65000,
  "rentTime": 1,
  "receiveAddress": "TRX_ADDRESS",
  "orderNotes": "订单备注 (可选)",
  "clientRef": "可选, 你方业务单号 (≤64字符)"
}
{
  "orderId": "ORDER_ID",
  "localOrderId": 123,
  "message": "订单创建成功",
  "activation_fee_paid": true
}

GET/api/orders

获取与该 API Key 关联用户的订单历史记录,支持分页。

参数 类型 必填 说明
apiKeystring是您的 API Key
pageint否默认为 1
limitint否默认为 8

PUT/api/external/callback-config

配置订单最终状态(成功/失败)的回调地址与验签密钥。配置后,订单终态确定时我们会主动推送通知,无需你轮询。callbackUrl 传空表示关闭回调。

{
  "callbackUrl": "https://your-domain.com/tron/callback",
  "callbackSecret": "用于校验回调签名(HMAC-SHA256)"
}

POST→ 你配置的 callbackUrl

订单最终状态确定时,由我方主动向你配置的回调地址发起 POST 推送。

请求头 说明
X-Signature对请求体做 HMAC-SHA256(密钥=callbackSecret)的 hex 值
X-Event-Id事件唯一标识,用于幂等去重
X-Event-Typeorder.success / order.failed
{
  "event": "order.success",
  "eventId": "123:order.success",
  "orderRef": "123",
  "clientRef": "你方业务单号",
  "status": "success",
  "receiveAddress": "TRX_ADDRESS",
  "energy": "65000",
  "rentTime": 1,
  "money": "2.940000",
  "timestamp": "2026-07-13 16:05:00"
}
处理要求:
1. 验签:用 callbackSecret 对原始请求体计算 HMAC-SHA256,与 X-Signature 比对一致才处理。
2. 幂等:用 eventId 去重,同一事件可能重复推送。
3. 响应:处理成功请返回 HTTP 2xx。非 2xx 我方会按 30s/2m/10m/30m/2h/6h 退避重试,最多 6 次。
4. 回调地址须为公网可访问的 http/https,禁止内网/环回地址。