Skip to content

GetBalance

GetBalance returns an address's balances, approvals, auto-approve flags, and permissions in a collection.

Returns the UserBalanceStore for one address in one collection: balances, outgoing and incoming approvals, auto-approve flags, and user permissions.

Example

bash
bb query tokenization balance 1 bb1py4mfpg6uf59qkyzg0nmau322c5873eeysp5ue
bash
curl https://lcd.bitbadges.io/bitbadges/bitbadgeschain/tokenization/get_balance/1/bb1py4mfpg6uf59qkyzg0nmau322c5873eeysp5ue

Request

FieldTypeDescription
collectionIdstringCollection ID.
addressstringAddress to look up. Mint and Total are valid.

Response

json
{
  "balance": {
    "balances": [
      {
        "amount": "1",
        "ownershipTimes": [{ "start": "1", "end": "18446744073709551615" }],
        "tokenIds": [{ "start": "1", "end": "1" }]
      }
    ],
    "outgoingApprovals": [],
    "incomingApprovals": [],
    "autoApproveSelfInitiatedOutgoingTransfers": true,
    "autoApproveSelfInitiatedIncomingTransfers": true,
    "autoApproveAllIncomingTransfers": true,
    "userPermissions": {
      "canUpdateOutgoingApprovals": [],
      "canUpdateIncomingApprovals": [],
      "canUpdateAutoApproveSelfInitiatedOutgoingTransfers": [],
      "canUpdateAutoApproveSelfInitiatedIncomingTransfers": [],
      "canUpdateAutoApproveAllIncomingTransfers": []
    }
  }
}
FieldTypeDescription
balancesBalance[]Owned amounts by token ID range and ownership time range.
outgoingApprovalsUserOutgoingApproval[]Approvals for transfers out of this address.
incomingApprovalsUserIncomingApproval[]Approvals for transfers into this address.
autoApproveSelfInitiatedOutgoingTransfersboolApprove transfers the address initiates from itself.
autoApproveSelfInitiatedIncomingTransfersboolApprove transfers the address initiates to itself.
autoApproveAllIncomingTransfersboolApprove every incoming transfer.
userPermissionsUserPermissionsPermissions that guard updates to the fields above.

Behavior

  • An address with no stored record returns the collection's defaultBalances.
  • Mint returns an empty balance store: its unlimited source balance is handled specially during transfers. It does not report remaining mint allowance. Inspect mint approvals and their trackers for that. Total tracks cumulative standard minting; use GetCollectionStats for circulating supply, including backed-path issuance and redemption.
  • For a single token at a single time, GetBalanceForToken returns one number instead of ranges.

Edit this page on GitHub