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

Get account information about a given app.

GET
/v2/accounts/{address}/applications/{application-id}

Given a specific account public key and application ID, this call returns the account’s application local state and global state (AppLocalState and AppParams, if either exists). Global state will only be returned if the provided address is the application’s creator.

Authorizations

Parameters

Path Parameters

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

An account public key

application-id
required
integer

An application identifier

Query Parameters

format
string
Allowed values: json msgpack

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

Responses

200

AccountApplicationResponse describes the account’s application local state and global state (AppLocalState and AppParams, if either exists) for a specific application ID. Global state will only be returned if the provided address is the application’s creator.

object
app-local-state

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
created-app

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
round
required

The round for which this information is relevant.

integer

400

Malformed address or application ID

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