Skip to content
Algorand Developer Portal Algorand Developer Portal Algorand Developer Portal
This new developer portal is under construction. For complete documentation, please refer to the old developer portal.

Get account information.

GET
/v2/accounts/{address}

Given a specific account public key, this call returns the account’s status, balance and spendable amounts

Authorizations

Parameters

Path Parameters

address
required
string
/[A-Z0-9]{58}/

An account public key

Query Parameters

format
string
Allowed values: json msgpack

Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON.

exclude
string
Allowed values: all none

When set to all will exclude asset holdings, application local state, created asset parameters, any created application parameters. Defaults to none.

Responses

200

AccountResponse wraps the Account type in a response.

Account information at a given round.

Definition: data/basics/userBalance.go : AccountData

object
address
required

The account public key

string
amount
required

[algo] total number of MicroAlgos in the account

integer
amount-without-pending-rewards
required

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

integer
apps-local-state

[appl] applications local data stored in this account.

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

Array<object>

Stores local state associated with an application.

object
id
required

The application which this local state is for.

integer
key-value

Represents a key-value store for use in an application.

Array<object>

Represents a key-value pair in an application store.

object
key
required
string
value
required

Represents a TEAL value.

object
bytes
required

[tb] bytes value.

string
type
required

[tt] value type. Value 1 refers to bytes, value 2 refers to uint

integer
uint
required

[ui] uint value.

integer
schema
required

Specifies maximums on the number of each type that may be stored.

object
num-byte-slice
required

[nbs] num of byte slices.

integer
num-uint
required

[nui] num of uints.

integer
apps-total-extra-pages

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

integer
apps-total-schema

Specifies maximums on the number of each type that may be stored.

object
num-byte-slice
required

[nbs] num of byte slices.

integer
num-uint
required

[nui] num of uints.

integer
assets

[asset] assets held by this account.

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

Array<object>

Describes an asset held by an account.

Definition: data/basics/userBalance.go : AssetHolding

object
amount
required

[a] number of units held.

integer
asset-id
required

Asset ID of the holding.

integer
is-frozen
required

[f] whether or not the holding is frozen.

boolean
auth-addr

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

string
created-apps

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

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

Array<object>

Application index and its parameters

object
id
required

[appidx] application index.

integer
params
required

Stores the global information associated with an application.

object
approval-program
required

[approv] approval program.

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
clear-state-program
required

[clearp] approval program.

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
creator
required

The address that created this application. This is the address where the parameters and global state for this application can be found.

string
extra-program-pages

[epp] the amount of extra program pages available to this app.

integer
global-state

Represents a key-value store for use in an application.

Array<object>

Represents a key-value pair in an application store.

object
key
required
string
value
required

Represents a TEAL value.

object
bytes
required

[tb] bytes value.

string
type
required

[tt] value type. Value 1 refers to bytes, value 2 refers to uint

integer
uint
required

[ui] uint value.

integer
global-state-schema

Specifies maximums on the number of each type that may be stored.

object
num-byte-slice
required

[nbs] num of byte slices.

integer
num-uint
required

[nui] num of uints.

integer
local-state-schema

Specifies maximums on the number of each type that may be stored.

object
num-byte-slice
required

[nbs] num of byte slices.

integer
num-uint
required

[nui] num of uints.

integer
created-assets

[apar] parameters of assets created by this account.

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

Array<object>

Specifies both the unique identifier and the parameters for an asset

object
index
required

Unique asset identifier

integer
params
required

AssetParams specifies the parameters for an asset.

[apar] when part of an AssetConfig transaction.

Definition: data/transactions/asset.go : AssetParams

object
clawback

[c] Address of account used to clawback holdings of this asset. If empty, clawback is not permitted.

string
creator
required

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.

string
decimals
required

[dc] 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).

integer
<= 19
default-frozen

[df] Whether holdings of this asset are frozen by default.

boolean
freeze

[f] Address of account used to freeze holdings of this asset. If empty, freezing is not permitted.

string
manager

[m] Address of account used to manage the keys of this asset and to destroy it.

string
metadata-hash

[am] A commitment to some unspecified asset metadata. The format of this metadata is up to the application.

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
name

[an] Name of this asset, as supplied by the creator. Included only when the asset name is composed of printable utf-8 characters.

string
name-b64

Base64 encoded name of this asset, as supplied by the creator.

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
reserve

[r] Address of account holding reserve (non-minted) units of this asset.

string
total
required

[t] The total number of units of this asset.

integer
unit-name

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

string
unit-name-b64

Base64 encoded name of a unit of this asset, as supplied by the creator.

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
url

[au] URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters.

string
url-b64

Base64 encoded URL where more information about the asset can be retrieved.

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
incentive-eligible

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

boolean
last-heartbeat

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

integer
last-proposed

The round in which this account last proposed the block.

integer
min-balance
required

MicroAlgo balance required by the account.

The requirement grows based on asset and application usage.

integer
participation

AccountParticipation describes the parameters used by this account in consensus protocol.

object
selection-participation-key
required

[sel] Selection public key (if any) currently registered for this round.

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
state-proof-key

[stprf] Root of the state proof key (if any)

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
vote-first-valid
required

[voteFst] First round for which this participation is valid.

integer
vote-key-dilution
required

[voteKD] Number of subkeys in each batch of participation keys.

integer
vote-last-valid
required

[voteLst] Last round for which this participation is valid.

integer
vote-participation-key
required

[vote] root participation public key (if any) currently registered for this round.

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
pending-rewards
required

Amount of MicroAlgos of pending rewards in this account.

integer
reward-base

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

integer
rewards
required

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

integer
round
required

The round for which this information is relevant.

integer
sig-type

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

  • sig
  • msig
  • lsig
string
Allowed values: sig msig lsig
status
required

[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.
string
total-apps-opted-in
required

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

integer
total-assets-opted-in
required

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

integer
total-box-bytes

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

integer
total-boxes

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

integer
total-created-apps
required

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

integer
total-created-assets
required

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

integer

400

Bad request

An error response with optional data field.

object
data
object
message
required
string

401

Invalid API Token

An error response with optional data field.

object
data
object
message
required
string

500

Internal Error

An error response with optional data field.

object
data
object
message
required
string

default

Unknown Error