Skip to main content
GET
/
v1
/
accounts
/
{address.value}
Error
A valid request URL is required to generate request examples
{
  "address": {
    "value": "aSDinaTvuI8gbWludGxpZnk="
  },
  "meta": {
    "version": 123,
    "flags": {
      "isProgram": true,
      "isPrivileged": true,
      "isUncompressable": true,
      "isEphemeral": true,
      "isDeleted": true,
      "isNew": true,
      "isCompressed": true
    },
    "dataSize": 123,
    "seq": "<string>",
    "owner": {
      "value": "aSDinaTvuI8gbWludGxpZnk="
    },
    "balance": "<string>",
    "nonce": "<string>"
  },
  "data": {
    "data": "aSDinaTvuI8gbWludGxpZnk=",
    "compressed": true,
    "compressionAlgorithm": "<string>"
  },
  "versionContext": {
    "slot": "<string>",
    "blockTimestamp": "2023-11-07T05:31:56Z"
  },
  "consensusStatus": "CONSENSUS_STATUS_UNSPECIFIED"
}

Path Parameters

​
address.value
string<byte>
required

32-byte public key buffer.

Query Parameters

​
view
enum<string>
default:ACCOUNT_VIEW_UNSPECIFIED
  • ACCOUNT_VIEW_UNSPECIFIED: ACCOUNT_VIEW_UNSPECIFIED uses service defaults.
  • ACCOUNT_VIEW_PUBKEY_ONLY: ACCOUNT_VIEW_PUBKEY_ONLY returns only the account address.
  • ACCOUNT_VIEW_META_ONLY: ACCOUNT_VIEW_META_ONLY returns only account metadata.
  • ACCOUNT_VIEW_DATA_ONLY: ACCOUNT_VIEW_DATA_ONLY returns only account data.
  • ACCOUNT_VIEW_FULL: ACCOUNT_VIEW_FULL returns address, metadata, and data.
Available options:
ACCOUNT_VIEW_UNSPECIFIED,
ACCOUNT_VIEW_PUBKEY_ONLY,
ACCOUNT_VIEW_META_ONLY,
ACCOUNT_VIEW_DATA_ONLY,
ACCOUNT_VIEW_FULL
​
versionContext.slot
string<uint64>

Request the version for a specific slot number.

​
versionContext.timestamp
string<date-time>

Request the version nearest to the provided block timestamp.

​
versionContext.seq
string<uint64>

Request the version for a specific seq number. Relevant only for GetAccount and GetRawAccount requests.

​
minConsensus
enum<string>
default:CONSENSUS_STATUS_UNSPECIFIED
  • CONSENSUS_STATUS_UNSPECIFIED: CONSENSUS_STATUS_UNSPECIFIED indicates the consensus status is unknown.
  • CONSENSUS_STATUS_OBSERVED: CONSENSUS_STATUS_OBSERVED indicates the resource has been observed but not yet confirmed in a finalized block.
  • CONSENSUS_STATUS_INCLUDED: CONSENSUS_STATUS_INCLUDED indicates the resource has been included in the ledger but may not be finalized.
  • CONSENSUS_STATUS_FINALIZED: CONSENSUS_STATUS_FINALIZED indicates the resource is finalized for a slot.
  • CONSENSUS_STATUS_LOCALLY_EXECUTED: CONSENSUS_STATUS_LOCALLY_EXECUTED indicates the local node executed the resource but broader cluster finality may not have been achieved.
  • CONSENSUS_STATUS_CLUSTER_EXECUTED: CONSENSUS_STATUS_CLUSTER_EXECUTED indicates the entire cluster has executed and agreed on the resource.
Available options:
CONSENSUS_STATUS_UNSPECIFIED,
CONSENSUS_STATUS_OBSERVED,
CONSENSUS_STATUS_INCLUDED,
CONSENSUS_STATUS_FINALIZED,
CONSENSUS_STATUS_LOCALLY_EXECUTED,
CONSENSUS_STATUS_CLUSTER_EXECUTED
​
dataSlice.offset
integer<int64>
required
​
dataSlice.length
integer<int64>
required

Response

A successful response.

Account models a fully decoded account resource.

​
address
object
required

Pubkey represents a 32-byte public key value.

​
meta
object

AccountMeta captures metadata associated with an account.

​
data
object

AccountData contains account data payloads.

​
versionContext
object

VersionContextMetadata captures context for a returned account state.

​
consensusStatus
enum<string>
default:CONSENSUS_STATUS_UNSPECIFIED

ConsensusStatus represents the minimum consensus level a resource has achieved when returned by the service.

  • CONSENSUS_STATUS_UNSPECIFIED: CONSENSUS_STATUS_UNSPECIFIED indicates the consensus status is unknown.
  • CONSENSUS_STATUS_OBSERVED: CONSENSUS_STATUS_OBSERVED indicates the resource has been observed but not yet confirmed in a finalized block.
  • CONSENSUS_STATUS_INCLUDED: CONSENSUS_STATUS_INCLUDED indicates the resource has been included in the ledger but may not be finalized.
  • CONSENSUS_STATUS_FINALIZED: CONSENSUS_STATUS_FINALIZED indicates the resource is finalized for a slot.
  • CONSENSUS_STATUS_LOCALLY_EXECUTED: CONSENSUS_STATUS_LOCALLY_EXECUTED indicates the local node executed the resource but broader cluster finality may not have been achieved.
  • CONSENSUS_STATUS_CLUSTER_EXECUTED: CONSENSUS_STATUS_CLUSTER_EXECUTED indicates the entire cluster has executed and agreed on the resource.
Available options:
CONSENSUS_STATUS_UNSPECIFIED,
CONSENSUS_STATUS_OBSERVED,
CONSENSUS_STATUS_INCLUDED,
CONSENSUS_STATUS_FINALIZED,
CONSENSUS_STATUS_LOCALLY_EXECUTED,
CONSENSUS_STATUS_CLUSTER_EXECUTED