开发者文档

API 工作区
https://api.rentron.xyz/v1
OpenAPI 架构

订单列表

// GET

生产 API

列出订单

使用不透明游标分页,按从新到旧的顺序读取订单。

GET /v1/energy/orders?limit=20&cursor=...
本页内容

该接口只返回与 API 凭证关联账户的订单。

查询参数

参数 类型 默认值 说明
limit integer 20 页大小,范围为 1 到 100。
cursor string 来自上一页 next_cursor 的不透明值。

签名包含开头的 ? 在内的完整查询字符串。签名后不要重新排序或重新编码。

响应 200

{"items":[{"id":"7c0c9a54-517c-4bbb-a946-bf14bf86c113","client_request_id":"order-1042","address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","energy":65000,"duration_minutes":60,"total_trx":"3.200000","status":"created","lifecycle_final":false,"delivery_final":false,"created_at":1784376000,"updated_at":1784376000,"energy_usable":false}],"next_cursor":"opaque-value"}

items 按最新优先排序。最后一页不会把 next_cursor 设为 null,而是整个字段都不返回,因此请在字段缺失时停止翻页:判断它是否等于 null 永远看不到列表的结尾。条目内部的字段也是如此:上面这笔订单还没有对应的值,所以既没有 rental_expires_at,也没有 failure

每个条目都包含完整的订单结构,其中有 statuscreatedexecutingavailabledeliveredrental_finishedfailedrental_interrupted)、energy_usablerental_expires_at。要判断哪些地址现在就能使用 Energy,请按 energy_usable 筛选,而不是按 status == "delivered":处于 available 的订单已经可用,付费时长也已经在计时;而时长已经结束的订单,即使状态仍显示 delivered,也不能再使用。详见查询订单

游标规则

  • 原样传回游标。
  • 不要自行解码或构造游标。
  • 游标绑定到其所属账户和资源。
  • 游标在签发 24 小时后失效。不要保存游标留到第二天继续,请不带游标重新开始。
  • 无效、被修改、已过期或属于其他账户的游标会以 pagination_cursor_invalid 返回 400