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)

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.

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. 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"
            ],
            "trx_price": 0.2979386
        }
    ],
    "pagination": {
        "limit": 20,
        "offset": 0,
        "total": 66
    }
}