Get a token balance

GET/v3-node-0/smartaccount/{address}/balance

Get a token balanceSmart accounts

Returns the available balance for a specific token in a smart account

Base URL https://api.storm.tg

Parameters

Path

addressstringrequired

Smart account address

Example: string

Query

token_addressstringrequired

Token collateral asset ID

Example: string

include_breakdownbooleanoptional

Also return leased and locked fields (default false)

Example: true

Examples

curl --request GET 'https://api.storm.tg/v3-node-0/smartaccount/{address}/balance' \
  --header 'Accept: application/json'

const response = await fetch("https://api.storm.tg/v3-node-0/smartaccount/{address}/balance", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  },
});
console.log(response.status, await response.text());

import requests
 
response = requests.request(
    "GET",
    "https://api.storm.tg/v3-node-0/smartaccount/{address}/balance",
    headers={"Accept":"application/json"},
    timeout=30,
)
print(response.status_code, response.text)

Responses

200OKapplication/json

amountintegeroptional

Example: 0

leasedintegeroptional

Leased and Locked break down what was netted out of the on-chain amount to get Amount (free = on-chain − leased − locked). Populated only when the caller passes ?include_breakdown=true; nil (omitted) otherwise.

Example: 0

lockedintegeroptional

Example: 0

minter_addressstringoptional

Example: string

{
  "amount": 0,
  "leased": 0,
  "locked": 0,
  "minter_address": "string"
}

400Bad Requestapplication/json

codestringoptional

Example: string

errorstringoptional

Example: string

externalQueryIdstringoptional

Example: string

msgstringoptional

Example: string

{
  "code": "string",
  "error": "string",
  "externalQueryId": "string",
  "msg": "string"
}

404Not Foundapplication/json

codestringoptional

Example: string

errorstringoptional

Example: string

externalQueryIdstringoptional

Example: string

msgstringoptional

Example: string

{
  "code": "string",
  "error": "string",
  "externalQueryId": "string",
  "msg": "string"
}

500Internal Server Errorapplication/json

codestringoptional

Example: string

errorstringoptional

Example: string

externalQueryIdstringoptional

Example: string

msgstringoptional

Example: string

{
  "code": "string",
  "error": "string",
  "externalQueryId": "string",
  "msg": "string"
}