TRX能量接口API文档 Ver 3.6.1
API接口下单有什么好处?
1. 使用API下单,不用每笔都进行转账。在量大的时候可以大量减少TRX燃烧损耗。
2. 无需经过区块链转账,时间更快,可以毫秒级租赁Trx能量。
3. 更灵活,可以指定地址、时长、Trx能量多少等进行派发Trx能量。
怎么创建API帐户?
首先,您需要一个API帐户才可以进行API下单,开通API账户请联系TG客服(需要科学上网)。
开通API账户后,客服会给您一个用户名及密钥,密钥用于API请求时进行签名验证。
接口约定
请求内容类型为:application/json,下文中的secretKey指用户密钥。
输出格式:{"code":1,"msg":"操作成功","data":返回内容 },code 为1时正常,不为1时会有对应的错误信息。例如:{"code":0,"msg":"签名错误!"}。
查询接口
您可以通过该接口查询您的余额信息,及可用的Trx能量价格列表。
API地址:/api/Public/QueryInfo
| 参数名 | 类型 | 描述 |
|---|---|---|
| code | 字符串 | 用户名 |
| token | 字符串 | 随机时间戳 |
| sign | 字符串 | 签名方式:md5(user + token + secretKey) |
输出Data:{"Balance":19.990000,"packages":[{"Duration":1,"EnergyTrx":3.000000,"EnergyNum":32000}]}
| 参数名 | 类型 | 描述 |
|---|---|---|
| Balance | 小数 | 用户余额 |
| packages | 实体列表 | Trx能量价格信息 |
packages参数实体如下:
| 参数名 | 类型 | 描述 |
|---|---|---|
| Duration | 整数 | 时长,单位:小时 |
| EnergyTrx | 小数 | Trx能量租赁价格(Trx) |
| EnergyNum | 整数 | Trx能量数量 |
下单接口
通过该接口,您可以下单指定Trx能量租赁自由派发。
API地址:/api/Public/SubmitOrder
| 参数名 | 类型 | 描述 |
|---|---|---|
| code | 字符串 | 用户名 |
| duration | 整数 | TRX能量租赁时长,单位:小时 |
| address | 字符串 | TRX能量接收地址 |
| energyNum | 整数 | TRX租赁能量大小(当该值小于100时,系统视为笔数) |
| token | 字符串 | 随机时间戳 |
| sign | 字符串 | 签名方式:md5(duration + address + energyNum + token + secretKey) |
输出Data:{"orderId":"4980688112342321122","TrxBalance":16.990000}
| 参数名 | 类型 | 描述 |
|---|---|---|
| orderId | 字符串 | 订单号,可用于订单状态查询 |
| TrxBalance | 小数 | 预计TRX余额,非实时,能量质押后才扣除。 |
订单查询
用来查询已经下单的订单状态,此API接口只用于查询,可以不对接。
API地址:/api/Public/QueryOrder
| 参数名 | 类型 | 描述 |
|---|---|---|
| code | 字符串 | 用户名 |
| orderId | 字符串 | 订单号 |
| token | 字符串 | 随机时间戳 |
| sign | 字符串 | 签名方式:md5(orderId + token + secretKey}) |
返回实体如下:
| 参数名 | 类型 | 描述 |
|---|---|---|
| Id | 字符串 | 订单号,可用于订单状态查询 |
| Address | 字符串 | 能量接收地址。 |
| Duration | 整数 | TRX能量租赁时长。 |
| Trx | 小数 | TRX能量租赁价格。 |
| State | 整数 | 值说明:1:待处理;2:处理中;3:处理失败;4:质押完成;5:解押完成;6:订单撤销; |
| StateTime | 时间 | 状态发生变化的时间。 |
| Remark | 字符串 | 提示消息。 |
| CreateTime | 时间 | 订单建立时间。 |