Skip to main content

index/interfaces/TokenBalanceInput.md

fetchTokenBalance: one owner's balance of one token class, with its holds summed.

Properties​

PropertyTypeDescription
asOf?numberThe time holds are judged at, in epoch milliseconds (default now).
includeExpiredHolds?booleanKeep holds that have expired (default false: an expired hold no longer holds anything).
ownerstringThe owner (see BalancesFilter.owner).
tokenClassKeyTokenClassKeyInputThe token class (pipe string with exactly four parts, $ composite key, or object).