Skip to content

Transaction History

This method retrieves the transaction history of the account.

shell
GET: {{endpoint}}/v1/transaction/list

Headers

KeyTypeValueDescription
x-api-keystringkey_xxxxxxxxxxxxxxxxxxxxAPI Key string
x-signaturestringSHA256The HMAC SHA256 signature.
x-timestampstring1730998051892Timestamp of the request

Request Body

KeyTypeDescription
skipnumber(Optional) skip the first, default is 0
takenumber(Optional) take the first, default is 25
orderBystring(Optional) order by asc or desc, default is desc
Example Request
JSON
// Params: query
{
  "skip": 0,
  "take": 25,
  "orderBy": "desc"
}

Response Parameters

The final response in the stream also includes additional data about the generation:

  • items (Array)
    • id (String): the transaction id
    • seq_num (Number): the sequence number of the transaction
    • tx_type (String): the type of the transaction
    • from_wallet_id (String): the id of the wallet that sent the transaction
    • to_wallet_id (String): the id of the wallet that received the transaction
    • unique_hash (String): a unique hash for the transaction
    • asset (String): the asset of the transaction
    • symbol (String): the symbol of the transaction
    • coin_type (String): the coin type of the transaction
    • chain (String): the chain of the transaction
    • testnet (Boolean): whether the transaction is on the testnet
    • tx_id (String): the transaction id
    • from_address (String): the address that sent the transaction
    • to_address (String): the address that received the transaction
    • amount (Number): the amount of the transaction
    • fee (Number): the fee of the transaction
    • realized_amount (Number): the realized amount of the transaction
    • fx_rate (Object): the fx rate of the transaction
    • tx_value (Number): the transaction value
    • block_number (Number): the block number of the transaction
    • latest_block_number (Number): the latest block number of the transaction
    • block_confirmation (Number): the block confirmation of the transaction
    • finalized_confirmed (Number): the finalized confirmed of the transaction
    • is_completed_confirmed (Boolean): whether the transaction is completed confirmed
    • is_spent (Boolean): whether the transaction is spent
    • status (String): the status of the transaction
    • created_at (String): the created at date of the transaction
    • webhook_id (String): the webhook id of the transaction
    • sweep_id (String): the sweep id of the transaction
    • owned_by_group (String): the owned by group of the transaction
    • agent_id (String): the agent id of the transaction
    • pending_transaction_id (String): the pending transaction id of the transaction
    • payment_id (String): the payment id of the transaction
  • pagination
    • total (Number): the total number of transactions
Example Response
json
{
  "data": {
    "items": [
      {
        "id": "bd0172ac-d13c-4079-xxxx-445469d9a963",
        "seq_num": 31,
        "tx_type": "RECEIVE_IN",
        "from_wallet_id": null,
        "to_wallet_id": "6c580ece-c6de-4962-xxxx-e59dc69d29c2",
        "unique_hash": "5a80ef0d792f9c69a720690f75c731010623c030c5516d2d593cd3450xxxxxx",
        "asset": "TRON",
        "symbol": "TRX",
        "coin_type": "native",
        "chain": "tron-testnet",
        "testnet": true,
        "tx_id": "89eba408f34e646847ce5b1f0ca9b23543d4c845b0e489286eaeb803cbxxxxxx",
        "from_address": "TEhiFHcccSScVwa4Y2xY7UqjgxUaPxxxxx",
        "to_address": "TTZSCjsnYsRMNVUkkErVAPoQt2dJnxxxxx",
        "amount": 40,
        "fee": 0.4,
        "realized_amount": 39.84,
        "fx_rate": {
          "AED": 23.961,
          "CNY": 46.456,
          "EUR": 6.043,
          ...
        },
        "tx_value": 6,
        "block_number": 48811492,
        "latest_block_number": 48811515,
        "block_confirmation": 6,
        "finalized_confirmed": 23,
        "is_completed_confirmed": true,
        "is_spent": false,
        "status": "COMPLETED",
        "created_at": "2024-10-28T07:21:28.214Z",
        "webhook_id": null,
        "sweep_id": null,
        "owned_by_group": "8e393308-28a9-4a6e-xxxx-0d7760483c7e",
        "agent_id": "aacc3472-f3c3-49bb-xxxx-d5a6aff283bf",
        "pending_transaction_id": null,
        "payment_id": null
      },
      { ... }
    ],
    "pagination": {
      "total": 10
    }
  }
}
json
{
  "error": "Error message"
}
json
{
  "error": "Forbidden"
}