Skip to content

Account

Account = object

Defined in: packages/algod_client/src/models/account.ts:30

Account information at a given round.

Definition: data/basics/userBalance.go : AccountData

address: Address

Defined in: packages/algod_client/src/models/account.ts:34

the account public key


amount: bigint

Defined in: packages/algod_client/src/models/account.ts:39

[algo] total number of MicroAlgos in the account


amountWithoutPendingRewards: bigint

Defined in: packages/algod_client/src/models/account.ts:51

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


optional appsLocalState: ApplicationLocalState[]

Defined in: packages/algod_client/src/models/account.ts:58

[appl] applications local data stored in this account.

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


optional appsTotalExtraPages: number

Defined in: packages/algod_client/src/models/account.ts:69

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


optional appsTotalSchema: ApplicationStateSchema

Defined in: packages/algod_client/src/models/account.ts:64


optional assets: AssetHolding[]

Defined in: packages/algod_client/src/models/account.ts:76

[asset] assets held by this account.

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


optional authAddr: Address

Defined in: packages/algod_client/src/models/account.ts:162

[spend] 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.


optional createdApps: Application[]

Defined in: packages/algod_client/src/models/account.ts:88

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

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


optional createdAssets: Asset[]

Defined in: packages/algod_client/src/models/account.ts:100

[apar] parameters of assets created by this account.

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


optional incentiveEligible: boolean

Defined in: packages/algod_client/src/models/account.ts:121

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


optional lastHeartbeat: bigint

Defined in: packages/algod_client/src/models/account.ts:172

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


optional lastProposed: bigint

Defined in: packages/algod_client/src/models/account.ts:167

The round in which this account last proposed the block.


minBalance: bigint

Defined in: packages/algod_client/src/models/account.ts:46

MicroAlgo balance required by the account.

The requirement grows based on asset and application usage.


optional participation: AccountParticipation

Defined in: packages/algod_client/src/models/account.ts:116


pendingRewards: bigint

Defined in: packages/algod_client/src/models/account.ts:126

amount of MicroAlgos of pending rewards in this account.


optional rewardBase: bigint

Defined in: packages/algod_client/src/models/account.ts:131

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


rewards: bigint

Defined in: packages/algod_client/src/models/account.ts:136

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


round: bigint

Defined in: packages/algod_client/src/models/account.ts:141

The round for which this information is relevant.


optional sigType: "sig" | "msig" | "lsig"

Defined in: packages/algod_client/src/models/account.ts:157

Indicates what type of signature is used by this account, must be one of:

  • sig
  • msig
  • lsig

status: string

Defined in: packages/algod_client/src/models/account.ts:149

[onl] delegation 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.

totalAppsOptedIn: number

Defined in: packages/algod_client/src/models/account.ts:63

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


totalAssetsOptedIn: number

Defined in: packages/algod_client/src/models/account.ts:81

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


optional totalBoxBytes: number

Defined in: packages/algod_client/src/models/account.ts:115

[tbxb] The total number of bytes used by this account’s app’s box keys and values.


optional totalBoxes: number

Defined in: packages/algod_client/src/models/account.ts:110

[tbx] The number of existing boxes created by this account’s app.


totalCreatedApps: number

Defined in: packages/algod_client/src/models/account.ts:93

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


totalCreatedAssets: number

Defined in: packages/algod_client/src/models/account.ts:105

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