Skip to main content

GET Orders

/api/v1/orders

Parameters/Query:

/api/v1/orders?limit=20&offset=0&from_date=2025-01-01T00:00:00Z&to_date=2025-03-01T00:00:00Z
  1. limit: maximum number of records per page (default: 20)
  2. offset: pagination offset (default: 0)
  3. from_date: start date filter in ISO 8601 format (e.g. 2025-01-01T00:00:00Z)
  4. to_date: end date filter in ISO 8601 format (e.g. 2025-03-01T00:00:00Z)
  5. search: a transaction hash (64-char hex) previously submitted by the caller — returns the single order that transaction belongs to, instead of a date-range page. See Searching by transaction hash below.

This call returns a paginated list of orders (resource charges) within the specified date range.

tip

This endpoint requires the ADMIN (spender) API key.

warning

The maximum allowed search period is 3 months. Requests with a wider date range will be rejected. This limit does not apply when search is used — see below, from_date/to_date/limit/offset are ignored on that branch.

Response contains the following data:

  1. orders: array of order objects, each containing:
    1. order_id: unique order identifier (UUID)

    2. order_date: timestamp when the order was created (ISO 8601)

    3. amount_trx: total amount charged (in sun)

    4. cashback_amount_trx: cashback amount (in sun)

    5. charge_token: currency charged (RTRX or RUSDT)

    6. details: human-readable order description (e.g. resource breakdown)

    7. target_address: TRON address the order was delivered to

    8. transactions: array of User transaction hashes processed within this order

    9. resources: array of the confirmed on-chain resource-delivery transactions Transatron broadcast to fulfil this order, each containing:

      1. type: resource type delivered — ACTIVATE, ENERGY, BANDWIDTH, or TRX
      2. tx_id: a 64-char hex TRON transaction hash when the delivery has a standard on-chain hash; otherwise the resource operation's own internal UUID. Some confirmed deliveries — e.g. energy served from existing stake, or free bandwidth — carry no separate on-chain hash and are still reported this way, so the field is never empty for a confirmed delivery. The two forms are trivially distinguishable: hashes never contain hyphens, UUIDs always do.

      Only confirmed deliveries are included — reclaim operations and unconfirmed attempts never appear. resources is always present on every order and may be an empty array ([]).

    10. trx_price: TRX/USDT price at the time of the order

  2. pagination: pagination metadata object containing:
    1. limit: page size used
    2. offset: current offset in the result set
    3. total: total number of orders matching the query

Example of response:

{
"orders": [
{
"amount_trx": 677350,
"cashback_amount_trx": 0,
"charge_token": "RTRX",
"details": "Charge for: 64285 Energy, 345 Bandwidth.",
"order_date": "2026-01-08T14:03:59Z",
"order_id": "4d50c208-741d-41dd-bc86-f28a08f83f12",
"target_address": "TYQxFB5F67xs1MQbeGcKCPgjTMHpKZxFbf",
"transactions": [
"6399cdf660486b5750de8ca94a4c318bb180c92e859a3c1ff42298afdfbd9432",
"2bbac13577d687e1ddc26ed2ef33a18107a7d5f0e7dc8f8f4f7fd218df3d9109",
"b4cbb64839a09bd41f3f9723397dff2b145eeedbe72d6b87feceb054ebb84ecf",
"907c5931a6b6f848ec71b85df9235e3f3076595d16995c30f21ed8348ce4ca50"
],
"resources": [
{"type": "ENERGY", "tx_id": "a6c1a1353ea8be97f9e1d2b575f14f5990e499609dba4f8b89600837cc3eaec1"},
{"type": "BANDWIDTH", "tx_id": "2cae500f96057e871d35793232fe5c189dfddc40622529a14ae1f113138a33f3"}
],
"trx_price": 0.2979386
},
{
"amount_trx": 12500,
"cashback_amount_trx": 0,
"charge_token": "RUSDT",
"details": "Charge for: 1500 Energy.",
"order_date": "2026-01-09T09:12:31Z",
"order_id": "5eb496d0-3a38-4956-a149-8a23a68c9822",
"target_address": "TYQxFB5F67xs1MQbeGcKCPgjTMHpKZxFbf",
"transactions": [
"0c3a1a9c4d7e6f5b8a2d1c0e9f8b7a6d5c4b3a2918f7e6d5c4b3a2918f7e6d5c"
],
"resources": [
{"type": "ENERGY", "tx_id": "841e900c-ef52-4405-928f-ab0f73aae2eb"},
{"type": "TRX", "tx_id": "abb6ecb1ff323202e9c14c9aa970831a1e6cd611942a08cdab14aeb552d2a5c8"}
],
"trx_price": 0.2979386
}
],
"pagination": {
"limit": 20,
"offset": 0,
"total": 66
}
}
tip

The second order above illustrates the tx_id fallback: its ENERGY delivery was served from existing stake and has no separate on-chain hash, so tx_id is the resource operation's own UUID instead of a 64-char hash.

Searching by transaction hash

Pass search=<tx_hash> to look up the single order a specific transaction belongs to, instead of listing orders by date range. This is useful because one order can bundle hundreds of submitted transactions, making it impractical to find which order a given hash belongs to by browsing date-range pages.

/api/v1/orders?search=6399cdf660486b5750de8ca94a4c318bb180c92e859a3c1ff42298afdfbd9432
  • search is matched only against your own orders — it can never return another customer's order.
  • When search is present, from_date, to_date, limit, and offset are ignored.
  • The response uses the same {orders, pagination} envelope as a normal listing, with 0 or 1 order returned.
OutcomeHTTP statusResponse
Hash belongs to one of your orders200{"orders": [ <the order> ], "pagination": {"limit": 1, "offset": 0, "total": 1}}
Hash is mined on-chain but isn't part of any of your orders (e.g. it's another customer's)200{"orders": [], "pagination": {"limit": 1, "offset": 0, "total": 0}}
search is not a well-formed 64-char hex hash400
Hash is well-formed but unknown / not yet mined on-chain404
Upstream TRON node error502

Example of response:

{
"orders": [
{
"amount_trx": 677350,
"cashback_amount_trx": 0,
"charge_token": "RTRX",
"details": "Charge for: 64285 Energy, 345 Bandwidth.",
"order_date": "2026-01-08T14:03:59Z",
"order_id": "4d50c208-741d-41dd-bc86-f28a08f83f12",
"target_address": "TYQxFB5F67xs1MQbeGcKCPgjTMHpKZxFbf",
"transactions": [
"6399cdf660486b5750de8ca94a4c318bb180c92e859a3c1ff42298afdfbd9432",
"2bbac13577d687e1ddc26ed2ef33a18107a7d5f0e7dc8f8f4f7fd218df3d9109",
"b4cbb64839a09bd41f3f9723397dff2b145eeedbe72d6b87feceb054ebb84ecf",
"907c5931a6b6f848ec71b85df9235e3f3076595d16995c30f21ed8348ce4ca50"
],
"resources": [
{"type": "ENERGY", "tx_id": "a6c1a1353ea8be97f9e1d2b575f14f5990e499609dba4f8b89600837cc3eaec1"},
{"type": "BANDWIDTH", "tx_id": "2cae500f96057e871d35793232fe5c189dfddc40622529a14ae1f113138a33f3"}
],
"trx_price": 0.2979386
}
],
"pagination": {
"limit": 1,
"offset": 0,
"total": 1
}
}