Skip to content

/wallet/getcanwithdrawunfreezeamount

Query the unfreeze amount the account can withdraw at a given timestamp (Stake 2.0).

  • Source: framework/src/main/java/org/tron/core/services/http/GetCanWithdrawUnfreezeAmountServlet.java
  • Method: GET / POST
  • Response: api.CanWithdrawUnfreezeAmountResponseMessage
  • Solidity endpoint: /walletsolidity/getcanwithdrawunfreezeamount

Request parameters

Field Type Required Description
owner_address string Yes Account address
timestamp int64 No Cutoff timestamp (ms); when missing or 0, uses latest block time; when negative, returns {}
visible bool No Address format

Example:

curl --request POST \
     --url https://nile.trongrid.io/wallet/getcanwithdrawunfreezeamount \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "owner_address": "41dd791d6b49e190062d650e6a23c575510d35f2f9",
  "timestamp":     1900000000000
}
'

Response

Field Type Description
amount int64 Total unfreeze amount withdrawable up to that timestamp (sun)

Response example (no in-progress unfreeze entries on the account; proto default is not serialized, returns empty {}; when there is a withdrawable amount it looks like {"amount": 1500000000}):

{}

Error responses

Trigger Response
Request body exceeds node.maxMessageSize (POST) {"Error": "class java.lang.Exception : body size is too big, the limit is <N>"}
timestamp is not numeric (GET) {"Error": "class java.lang.NumberFormatException : <message>"}
owner_address is not valid base58check (visible=true) GET: with non-base58 characters, throws {"Error": "class java.lang.IllegalArgumentException : <details>"}; if only the checksum is wrong, Util.getHexAddress silently returns empty string → no record found, returns {}. POST (via JsonFormat.merge): with non-base58 characters, throws {"Error": "class org.tron.core.services.http.JsonFormat$ParseException : <pos>: INVALID base58 String, ..."}; if only the checksum is wrong, throws {"Error": "class java.lang.NullPointerException : null"}
owner_address is not valid hex (visible=false) {"Error": "class org.bouncycastle.util.encoders.DecoderException : <message>"} (GET); {"Error": "class org.tron.core.services.http.JsonFormat$ParseException : <message>"} (POST)
Request body is not valid JSON / field type mismatch (POST) {"Error": "class com.alibaba.fastjson.JSONException : <parser info>"} or {"Error": "class org.tron.core.services.http.JsonFormat$ParseException : <decoder info>"}
Other exceptions {"Error": "<exceptionClass> : <message>"}