Skip to content

Account

Account: object

Account information at a given round.

Definition: data/basics/userBalance.go : AccountData

Type declaration

address

address: string

the account public key

amount

amount: number

total number of MicroAlgos in the account

amount-without-pending-rewards

amount-without-pending-rewards: number

specifies the amount of MicroAlgos in the account, without the pending rewards.

apps-local-state?

optional apps-local-state: ApplicationLocalState[]

application local data stored in this account.

Note the raw object uses map[int] -> AppLocalState for this type.

apps-total-extra-pages?

optional apps-total-extra-pages: number

the sum of all extra application program pages for this account.

apps-total-schema?

optional apps-total-schema: ApplicationStateSchema

assets?

optional assets: AssetHolding[]

assets held by this account.

Note the raw object uses map[int] -> AssetHolding for this type.

auth-addr?

optional auth-addr: string

The address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field.

closed-at-round?

optional closed-at-round: number

Round during which this account was most recently closed.

created-apps?

optional created-apps: Application[]

parameters of applications created by this account including app global data.

Note: the raw account uses map[int] -> AppParams for this type.

created-assets?

optional created-assets: Asset[]

parameters of assets created by this account.

Note: the raw account uses map[int] -> Asset for this type.

created-at-round?

optional created-at-round: number

Round during which this account first appeared in a transaction.

deleted?

optional deleted: boolean

Whether or not this account is currently closed.

incentive-eligible?

optional incentive-eligible: boolean

can the account receive block incentives if its balance is in range at proposal time.

last-heartbeat?

optional last-heartbeat: number

The round in which this account last went online, or explicitly renewed their online status.

last-proposed?

optional last-proposed: number

The round in which this account last proposed the block.

min-balance

min-balance: number

MicroAlgo balance required by the account.

The requirement grows based on asset and application usage.

participation?

optional participation: AccountParticipation

pending-rewards

pending-rewards: number

amount of MicroAlgos of pending rewards in this account.

reward-base?

optional reward-base: number

used as part of the rewards computation. Only applicable to accounts which are participating.

rewards

rewards: number

total rewards of MicroAlgos the account has received, including pending rewards.

round

round: number

The round for which this information is relevant.

sig-type?

optional sig-type: "sig" | "msig" | "lsig"

the type of signature used by this account, must be one of:

  • sig
  • msig
  • lsig
  • or null if unknown

status

status: string

voting status of the account’s MicroAlgos

  • Offline - indicates that the associated account is delegated.
  • Online - indicates that the associated account used as part of the delegation pool.
  • NotParticipating - indicates that the associated account is neither a delegator nor a delegate.

total-apps-opted-in

total-apps-opted-in: number

The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account.

total-assets-opted-in

total-assets-opted-in: number

The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account.

total-box-bytes

total-box-bytes: number

For app-accounts only. The total number of bytes allocated for the keys and values of boxes which belong to the associated application.

total-boxes

total-boxes: number

For app-accounts only. The total number of boxes which belong to the associated application.

total-created-apps

total-created-apps: number

The count of all apps (AppParams objects) created by this account.

total-created-assets

total-created-assets: number

The count of all assets (AssetParams objects) created by this account.

Defined in

types.gen.ts:10