getaccountnet

How to use it

// yarn add @tatumio/tatum

import { TatumSDK, Tron, Network, VisibleOption } from '@tatumio/tatum'

const tatum = await TatumSDK.init<Tron>({ network: Network.TRON })

const address = 'TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g'

const res = await tatum.rpc.getAccountNet(address, {
  visible: true,
})

await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs

Overview

The getAccountNet method is used to query bandwidth information of a specific account on the TRON network. This method can be useful for assessing an account's remaining network capacity.

Parameters

• address (string): The address of the account whose bandwidth information is to be queried.
• options (object, optional): This optional parameter contains the following properties:
  • visible (boolean, optional): Optional parameter to specify whether the address is in base58 format.

Return Object

The method returns a JSON object that contains the following properties:

• freeNetUsed (integer): Free bandwidth used.
• freeNetLimit (integer): Total free bandwidth.
• NetUsed (integer): Used amount of bandwidth obtained by staking.
• NetLimit (integer): Total bandwidth obtained by staking.
• TotalNetLimit (integer): Total bandwidth can be obtained by staking by the whole network.
• TotalNetWeight (integer): Total TRX staked for bandwidth by the whole network.
• assetNetUsed (map<string, integer>): The amount of free bandwidth of each TRC10 asset used by the account.
• assetNetLimit (map<string, integer>): The amount of free bandwidth for each TRC10 asset in the account.

HTTP Request Example

{
  "address": "TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g",
  "visible": true
}

HTTP Response Example

{
  "freeNetLimit": 1500,
  "TotalNetLimit": 43200000000,
  "TotalNetWeight": 84593524300
}