types indexer.AccountResult
@algorandfoundation/algokit-utils / types/indexer / AccountResult
Interface: AccountResult¶
types/indexer.AccountResult
Account information at a given round https://developer.algorand.org/docs/rest-apis/indexer/#account
Hierarchy¶
Record\<string,any>
↳ AccountResult
Table of contents¶
Properties¶
- address
- amount
- amount-without-pending-rewards
- apps-local-state
- apps-total-extra-pages
- apps-total-schema
- assets
- auth-addr
- closed-at-round
- created-apps
- created-assets
- created-at-round
- deleted
- participation
- pending-rewards
- reward-base
- rewards
- round
- sig-type
- status
- total-apps-opted-in
- total-assets-opted-in
- total-box-bytes
- total-boxes
- total-created-apps
- total-created-assets
Properties¶
address¶
• address: string
the account public key
Defined in¶
amount¶
• amount: number
[algo] total number of MicroAlgos in the account
Defined in¶
amount-without-pending-rewards¶
• amount-without-pending-rewards: number
specifies the amount of MicroAlgos in the account, without the pending rewards.
Defined in¶
apps-local-state¶
• Optional apps-local-state: AppLocalState[]
[appl] applications local data stored in this account.
Note the raw object uses map[int] -> AppLocalState for this type.
Defined in¶
apps-total-extra-pages¶
• Optional apps-total-extra-pages: number
[teap] the sum of all extra application program pages for this account.
Defined in¶
apps-total-schema¶
• Optional apps-total-schema: StateSchema
[tsch] stores the sum of all of the local schemas and global schemas in this account.
Note: the raw account uses StateSchema for this type.
Defined in¶
assets¶
• Optional assets: AssetHolding[]
[asset] assets held by this account.
Note the raw object uses map[int] -> AssetHolding for this type.
Defined in¶
auth-addr¶
• Optional auth-addr: string
[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.
Defined in¶
closed-at-round¶
• Optional closed-at-round: number
Round during which this account was most recently closed.
Defined in¶
created-apps¶
• Optional created-apps: ApplicationResult[]
[appp] parameters of applications created by this account including app global data.
Note: the raw account uses map[int] -> AppParams for this type.
Defined in¶
created-assets¶
• Optional created-assets: AssetResult[]
[apar] parameters of assets created by this account.
Note: the raw account uses map[int] -> Asset for this type.
Defined in¶
created-at-round¶
• Optional created-at-round: number
Round during which this account first appeared in a transaction.
Defined in¶
deleted¶
• Optional deleted: boolean
Whether or not this account is currently closed.
Defined in¶
participation¶
• Optional participation: AccountParticipation
If participating in consensus, the parameters used by this account in the consensus protocol.
Defined in¶
pending-rewards¶
• pending-rewards: number
amount of MicroAlgos of pending rewards in this account.
Defined in¶
reward-base¶
• Optional reward-base: number
[ebase] used as part of the rewards computation. Only applicable to accounts which are participating.
Defined in¶
rewards¶
• rewards: number
[ern] total rewards of MicroAlgos the account has received, including pending rewards.
Defined in¶
round¶
• round: number
The round for which this information is relevant.
Defined in¶
sig-type¶
• sig-type: SignatureType
Indicates what type of signature is used by this account
Defined in¶
status¶
• status: AccountStatus
[onl] delegation status of the account's MicroAlgos
Defined in¶
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.
Defined in¶
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.
Defined in¶
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.
Defined in¶
total-boxes¶
• total-boxes: number
For app-accounts only. The total number of boxes which belong to the associated application.
Defined in¶
total-created-apps¶
• total-created-apps: number
The count of all apps (AppParams objects) created by this account.
Defined in¶
total-created-assets¶
• total-created-assets: number
The count of all assets (AssetParams objects) created by this account.