Tron 能量租賃 WEB API

Overview

API 採用 RESTful 風格並返回 JSON。所有請求都需要附帶 API Key，並透過 HTTP 發送至服務器的固定地址。

Base URL

https://trxforenergy.com/test/api

測試TG BOT: trx_for_energy_test_bot

返回格式

成功時返回 JSON；錯誤時返回字串 ERROR: 錯誤原因。

授權方式

在 Header 內傳入 x-api-key，值為平台分配的 API Key。

Authentication

所有 WEB API 均需於 Header 帶上 x-api-key。若未提供或 Key 錯誤，接口將以錯誤字串形式返回。

Header	Example	Description
`x-api-key`	`992bab0cb23ff46064d...`	平台分發的專屬 API Key，串接時務必保密。

curl --request GET \
  --url https://trxforenergy.com/test/api/myInfo \
  --header 'x-api-key: <YOUR_API_KEY>'

WEB 接口

以下接口對應 README 中的既有功能：查詢帳戶資訊、查詢價格、提交訂單、查詢訂單狀態。

GET /myInfo

用途｜查詢帳戶餘額、API Key 與資源地址

查詢當前 API Key 對應帳戶的餘額、地址與基本信息。

Header	必填	說明
`x-api-key`	是	平台提供的 API Key。

{
  "id": 1,
  "chatId": null,
  "name": "測試用戶001",
  "userType": 1,
  "balance": 0,
  "avaliableBalance": 0,
  "addressForDeposit": "T9z6yrJXuiJpfWhis3Ae9nHK7k65yM5AHP",
  "apiKey": "992bab0cb23ff46064d666ef16774df882312e68f1fcfcfcdd16abf3173aa4a9",
  "noticeUrl": "",
  "createdAt": "2025-10-08T14:08:08",
  "updatedAt": "2025-10-08T14:08:08"
}

錯誤時返回：ERROR: 錯誤原因

GET /getPrice

用途｜取得最新能量與帶寬租賃單價

查詢能量與帶寬的租賃單價，單位為 SUN（1 TRX = 1,000,000 SUN）。

Header	必填	說明
`x-api-key`	是	平台提供的 API Key。

{
  "ENERGY": 2000000,
  "BANDWIDTH": 2000000
}

錯誤時返回：ERROR: 錯誤原因

POST /orders/times

用途｜依轉帳次數建立能量或帶寬租賃訂單

根據轉帳次數提交能量或帶寬租賃訂單。採用 form-data 形式提交。

參數	位置	型別	必填	說明
`x-api-key`	Header	string	是	平台提供的 API Key。
`resourceType`	Form	int	是	資源類型，`1`=ENERGY，`0`=BANDWIDTH。
`times`	Form	int	是	需要的轉帳次數。
`receiverAddress`	Form	string	是	資源接收的 Tron 地址。

curl --request POST \
  --url https://trxforenergy.com/test/api/orders/times \
  --header 'x-api-key: <YOUR_API_KEY>' \
  --form resourceType=1 \
  --form times=1 \
  --form receiverAddress=TJqiMSSmRtm4LvXrYBWysz9DnNrFQDaBv9

{
  "id": 11,
  "orderTime": 3600,
  "orderType": 0,
  "receiverAddress": "TJqiMSSmRtm4LvXrYBWysz9DnNrFQDaBv9",
  "resourceType": 1,
  "source": "WEB",
  "status": 0,
  "timeStamp": 1759505787190,
  "times": 1
}

錯誤時返回：ERROR: 錯誤原因

GET /orders/{id}

用途｜追蹤單筆租賃訂單狀態與結果

查詢指定訂單的狀態與租賃詳情。

項目	位置	型別	必填	說明
`x-api-key`	Header	string	是	平台提供的 API Key。
`id`	Path	int	是	訂單 ID（來源於下單回傳）。

{
  "id": 5,
  "orderTime": 3600,
  "orderType": 0,
  "receiverAddress": "TJqiMSSmRtm4LvXrYBWysz9DnNrFQDaBv9",
  "resourceType": 1,
  "source": "WEB",
  "status": -1,
  "timeStamp": 1759463663134,
  "times": 1
}

錯誤時返回：ERROR: 錯誤原因

系統通知推送

在控制台配置通知回調地址後，系統會於訂單與充值狀態變更時，以 HTTP POST (JSON body) 對回調 URL 發送通知。若推送失敗會重試最多 3 次。

type	觸發事件	內容重點
`order`	訂單狀態更新（建立、委託成功、超時失敗等）。	包含訂單編號、資源類型、狀態碼、租賃秒數與次數。
`deposit`	帳戶地址收到 TRX 存款。	包含充值地址、來源地址、金額（sun）、交易哈希與時間。

{
  "type": "order",
  "id": 5,
  "orderTime": 3600,
  "orderType": 0,
  "receiverAddress": "TJqiMSSmRtm4LvXrYBWysz9DnNrFQDaBv9",
  "resourceType": 1,
  "source": "WEB",
  "status": -1,
  "timeStamp": 1759463663134,
  "times": 1
}

{
  "type": "deposit",
  "id": 5,
  "address": "T9z6yrJXuiJpfWhis3Ae9nHK7k65yM5AHP",
  "fromAddress": "TE9eC5EiHx9zD5bWfzyPhtQ94s7QMqv2CQ",
  "amount": 1000000000,
  "txHash": "9e1babdab1fc7c92ee3a254474763a43c75cf37350d1cd22c18a451183ede4be",
  "createdAt": "2025-10-08 16:49:17"
}

Error Handling

接口在發生錯誤時會回傳字串 ERROR: 錯誤原因，同時 HTTP 狀態碼通常仍為 200。建議在客戶端解析字串判斷是否含有 ERROR 前綴。

示例	可能原因	處理建議
`ERROR: unauthorized`	缺少或使用了錯誤的 `x-api-key`。	確認 Header 是否帶入正確的 API Key。
`ERROR: validation failed`	提交的參數缺失或格式不正確。	比對參數表或 README 說明後重新提交。
`ERROR: order not found`	查詢的訂單 ID 不存在或已過期。	確認 ID 是否正確並確保訂單尚在有效期。