$Account

const $Account: object

Type declaration

description

readonly description: “Account information at a given round.\n\nDefinition:\ndata/basics/userBalance.go : AccountData\n”

properties

readonly properties: object

properties.address

readonly properties.address: object

properties.address.description

readonly properties.address.description: "the account public key" = 'the account public key'

properties.address.type

readonly properties.address.type: "string" = 'string'

properties.amount

readonly properties.amount: object

properties.amount.description

readonly properties.amount.description: "total number of MicroAlgos in the account" = 'total number of MicroAlgos in the account'

properties.amount.type

readonly properties.amount.type: "integer" = 'integer'

properties.amount-without-pending-rewards

readonly properties.amount-without-pending-rewards: object

properties.amount-without-pending-rewards.description

readonly properties.amount-without-pending-rewards.description: "specifies the amount of MicroAlgos in the account, without the pending rewards." = 'specifies the amount of MicroAlgos in the account, without the pending rewards.'

properties.amount-without-pending-rewards.type

readonly properties.amount-without-pending-rewards.type: "integer" = 'integer'

properties.apps-local-state

readonly properties.apps-local-state: object

properties.apps-local-state.description

readonly properties.apps-local-state.description: “application local data stored in this account.\n\nNote the raw object uses `map[int] -> AppLocalState` for this type.”

properties.apps-local-state.items

readonly properties.apps-local-state.items: object

properties.apps-local-state.items.$ref

readonly properties.apps-local-state.items.$ref: "#/components/schemas/ApplicationLocalState" = '#/components/schemas/ApplicationLocalState'

properties.apps-local-state.type

readonly properties.apps-local-state.type: "array" = 'array'

properties.apps-total-extra-pages

readonly properties.apps-total-extra-pages: object

properties.apps-total-extra-pages.description

readonly properties.apps-total-extra-pages.description: "the sum of all extra application program pages for this account." = 'the sum of all extra application program pages for this account.'

properties.apps-total-extra-pages.type

readonly properties.apps-total-extra-pages.type: "integer" = 'integer'

properties.apps-total-schema

readonly properties.apps-total-schema: object

properties.apps-total-schema.$ref

readonly properties.apps-total-schema.$ref: "#/components/schemas/ApplicationStateSchema" = '#/components/schemas/ApplicationStateSchema'

properties.assets

readonly properties.assets: object

properties.assets.description

readonly properties.assets.description: “assets held by this account.\n\nNote the raw object uses `map[int] -> AssetHolding` for this type.”

properties.assets.items

readonly properties.assets.items: object

properties.assets.items.$ref

readonly properties.assets.items.$ref: "#/components/schemas/AssetHolding" = '#/components/schemas/AssetHolding'

properties.assets.type

readonly properties.assets.type: "array" = 'array'

properties.auth-addr

readonly properties.auth-addr: object

properties.auth-addr.description

readonly properties.auth-addr.description: "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." = '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.'

properties.auth-addr.type

readonly properties.auth-addr.type: "string" = 'string'

properties.auth-addr.x-algorand-format

readonly properties.auth-addr.x-algorand-format: "Address" = 'Address'

properties.closed-at-round

readonly properties.closed-at-round: object

properties.closed-at-round.description

readonly properties.closed-at-round.description: "Round during which this account was most recently closed." = 'Round during which this account was most recently closed.'

properties.closed-at-round.type

readonly properties.closed-at-round.type: "integer" = 'integer'

properties.closed-at-round.x-algorand-format

readonly properties.closed-at-round.x-algorand-format: "uint64" = 'uint64'

properties.created-apps

readonly properties.created-apps: object

properties.created-apps.description

readonly properties.created-apps.description: “parameters of applications created by this account including app global data.\n\nNote: the raw account uses `map[int] -> AppParams` for this type.”

properties.created-apps.items

readonly properties.created-apps.items: object

properties.created-apps.items.$ref

readonly properties.created-apps.items.$ref: "#/components/schemas/Application" = '#/components/schemas/Application'

properties.created-apps.type

readonly properties.created-apps.type: "array" = 'array'

properties.created-assets

readonly properties.created-assets: object

properties.created-assets.description

readonly properties.created-assets.description: “parameters of assets created by this account.\n\nNote: the raw account uses `map[int] -> Asset` for this type.”

properties.created-assets.items

readonly properties.created-assets.items: object

properties.created-assets.items.$ref

readonly properties.created-assets.items.$ref: "#/components/schemas/Asset" = '#/components/schemas/Asset'

properties.created-assets.type

readonly properties.created-assets.type: "array" = 'array'

properties.created-at-round

readonly properties.created-at-round: object

properties.created-at-round.description

readonly properties.created-at-round.description: "Round during which this account first appeared in a transaction." = 'Round during which this account first appeared in a transaction.'

properties.created-at-round.type

readonly properties.created-at-round.type: "integer" = 'integer'

properties.created-at-round.x-algorand-format

readonly properties.created-at-round.x-algorand-format: "uint64" = 'uint64'

properties.deleted

readonly properties.deleted: object

properties.deleted.description

readonly properties.deleted.description: "Whether or not this account is currently closed." = 'Whether or not this account is currently closed.'

properties.deleted.type

readonly properties.deleted.type: "boolean" = 'boolean'

properties.incentive-eligible

readonly properties.incentive-eligible: object

properties.incentive-eligible.description

readonly properties.incentive-eligible.description: "can the account receive block incentives if its balance is in range at proposal time." = 'can the account receive block incentives if its balance is in range at proposal time.'

properties.incentive-eligible.type

readonly properties.incentive-eligible.type: "boolean" = 'boolean'

properties.last-heartbeat

readonly properties.last-heartbeat: object

properties.last-heartbeat.description

readonly properties.last-heartbeat.description: "The round in which this account last went online, or explicitly renewed their online status." = 'The round in which this account last went online, or explicitly renewed their online status.'

properties.last-heartbeat.type

readonly properties.last-heartbeat.type: "integer" = 'integer'

properties.last-proposed

readonly properties.last-proposed: object

properties.last-proposed.description

readonly properties.last-proposed.description: "The round in which this account last proposed the block." = 'The round in which this account last proposed the block.'

properties.last-proposed.type

readonly properties.last-proposed.type: "integer" = 'integer'

properties.min-balance

readonly properties.min-balance: object

properties.min-balance.description

readonly properties.min-balance.description: “MicroAlgo balance required by the account.\n\nThe requirement grows based on asset and application usage.”

properties.min-balance.type

readonly properties.min-balance.type: "integer" = 'integer'

properties.participation

readonly properties.participation: object

properties.participation.$ref

readonly properties.participation.$ref: "#/components/schemas/AccountParticipation" = '#/components/schemas/AccountParticipation'

properties.pending-rewards

readonly properties.pending-rewards: object

properties.pending-rewards.description

readonly properties.pending-rewards.description: "amount of MicroAlgos of pending rewards in this account." = 'amount of MicroAlgos of pending rewards in this account.'

properties.pending-rewards.type

readonly properties.pending-rewards.type: "integer" = 'integer'

properties.reward-base

readonly properties.reward-base: object

properties.reward-base.description

readonly properties.reward-base.description: "used as part of the rewards computation. Only applicable to accounts which are participating." = 'used as part of the rewards computation. Only applicable to accounts which are participating.'

properties.reward-base.type

readonly properties.reward-base.type: "integer" = 'integer'

properties.rewards

readonly properties.rewards: object

properties.rewards.description

readonly properties.rewards.description: "total rewards of MicroAlgos the account has received, including pending rewards." = 'total rewards of MicroAlgos the account has received, including pending rewards.'

properties.rewards.type

readonly properties.rewards.type: "integer" = 'integer'

properties.round

readonly properties.round: object

properties.round.description

readonly properties.round.description: "The round for which this information is relevant." = 'The round for which this information is relevant.'

properties.round.type

readonly properties.round.type: "integer" = 'integer'

properties.sig-type

readonly properties.sig-type: object

properties.sig-type.description

readonly properties.sig-type.description: “the type of signature used by this account, must be one of:\n* sig\n* msig\n* lsig\n* or null if unknown”

properties.sig-type.enum

readonly properties.sig-type.enum: readonly ["sig", "msig", "lsig"]

properties.sig-type.type

readonly properties.sig-type.type: "string" = 'string'

properties.status

readonly properties.status: object

properties.status.description

readonly properties.status.description: “voting status of the account’s MicroAlgos\n* Offline - indicates that the associated account is delegated.\n* Online - indicates that the associated account used as part of the delegation pool.\n* NotParticipating - indicates that the associated account is neither a delegator nor a delegate.”

properties.status.type

readonly properties.status.type: "string" = 'string'

properties.total-apps-opted-in

readonly properties.total-apps-opted-in: object

properties.total-apps-opted-in.description

readonly properties.total-apps-opted-in.description: "The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account." = 'The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account.'

properties.total-apps-opted-in.type

readonly properties.total-apps-opted-in.type: "integer" = 'integer'

properties.total-assets-opted-in

readonly properties.total-assets-opted-in: object

properties.total-assets-opted-in.description

readonly properties.total-assets-opted-in.description: "The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account." = 'The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account.'

properties.total-assets-opted-in.type

readonly properties.total-assets-opted-in.type: "integer" = 'integer'

properties.total-box-bytes

readonly properties.total-box-bytes: object

properties.total-box-bytes.description

readonly properties.total-box-bytes.description: "For app-accounts only. The total number of bytes allocated for the keys and values of boxes which belong to the associated application." = 'For app-accounts only. The total number of bytes allocated for the keys and values of boxes which belong to the associated application.'

properties.total-box-bytes.type

readonly properties.total-box-bytes.type: "integer" = 'integer'

properties.total-boxes

readonly properties.total-boxes: object

properties.total-boxes.description

readonly properties.total-boxes.description: "For app-accounts only. The total number of boxes which belong to the associated application." = 'For app-accounts only. The total number of boxes which belong to the associated application.'

properties.total-boxes.type

readonly properties.total-boxes.type: "integer" = 'integer'

properties.total-created-apps

readonly properties.total-created-apps: object

properties.total-created-apps.description

readonly properties.total-created-apps.description: "The count of all apps (AppParams objects) created by this account." = 'The count of all apps (AppParams objects) created by this account.'

properties.total-created-apps.type

readonly properties.total-created-apps.type: "integer" = 'integer'

properties.total-created-assets

readonly properties.total-created-assets: object

properties.total-created-assets.description

readonly properties.total-created-assets.description: "The count of all assets (AssetParams objects) created by this account." = 'The count of all assets (AssetParams objects) created by this account.'

properties.total-created-assets.type

readonly properties.total-created-assets.type: "integer" = 'integer'

required

readonly required: readonly ["address", "amount", "amount-without-pending-rewards", "min-balance", "pending-rewards", "rewards", "round", "status", "total-apps-opted-in", "total-assets-opted-in", "total-box-bytes", "total-boxes", "total-created-apps", "total-created-assets"]

type

readonly type: "object" = 'object'

Defined in

schemas.gen.ts:3