searchForAccounts
GET /v2/accounts
Search for accounts.
Parameters
Query Parameters
Asset ID
Maximum number of results to return. There could be additional pages even if the limit is not reached.
The next page of results. Use the next token provided by the previous results.
Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
Exclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account.
Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used.
Include accounts configured to use this spending key.
Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations. Using application-id or asset-id filters will return both creator and opt-in accounts. Filtering by include-all will return creator and opt-in accounts for deleted assets and accounts. Non-opt-in managers are not included in the results when asset-id is used.
Application ID
Responses
200
(empty)
object
Account information at a given round.
Definition: data/basics/userBalance.go : AccountData
object
The account public key
Total number of MicroAlgos in the account
Specifies the amount of MicroAlgos in the account, without the pending rewards.
Application local data stored in this account.
Note the raw object uses map[int] -> AppLocalState for this type.
Stores local state associated with an application.
object
Round when account closed out of the application.
Whether or not the application local state is currently deleted from its account.
The application which this local state is for.
Represents a key-value store for use in an application.
Represents a key-value pair in an application store.
object
Represents a TEAL value.
object
Bytes value.
Type of the value. Value 1 refers to bytes, value 2 refers to uint
Uint value.
Round when the account opted into the application.
Specifies maximums on the number of each type that may be stored.
object
Number of byte slices.
Number of uints.
The sum of all extra application program pages for this account.
Specifies maximums on the number of each type that may be stored.
object
Number of byte slices.
Number of uints.
Assets held by this account.
Note the raw object uses map[int] -> AssetHolding for this type.
Describes an asset held by an account.
Definition: data/basics/userBalance.go : AssetHolding
object
Number of units held.
Asset ID of the holding.
Whether or not the asset holding is currently deleted from its account.
Whether or not the holding is frozen.
Round during which the account opted into this asset holding.
Round during which the account opted out of this asset holding.
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.
Round during which this account was most recently closed.
Parameters of applications created by this account including app global data.
Note: the raw account uses map[int] -> AppParams for this type.
Application index and its parameters
object
Round when this application was created.
Whether or not this application is currently deleted.
Round when this application was deleted.
Application index.
Stores the global information associated with an application.
object
Approval program.
Clear state program.
The address that created this application. This is the address where the parameters and global state for this application can be found.
The number of extra program pages available to this app.
Represents a key-value store for use in an application.
Represents a key-value pair in an application store.
object
Represents a TEAL value.
object
Bytes value.
Type of the value. Value 1 refers to bytes, value 2 refers to uint
Uint value.
Specifies maximums on the number of each type that may be stored.
object
Number of byte slices.
Number of uints.
Specifies maximums on the number of each type that may be stored.
object
Number of byte slices.
Number of uints.
Parameters of assets created by this account.
Note: the raw account uses map[int] -> Asset for this type.
Specifies both the unique identifier and the parameters for an asset
object
Round during which this asset was created.
Whether or not this asset is currently deleted.
Round during which this asset was destroyed.
Unique asset identifier
AssetParams specifies the parameters for an asset.
[apar] when part of an AssetConfig transaction.
Definition: data/transactions/asset.go : AssetParams
object
Address of account used to clawback holdings of this asset. If empty, clawback is not permitted.
The address that created this asset. This is the address where the parameters for this asset can be found, and also the address where unwanted asset units can be sent in the worst case.
The number of digits to use after the decimal point when displaying this asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths. If 2, the base unit of the asset is in hundredths, and so on. This value must be between 0 and 19 (inclusive).
Whether holdings of this asset are frozen by default.
Address of account used to freeze holdings of this asset. If empty, freezing is not permitted.
Address of account used to manage the keys of this asset and to destroy it.
A commitment to some unspecified asset metadata. The format of this metadata is up to the application.
Name of this asset, as supplied by the creator. Included only when the asset name is composed of printable utf-8 characters.
Base64 encoded name of this asset, as supplied by the creator.
Address of account holding reserve (non-minted) units of this asset.
The total number of units of this asset.
Name of a unit of this asset, as supplied by the creator. Included only when the name of a unit of this asset is composed of printable utf-8 characters.
Base64 encoded name of a unit of this asset, as supplied by the creator.
URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters.
Base64 encoded URL where more information about the asset can be retrieved.
Round during which this account first appeared in a transaction.
Whether or not this account is currently closed.
Can the account receive block incentives if its balance is in range at proposal time.
The round in which this account last went online, or explicitly renewed their online status.
The round in which this account last proposed the block.
MicroAlgo balance required by the account.
The requirement grows based on asset and application usage.
AccountParticipation describes the parameters used by this account in consensus protocol.
object
Selection public key (if any) currently registered for this round.
Root of the state proof key (if any)
First round for which this participation is valid.
Number of subkeys in each batch of participation keys.
Last round for which this participation is valid.
Root participation public key (if any) currently registered for this round.
Amount of MicroAlgos of pending rewards in this account.
Used as part of the rewards computation. Only applicable to accounts which are participating.
Total rewards of MicroAlgos the account has received, including pending rewards.
The round for which this information is relevant.
The type of signature used by this account, must be one of:
- sig
- msig
- lsig
- or null if unknown
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.
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 assets that have been opted in, equivalent to the count of AssetHolding objects held by this account.
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 boxes which belong to the associated application.
The count of all apps (AppParams objects) created by this account.
The count of all assets (AssetParams objects) created by this account.
Round at which the results were computed.
Used for pagination, when making another request provide this token with the next parameter.
400
Response for errors
object
object
500
Response for errors