API reference
Vaultody
POST
/vaults/{vaultId}/{blockchain}/{network}/addresses/{fromAddress}/manage-resource
Tron Resource Management
Through this endpoint, users can manage TRX staking: freezing, unfreezing, and withdrawing TRX. Stake an amount of TRX to obtain bandwidth or energy and optimize blockchain resource usage. Additionally, users can delegate bandwidth or energy resources to other accounts for efficient transaction processing.
Path parameters
blockchain
string
required
Specifies the blockchain network involved in the transaction (eg. tron).
fromAddress
string
required
Represents the originating address from which the transaction is initiated.
network
string
required
Specifies the network used (eg. mainnet , nile).
vaultId
string
required
Represents the sender's specific and unique Vault ID of the sender.
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.
Body parameters application/json
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.
data
object
required
item
object
required
amount
string
e.g. 3
The amount of TRX which will be freeze/unfreeze/delegate/undelegate. When type of request is withdraw-resource the amount is not required.
lock
string
e.g. true
Boolean if we want to lock the delegated amount. Whether to lock the resource delegation, true means locked the delegation, the delegating cannot be canceled within the period specified by lockPeriod, false means non-locked, the resource delegating can be canceled at any time
lockPeriod
string
e.g. 28800
Only when lock is true, this field is valid. If the delegate lock period is 1 day, the lock_period is: 28800. The minimum value of lockPeriod is the remaining lock period of this type of resource that was delegated last time, and the maximum value is 864000 (30 days). If lock is true and lock_period is not set or set t...
note
string
e.g. Your note
Transaction note with additional details.
resource
string
required
e.g. bandwidth
Resource staking for (e.g. Bandwidth, Energy).
bandwidth
energy
toAddress
string
e.g. TJgba7p9nFz6vMgVBJUxTaRR8WbpaG6ifi
Address receiving the delegated amount or from which we undelegate. It is used when type of the request is delegate/undelagate.
type
string
required
e.g. freeze
Type of the request (e.g. freeze, unfreeze, withdraw-resource)
freeze
unfreeze
withdraw-resource
delegate
undelegate
Response
Returns 201 the request has been successfully created.
apiVersion
string
required
Specifies the version of the API that incorporates this endpoint.
requestId
string
required
Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.
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.
data
object
required
item
object
required
blockchain
string
required
Specifies the blockchain network involved in the transaction. (eg. tron).
tron
destination
object[]
required
Destination of the transaction.
address
string
required
Address of the destination that will receive the resources.
amount
string
required
The amount of TRX being staked/unfrozen.
amountUnit
string
required
The unit of currency used in the transaction.
id
string
required
A unique identifier for the transaction.
network
string
required
Specifies the network used (eg. mainnet, nile).
mainnet
nile
resource
string
required
Specifies the type of the resource being managed(eg. bandwidth, energy)
source
object
required
Details about the sender.
address
string
required
The address of the sender.
status
string
required
Defines the status of the transaction request, (e.g. created).
created
await-approval-l2
type
string
required
The type of staking operation being performed (eg. freeze, unfreeze, withdraw-resource)
automation-token
freeze
unfreeze
withdraw-resource
delegate
undelegate
vaultId
string
required
Identifies the vault id linked to the transaction.