API reference Vaultody

GET /vaults/{vaultId}/{blockchain}/{network}/{address}/overview

Tron Resource Overview

This endpoint retrieves an overview of TRX staking and resource allocation for a specific address. It provides details on the available TRX balance, staked TRX, and allocated resources (bandwidth/energy), helping users monitor their staking activities.

Path parameters

address string required

The address associated with the staking activity.

blockchain string required

Specifies the blockchain used.

network string required

Specifies the network used (eg. mainnet , nile).

vaultId string required

Represents the specific and unique Vault ID.

Query parameters

context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.

Response

Returns 200 the request has been successful.

apiVersion string required

Specifies the version of the API that incorporates this endpoint.

E.G. 2026-03-20

requestId string required

Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.

E.G. 601c1710034ed6d407996b30

context string

E.G. yourExampleString

data object required

item object required

address string required

The address associated with the staking activity.

E.G. TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4

balance object required

available string required

Available amount is total amount without available frozen amount and delegated amount.

E.G. 70

availableFrozen string required

Amount including total frozen without delegated amount.

E.G. 30.123

delegated string required

Amount that is used for freezing resources for another address.

E.G. 0

total string required

Total TRX balance, including available, availableFrozen, delegated and withdrawableAmount amounts.

E.G. 100.123

unit string required

Defines the unit of the amount.

E.G. TRX

withdrawableAmount string required

The amount of TRX that has been successfully unstaked and has passed the mandatory waiting period (e.g., 14 days in Stake 2.0). This balance is now available for withdrawal back to the user’s account.

E.G. 1

frozenResources object required

bandwidth string required

Type of frozen resource - bandwidth.

E.G. 10

energy string required

Type of frozen resource - energy.

E.G. 20.123

tronPower string required

Type of frozen resource - tron voting power.

E.G. 0

network string required

The network (e.g., mainnet, nile).

E.G. mainnet

resources object required

bandwidth object required

Info about account's bandwidth

acquiredDelegated string required

TRX amount equivalent to the acquired delegated bandwidth by others for this account.

E.G. 0

available integer required

Available bandwidth including free bandwidth, from frozen TRX and from others' delegation.

E.G. 1035

delegated string required

TRX amount equivalent to the delegated bandwidth for others from this account.

E.G. 0

freeLimit integer required

Depending on Tron - 600 for all accounts.

E.G. 600

freeUsed integer required

Free bandwidth used.

E.G. 0

limit integer required

Total bandwidth obtained by staking.

E.G. 1035

used integer required

Used amount of bandwidth obtained by staking.

E.G. 0

energy object required

Info about account's energy.

acquiredDelegated string required

TRX amount equivalent to the acquired delegated energy by others for this account.

E.G. 0

available integer required

Available energy, including from frozen TRX and from others' delegation.

E.G. 775

delegated string required

TRX amount equivalent to the delegated energy for others from this account.

E.G. 0

limit integer required

Total energy obtained by staking.

E.G. 775

used integer required

Energy used.

E.G. 0

Errors

400 The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination. application/json

401 The provided API key is invalid. Please, generate a new one from your Dashboard. application/json

403 Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it. application/json

404 The specified resource has not been found. application/json

409 The data provided seems to be invalid. application/json

415 The selected Media Type is unavailable. The Content-Type header should be 'application/json'. application/json

422 Your request body for POST requests must have a structure of { data: { item: [...properties] } } application/json

429 The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. application/json

500 An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. application/json