🆙 CriptoEnter API
CriptoEnter API — это передовое решение для интеграции платежей к вам на сайт
✈️ Готовы начать интеграцию?
CriptoEnter предоставляет REST API и SDK, которые значительно упростят процесс интеграции. Не беспокойтесь о сложных настройках, мы окажем вам всю необходимую поддержку.
✨ В чем состоит уникальность CriptoEnter?
- Быстро в строй: начните использовать нашу интеграцию уже сегодня.
- Опыт работы с платежами будет полезен, как новичкам для более быстрого освоения, так и экспертам для повышения квалификации.
- С помощью одной строки кода решайте сложные задачи с легкостью.
👑 Ключевые возможности
- 🕵️♂️ Оплата через CБП а так же Ecom.
- 📞 Cтройте аналитику платежей.
- 🖼️ Выплаты а так же валютные платежи.
- 💰 Полный мониторинг по API
Tron Indexer API v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
API for interacting with the Tron blockchain and indexed transaction data
Base URLs:
Authentication
- API Key (ApiKeyAuth)
- Parameter Name: X-API-Key, in: header. API key for authentication. Include your API key in the X-API-Key header.
Info
Node and service info operations
Health check
Code samples
GET /api/v1/trx/health
Returns health status of the TRX indexer service
Example responses
200 Response
{
"status": "ok",
"time": "2025-09-16T12:38:09Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Service is healthy | Inline |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » status | string | false | none | none |
| » time | string | false | none | none |
Get TRX node info
Code samples
GET /api/v1/trx/info
Returns information about the TRX node with sensitive data filtered out
Example responses
200 Response
{
"activeConnectCount": 3,
"beginSyncNum": 75788769,
"block": "Num:75788788,ID:00000000048471f4f94914a0bf4d7c3f6395a6edfa22fdbc9a36eb6f6f9508a0",
"cheatWitnessInfoMap": [],
"configNodeInfo": {
"activeNodeSize": 0,
"allowAdaptiveEnergy": 0,
"allowCreationOfContracts": 0,
"backupListenPort": 10001,
"backupMemberSize": 0,
"backupPriority": 8,
"codeVersion": "4.8.0",
"dbVersion": 2,
"discoverEnable": true,
"listenPort": 18888,
"maxConnectCount": 30,
"maxTimeRatio": 20,
"minParticipationRate": 15,
"minTimeRatio": 0,
"p2pVersion": "11111",
"passiveNodeSize": 0,
"sameIpMaxConnectCount": 2,
"sendNodeSize": 60,
"supportConstant": false,
"versionNum": "18631"
},
"currentConnectCount": 30,
"passiveConnectCount": 27,
"solidityBlock": "Num:75788770,ID:00000000048471e2a979f0d9321b0411b6511e35ff89f27562089faf1f8d422d",
"totalFlow": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Block
Block-related operations
Get last block information
Code samples
GET /api/v1/trx/block/last
Returns the latest block information from the Tron blockchain
Example responses
200 Response
{
"number": 65000000,
"timestamp": 1689321600000,
"transactions": [
{}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 500 | Internal Server Error | Internal server error (TRX node connection failed) | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » number | integer | false | none | Block number |
| » timestamp | integer | false | none | Block timestamp in milliseconds |
| » transactions | [object] | false | none | Transactions in the block |
Status Code 500
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » error | string | false | none | none |
Get block by number
Code samples
GET /api/v1/trx/block/{blockNumber}
Returns the block details for the specified block number
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| blockNumber | path | integer | true | Block number |
Example responses
200 Response
{
"blockID": "00000000048471f4f94914a0bf4d7c3f6395a6edfa22fdbc9a36eb6f6f9508a0",
"block_header": {
"raw_data": {
"number": 75788788,
"txTrieRoot": "11ba221a9771a6c51348250dfdf9568b5d8b30d3fded2f47ecb298d34bbdde2e",
"witness_address": "41d376d829440505ea13c9d1c455317d51b62e4ab6",
"parentHash": "00000000048471f3024c7c868dad0c129a064c92e3cc8bc381a3b48d5ee19ded",
"version": 32,
"timestamp": 1758026295000
},
"witness_signature": "f7b7c0fc2eb83f07434b0febc0c734f6075888298a39ab84392f06dbd235ba0277507a650e6912c0c04f19ee017c3b990fbae185ffb95e7ae501a74fa20e995001"
},
"transactions": [
{
"txID": "0bfab65d6bc6d940e4b4c93f322f32431aebde58bd4560416afe50147af57607",
"ret": [
{
"contractRet": "SUCCESS"
}
],
"raw_data": {
"contract": [
{
"type": "TriggerSmartContract",
"parameter": {
"value": {
"contract_address": "41a614f803b6fd780986a42c78ec9c7f77e6ded13c",
"owner_address": "41c337cc0dff83d9642ddc9086633144a24b11d3cd",
"data": "a9059cbb..."
}
}
}
],
"timestamp": 1758026291950
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Get block by hash
Code samples
GET /api/v1/trx/block/hash/{blockHash}
Returns the block details for the specified block hash
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| blockHash | path | string | true | Block hash |
Example responses
200 Response
{
"blockID": "00000000048471f4f94914a0bf4d7c3f6395a6edfa22fdbc9a36eb6f6f9508a0",
"block_header": {
"raw_data": {
"number": 75788788,
"txTrieRoot": "11ba221a9771a6c51348250dfdf9568b5d8b30d3fded2f47ecb298d34bbdde2e",
"witness_address": "41d376d829440505ea13c9d1c455317d51b62e4ab6",
"parentHash": "00000000048471f3024c7c868dad0c129a064c92e3cc8bc381a3b48d5ee19ded",
"version": 32,
"timestamp": 1758026295000
},
"witness_signature": "f7b7c0fc2eb83f07434b0febc0c734f6075888298a39ab84392f06dbd235ba0277507a650e6912c0c04f19ee017c3b990fbae185ffb95e7ae501a74fa20e995001"
},
"transactions": [
{
"txID": "0bfab65d6bc6d940e4b4c93f322f32431aebde58bd4560416afe50147af57607",
"ret": [
{
"contractRet": "SUCCESS"
}
],
"raw_data": {
"contract": [
{
"type": "TriggerSmartContract",
"parameter": {
"value": {
"contract_address": "41a614f803b6fd780986a42c78ec9c7f77e6ded13c",
"owner_address": "41c337cc0dff83d9642ddc9086633144a24b11d3cd",
"data": "a9059cbb..."
}
}
}
],
"timestamp": 1758026291950
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Get latest N blocks
Code samples
GET /api/v1/trx/block/latest/{num}
Returns the latest N blocks
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| num | path | integer | true | Number of blocks to return |
Example responses
200 Response
{
"block": [
{
"blockID": "00000000048471f4f94914a0bf4d7c3f6395a6edfa22fdbc9a36eb6f6f9508a0",
"block_header": {
"raw_data": {
"number": 75788788,
"timestamp": 1758026295000
}
},
"transactions": []
},
{
"blockID": "00000000048471f3024c7c868dad0c129a064c92e3cc8bc381a3b48d5ee19ded",
"block_header": {
"raw_data": {
"number": 75788787,
"timestamp": 1758026289000
}
},
"transactions": []
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » block | [object] | false | none | none |
Transactions
Transaction-related operations
Get transaction by hash
Code samples
GET /api/v1/trx/transactions/{hash}
Returns details of a transaction by its hash
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| hash | path | string | true | Transaction hash |
Example responses
200 Response
{
"@timestamp": "2025-09-16T09:05:30Z",
"amount": "7975000000",
"block_hash": "0000000004846157838ba929f5a582509c8bf4395cf47f8dff1acd9ce8eb9e57",
"block_number": 75784535,
"block_timestamp": 1758013530000,
"contract_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
"contract_type": "TriggerSmartContract",
"fee": 345000,
"from": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"raw_data": {
"raw_data": {
"contract": [
{
"parameter": {
"type_url": "type.googleapis.com/protocol.TriggerSmartContract",
"value": "ChVBc5O0YG/8bHDotq1H2tsYrdd3aY0SFUGmFPgDtv14CYakLHjsnH935t7RPCJEqQWcuwAAAAAAAAAAAAAAAF6crdA3PL/JZ3fKxH69XuKoI1QBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAdtY18A="
},
"type": 31
}
],
"expiration": 1758013587000,
"fee_limit": 30000000,
"ref_block_bytes": "YUQ=",
"ref_block_hash": "tC3fh1NuWys=",
"timestamp": 1758013529078
},
"ret": [
{
"contractRet": 1
}
],
"signature": [
"Sa/P2+5H2DKVAozyWFd/NA4DWKdSgErcHn9RlD/SHp9A+pJTCQVs7CMPt+OnqpkvPvz/TKaAD0d9kobWJEAnVRw="
]
},
"result": "SUCCESS",
"to": "TJbUDLSLdiuh1TdZ5hUEKMuboJ3X41vwxG",
"token_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
"token_decimals": 6,
"token_symbol": "USDT",
"tx_id": "aa451147fe9bc4514ebc6adc58582eabd480c2869a649571a9262d2e95dae9cd"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Transaction |
| 400 | Bad Request | Bad request (invalid hash format) | None |
| 404 | Not Found | Transaction not found | None |
| 500 | Internal Server Error | Internal server error | None |
Account
Account-related operations
Validate a Tron address
Code samples
GET /api/v1/trx/account/{address}/validate
Checks if the provided address is a valid Tron address
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| address | path | string | true | Tron address to validate |
Example responses
200 Response
{
"address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"is_valid": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 400 | Bad Request | Bad request (invalid address format) | None |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » address | string | false | none | none |
| » is_valid | boolean | false | none | none |
Get account information
Code samples
GET /api/v1/trx/account/{address}
Returns information about a Tron account
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| address | path | string | true | Tron address in base58 format |
Example responses
200 Response
{
"address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"balance": 838847434,
"create_time": 1734187023000,
"latest_opration_time": 1758025827000,
"free_net_usage": 413,
"latest_consume_free_time": 1758007050000,
"net_window_size": 28800000,
"net_window_optimized": true,
"account_resource": {
"energy_usage": 284973,
"latest_consume_time_for_energy": 1758025827000,
"energy_window_size": 25568690,
"acquired_delegated_frozenV2_balance_for_energy": 64073000000,
"energy_window_optimized": true
},
"owner_permission": {
"permission_name": "owner",
"threshold": 1,
"keys": [
{
"address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"weight": 1
}
]
},
"active_permission": [
{
"type": "Active",
"id": 2,
"permission_name": "active",
"threshold": 1,
"operations": "7fff1fc0033ec30f000000000000000000000000000000000000000000000000",
"keys": [
{
"address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"weight": 1
}
]
}
],
"frozenV2": [
[],
{
"type": "ENERGY"
},
{
"type": "TRON_POWER"
}
],
"assetV2": [
{
"key": "1004978",
"value": 800
},
{
"key": "1004989",
"value": 2222222
}
],
"free_asset_net_usageV2": [
{
"key": "1004978",
"value": 0
}
],
"asset_optimized": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Account |
| 400 | Bad Request | Bad request (invalid address format) | None |
| 500 | Internal Server Error | Internal server error | None |
Get account balance
Code samples
GET /api/v1/trx/account/{address}/balance
Returns the TRX balance of a Tron account and TRC20 balances where available
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| address | path | string | true | Tron address in base58 format |
Example responses
200 Response
{
"address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"balance": 0,
"trc20": {
"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t": "6423595359"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 400 | Bad Request | Bad request (invalid address format) | None |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » address | string | false | none | none |
| » balance | integer | false | none | Account balance in SUN (1 TRX = 1,000,000 SUN) |
| » trc20 | object | false | none | TRC20 token balances, if available |
Create a new Tron address
Code samples
POST /api/v1/trx/account/
Creates a new Tron address, either randomly or from a provided mnemonic phrase
Body parameter
{
"mnemonic": "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | false | Optional mnemonic phrase to derive the address from |
| » mnemonic | body | string | false | BIP39 mnemonic phrase |
Example responses
200 Response
{
"address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"private_key": "4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d",
"public_key": "04a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b8dec5235a0fa8722476c7709c02559e3aa73aa03918ba2d492eea75abea235"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 400 | Bad Request | Bad request (invalid mnemonic) | None |
| 405 | Method Not Allowed | Method not allowed (only POST is supported) | None |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » address | string | false | none | none |
| » private_key | string | false | none | none |
| » public_key | string | false | none | none |
Generate a private key from a mnemonic
Code samples
POST /api/v1/trx/account/privatekey
Generates a private key and corresponding Tron address from a mnemonic phrase
Body parameter
{
"mnemonic": "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | Mnemonic phrase to derive the private key from |
| » mnemonic | body | string | true | BIP39 mnemonic phrase |
Example responses
200 Response
{
"address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"private_key": "4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d",
"public_key": "04a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd5b8dec5235a0fa8722476c7709c02559e3aa73aa03918ba2d492eea75abea235"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 400 | Bad Request | Bad request (missing or invalid mnemonic) | None |
| 405 | Method Not Allowed | Method not allowed (only POST is supported) | None |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » address | string | false | none | none |
| » private_key | string | false | none | none |
| » public_key | string | false | none | none |
Send TRX from one address to another
Code samples
POST /api/v1/trx/account/send
Creates and broadcasts a transaction to send TRX from one address to another
Body parameter
{
"private_key": "4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d",
"to_address": "TFPn7vYQckxhKxhHX5CaAzWCnbYJCgG2DF",
"amount": 1000000
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | Transaction details including sender's private key, recipient address, and amount |
| » private_key | body | string | true | Sender's private key in hex format |
| » to_address | body | string | true | Recipient's Tron address in base58 format |
| » amount | body | integer | true | Amount of TRX to send in SUN (1 TRX = 1,000,000 SUN) |
Example responses
200 Response
{
"success": true,
"tx_id": "95354c4bdc832fa21a3b6e3f32137bbca11a576c75109bd598283ab864a81ce7",
"from_address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"to_address": "TFPn7vYQckxhKxhHX5CaAzWCnbYJCgG2DF",
"amount": 1000000,
"amount_trx": 1
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 400 | Bad Request | Bad request (missing or invalid parameters) | None |
| 405 | Method Not Allowed | Method not allowed (only POST is supported) | None |
| 500 | Internal Server Error | Internal server error (transaction creation or broadcast failed) | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » success | boolean | false | none | none |
| » tx_id | string | false | none | Transaction ID (hash) |
| » from_address | string | false | none | Sender's address |
| » to_address | string | false | none | Recipient's address |
| » amount | integer | false | none | Amount in SUN |
| » amount_trx | number | false | none | Amount in TRX |
Send USDT (TRC20) from one address to another
Code samples
POST /api/v1/trx/account/send/usdt
Creates and broadcasts a TRC20 transaction to send USDT from one address to another on Tron
Body parameter
{
"private_key": "4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d",
"to_address": "TFPn7vYQckxhKxhHX5CaAzWCnbYJCgG2DF",
"amount": 5.75,
"fee_limit": 30000000
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | Transaction details including sender's private key, recipient address, amount in USDT, and optional fee limit |
| » private_key | body | string | true | Sender's private key in hex format |
| » to_address | body | string | true | Recipient's Tron address in base58 format |
| » amount | body | number(float) | true | Amount of USDT to send (decimal, 6 decimals) |
| » fee_limit | body | integer | false | Maximum fee limit in SUN (1 TRX = 1,000,000 SUN). Defaults to 30000000 if not provided |
Example responses
200 Response
{
"success": true,
"tx_id": "95354c4bdc832fa21a3b6e3f32137bbca11a576c75109bd598283ab864a81ce7",
"from_address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"to_address": "TFPn7vYQckxhKxhHX5CaAzWCnbYJCgG2DF",
"amount": 5.75,
"amount_trx": 0.00000575
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 400 | Bad Request | Bad request (missing or invalid parameters) | None |
| 405 | Method Not Allowed | Method not allowed (only POST is supported) | None |
| 500 | Internal Server Error | Internal server error (transaction creation or broadcast failed) | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » success | boolean | false | none | none |
| » tx_id | string | false | none | Transaction ID (hash) |
| » from_address | string | false | none | Sender's address |
| » to_address | string | false | none | Recipient's address |
| » amount | number | false | none | Amount in USDT (decimal) |
| » amount_trx | number | false | none | Amount converted to TRX for display |
Address
Address-related operations
Get all transactions for an address
Code samples
GET /api/v1/trx/address/{address}/transactions
Returns paginated list of transactions for the specified address
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| address | path | string | true | Tron address in base58 format |
| page | query | integer | false | Page number (default is 1) |
| per_page | query | integer | false | Items per page (default is 20, max is 50) |
| currency | query | string | false | Currency to filter by trx, usdt (default is all) |
Example responses
200 Response
{
"transactions": [
{
"@timestamp": "2025-09-16T12:30:42Z",
"amount": "3",
"block_hash": "000000000484715dffef1b99e837b860411174ae940c73ede754fe5dbb48b00d",
"block_number": 75788637,
"block_timestamp": 1758025842000,
"contract_type": "TransferContract",
"fee": 0,
"from": "TTkFbvEFZVU6wxjEgMo3Tueiisphi6cJzh",
"result": "SUCCESS",
"to": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"token_decimals": 6,
"token_symbol": "TRX",
"tx_id": "3ce2e9f522baf0e4dc28e0f2604c1ad2216482e535b1c60d65ea7cca1de40f70"
},
{
"@timestamp": "2025-09-16T12:30:30Z",
"amount": "3724000000",
"block_hash": "00000000048471591924378d405ab66bb72d6775e5032f36fa1f5be58efa0646",
"block_number": 75788633,
"block_timestamp": 1758025830000,
"contract_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
"contract_type": "TriggerSmartContract",
"fee": 345000,
"from": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"result": "SUCCESS",
"to": "TNoSrqU8rxb1y2mcn1kvFmXRGVXyPiKJzh",
"token_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
"token_decimals": 6,
"token_symbol": "USDT",
"tx_id": "d358ffa7390a1981c2b656efe89d1d04137570442ea2638a6920335f3c7f84fe"
}
],
"pagination": {
"current_page": 1,
"total_pages": 1,
"total_transactions": 20,
"per_page": 20,
"has_more": false
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 400 | Bad Request | Bad request (invalid parameters) | None |
| 500 | Internal Server Error | Internal server error | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » transactions | [Transaction] | false | none | none |
| »» tx_id | string | false | none | Transaction ID (hash) |
| »» block_number | integer | false | none | Block number containing the transaction |
| »» block_timestamp | integer | false | none | Block timestamp in milliseconds |
| »» block_hash | string | false | none | Block hash containing the transaction |
| »» from | string | false | none | Sender address |
| »» to | string | false | none | Receiver address |
| »» amount | string | false | none | Transaction amount |
| »» token_symbol | string | false | none | Token symbol (TRX, USDT, etc.) |
| »» token_decimals | integer | false | none | Number of decimal places for the token |
| »» contract_type | string | false | none | Type of contract executed |
| »» fee | integer | false | none | Transaction fee in SUN |
| »» result | string | false | none | Transaction result status |
| »» contract_address | string¦null | false | none | Contract address (for TRC20 tokens) |
| »» token_address | string¦null | false | none | Token (TRC20) contract address (alias of contract_address) |
| »» raw_data | object | false | none | Raw transaction payload from blockchain/indexer |
| »» @timestamp | string | false | none | Indexing timestamp (ISO 8601) |
| » pagination | Pagination | false | none | none |
| »» current_page | integer | false | none | none |
| »» total_pages | integer | false | none | none |
| »» total_transactions | integer | false | none | none |
| »» per_page | integer | false | none | none |
| »» has_more | boolean | false | none | none |
Webhooks
Webhook management operations
List webhooks
Code samples
GET /api/v1/trx/webhooks
Returns all webhooks belonging to the authenticated user
Example responses
200 Response
{
"data": [
{
"id": 1,
"user_id": 10,
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"is_active": true,
"created_at": "2025-09-16T12:00:00Z",
"updated_at": "2025-09-16T12:00:00Z"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » data | [Webhook] | false | none | none |
| »» id | integer | false | none | none |
| »» user_id | integer | false | none | none |
| »» coin | string | false | none | none |
| »» webhook_url | string(uri) | false | none | none |
| »» addresses | [string] | false | none | none |
| »» is_active | boolean | false | none | none |
| »» created_at | string(date-time) | false | none | none |
| »» updated_at | string(date-time) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| coin | TRX |
Create webhook
Code samples
POST /api/v1/trx/webhooks
Creates a new webhook for the authenticated user
Body parameter
{
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"is_active": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | WebhookCreateRequest | true | none |
Example responses
201 Response
{
"data": {
"id": 1,
"user_id": 10,
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"is_active": true,
"created_at": "2025-09-16T12:00:00Z",
"updated_at": "2025-09-16T12:00:00Z"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | Inline |
| 400 | Bad Request | Bad request (validation failed) | None |
Response Schema
Status Code 201
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » data | Webhook | false | none | none |
| »» id | integer | false | none | none |
| »» user_id | integer | false | none | none |
| »» coin | string | false | none | none |
| »» webhook_url | string(uri) | false | none | none |
| »» addresses | [string] | false | none | none |
| »» is_active | boolean | false | none | none |
| »» created_at | string(date-time) | false | none | none |
| »» updated_at | string(date-time) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| coin | TRX |
Get webhook
Code samples
GET /api/v1/trx/webhooks/{webhook}
Returns a single webhook by id if it belongs to the authenticated user
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| webhook | path | integer | true | Webhook ID |
Example responses
200 Response
{
"data": {
"id": 1,
"user_id": 10,
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"is_active": true,
"created_at": "2025-09-16T12:00:00Z",
"updated_at": "2025-09-16T12:00:00Z"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 404 | Not Found | Webhook not found | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » data | Webhook | false | none | none |
| »» id | integer | false | none | none |
| »» user_id | integer | false | none | none |
| »» coin | string | false | none | none |
| »» webhook_url | string(uri) | false | none | none |
| »» addresses | [string] | false | none | none |
| »» is_active | boolean | false | none | none |
| »» created_at | string(date-time) | false | none | none |
| »» updated_at | string(date-time) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| coin | TRX |
Update webhook
Code samples
PUT /api/v1/trx/webhooks/{webhook}
Updates a webhook that belongs to the authenticated user
Body parameter
{
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"is_active": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| webhook | path | integer | true | Webhook ID |
| body | body | WebhookUpdateRequest | true | none |
Example responses
200 Response
{
"data": {
"id": 1,
"user_id": 10,
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"is_active": true,
"created_at": "2025-09-16T12:00:00Z",
"updated_at": "2025-09-16T12:00:00Z"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | Inline |
| 404 | Not Found | Webhook not found | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » data | Webhook | false | none | none |
| »» id | integer | false | none | none |
| »» user_id | integer | false | none | none |
| »» coin | string | false | none | none |
| »» webhook_url | string(uri) | false | none | none |
| »» addresses | [string] | false | none | none |
| »» is_active | boolean | false | none | none |
| »» created_at | string(date-time) | false | none | none |
| »» updated_at | string(date-time) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| coin | TRX |
Delete webhook
Code samples
DELETE /api/v1/trx/webhooks/{webhook}
Deletes a webhook that belongs to the authenticated user
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| webhook | path | integer | true | Webhook ID |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content | None |
| 404 | Not Found | Webhook not found | None |
Schemas
Transaction
{
"tx_id": "aa451147fe9bc4514ebc6adc58582eabd480c2869a649571a9262d2e95dae9cd",
"block_number": 75784535,
"block_timestamp": 1758013530000,
"block_hash": "0000000004846157838ba929f5a582509c8bf4395cf47f8dff1acd9ce8eb9e57",
"from": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"to": "TJbUDLSLdiuh1TdZ5hUEKMuboJ3X41vwxG",
"amount": "7975000000",
"token_symbol": "USDT",
"token_decimals": 6,
"contract_type": "TriggerSmartContract",
"fee": 345000,
"result": "SUCCESS",
"contract_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
"token_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
"raw_data": {},
"@timestamp": "2025-09-16T09:05:30Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tx_id | string | false | none | Transaction ID (hash) |
| block_number | integer | false | none | Block number containing the transaction |
| block_timestamp | integer | false | none | Block timestamp in milliseconds |
| block_hash | string | false | none | Block hash containing the transaction |
| from | string | false | none | Sender address |
| to | string | false | none | Receiver address |
| amount | string | false | none | Transaction amount |
| token_symbol | string | false | none | Token symbol (TRX, USDT, etc.) |
| token_decimals | integer | false | none | Number of decimal places for the token |
| contract_type | string | false | none | Type of contract executed |
| fee | integer | false | none | Transaction fee in SUN |
| result | string | false | none | Transaction result status |
| contract_address | string¦null | false | none | Contract address (for TRC20 tokens) |
| token_address | string¦null | false | none | Token (TRC20) contract address (alias of contract_address) |
| raw_data | object | false | none | Raw transaction payload from blockchain/indexer |
| @timestamp | string | false | none | Indexing timestamp (ISO 8601) |
Account
{
"address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"balance": "100000000",
"create_time": 1689321600000,
"latest_operation_time": 1689321600000,
"allowance": 0,
"latest_withdraw_time": 0,
"is_witness": false,
"asset_issued_name": "",
"free_net_usage": 0,
"free_net_limit": 1500,
"total_net_limit": 43200000000,
"net_used": 0,
"net_limit": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| address | string | false | none | Account address |
| balance | string | false | none | Account balance in SUN (1 TRX = 1,000,000 SUN) |
| create_time | integer | false | none | Account creation time in milliseconds |
| latest_operation_time | integer | false | none | Latest operation time in milliseconds |
| allowance | integer | false | none | Account allowance |
| latest_withdraw_time | integer | false | none | Latest withdraw time |
| is_witness | boolean | false | none | Whether the account is a witness |
| asset_issued_name | string | false | none | Name of issued asset |
| free_net_usage | integer | false | none | Free network bandwidth usage |
| free_net_limit | integer | false | none | Free network bandwidth limit |
| total_net_limit | integer | false | none | Total network bandwidth limit |
| net_used | integer | false | none | Network bandwidth used |
| net_limit | integer | false | none | Network bandwidth limit |
Pagination
{
"current_page": 1,
"total_pages": 5,
"total_transactions": 100,
"per_page": 20,
"has_more": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| current_page | integer | false | none | none |
| total_pages | integer | false | none | none |
| total_transactions | integer | false | none | none |
| per_page | integer | false | none | none |
| has_more | boolean | false | none | none |
Webhook
{
"id": 1,
"user_id": 10,
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"is_active": true,
"created_at": "2025-09-16T12:00:00Z",
"updated_at": "2025-09-16T12:00:00Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | none | none |
| user_id | integer | false | none | none |
| coin | string | false | none | none |
| webhook_url | string(uri) | false | none | none |
| addresses | [string] | false | none | none |
| is_active | boolean | false | none | none |
| created_at | string(date-time) | false | none | none |
| updated_at | string(date-time) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| coin | TRX |
WebhookCreateRequest
{
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"is_active": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| coin | string | true | none | Currency for which to trigger webhooks |
| webhook_url | string(uri) | true | none | Target URL to receive webhook POST requests |
| addresses | [string] | true | none | List of addresses to monitor |
| is_active | boolean | false | none | Whether the webhook is active |
Enumerated Values
| Property | Value |
|---|---|
| coin | TRX |
WebhookUpdateRequest
{
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"is_active": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| coin | string | true | none | none |
| webhook_url | string(uri) | true | none | none |
| addresses | [string] | true | none | none |
| is_active | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| coin | TRX |
WebhookEvent
{
"event": "transaction_confirmed",
"coin": "TRX",
"transaction_id": "test_5f2c9a7d3b1",
"from_address": "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o",
"to_address": "TJbUDLSLdiuh1TdZ5hUEKMuboJ3X41vwxG",
"amount": "1000000",
"confirmations": 6,
"block_height": 12345678,
"timestamp": "2025-09-16T12:00:00Z",
"test": true
}
Payload that the system posts to your webhook_url
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| event | string | false | none | none |
| coin | string | false | none | none |
| transaction_id | string | false | none | none |
| from_address | string | false | none | none |
| to_address | string | false | none | none |
| amount | string | false | none | Amount in minimal units (SUN for TRX) |
| confirmations | integer | false | none | none |
| block_height | integer | false | none | none |
| timestamp | string(date-time) | false | none | none |
| test | boolean | false | none | Indicates test webhook payload |
