1 of 1

Get Accounts

Returns a list of all account entity items on the network.

This method will use 15 Compute Units.

Get Accounts

Returns a list of all account entity items on the network.

This method will use 15 Compute Units.

List account entities on network

Returns a list of all account entity items on the network.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts

Query parameters

account.balancestring

The optional balance value to compare against

Pattern: ^((gte?|lte?|eq|ne)\:)?\d{1,10}$

account.idEntityIdQuery (string)

The ID of the account to return information for

Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

account.publickeystring

The account's public key to compare against

Example: "3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be"

balanceboolean

Whether to include balance information or not. If included, token balances are limited to at most 50 per account as outlined in HIP-367.

Example: true

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "desc"

ascdesc

Response

Body

accounts*Accounts (array of AccountInfo (object))

account*nullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

alias*nullable Alias (string)

RFC4648 no-padding base32 encoded account alias

Example: "HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"

Pattern: ^(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8})$

auto_renew_period*nullable integer (int64)

balance*nullable Balance (object)

timestamp*nullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

balance*nullable integer (int64)

tokens*array of object

token_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

balanceinteger (int64)

created_timestamp*nullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

decline_reward*boolean

Whether the account declines receiving a staking reward

deleted*nullable boolean

ethereum_nonce*nullable integer (int64)

evm_address*nullable EvmAddressNullable (string (binary))

A network entity encoded as an EVM address in hex.

Example: "0x0000000000000000000000000000000000001f41"

Pattern: ^(0x)?[A-Fa-f0-9]{40}$

expiry_timestamp*nullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

key*nullable Key (object)

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: 10101

max_automatic_token_associations*nullable integer (int32)

memo*nullable string

pending_rewardinteger (int64)

The pending reward in tinybars the account will receive in the next reward payout. Note the value is updated at the end of each staking period and there may be delay to reflect the changes in the past staking period.

receiver_sig_required*nullable boolean

staked_account_id*all of

nullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

any

The account to which this account is staking

staked_node_id*nullable integer (int64)

The id of the node to which this account is staking

stake_period_start*all of

nullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

any

The staking period during which either the staking settings for this account changed (such as starting staking or changing stakedNode) or the most recent reward was earned, whichever is later. If this account is not currently staked to a node, then the value is null

links*Links (object)

nextnullable string

Example: "/api/v1/transactions?timestamp=lt:1657598275.517984411"

Request

Response

List account entities on network

Returns a list of all account entity items on the network.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts

Query parameters

account.balancestring

The optional balance value to compare against

Pattern: ^((gte?|lte?|eq|ne)\:)?\d{1,10}$

account.idEntityIdQuery (string)

The ID of the account to return information for

Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

account.publickeystring

The account's public key to compare against

Example: "3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be"

balanceboolean

Whether to include balance information or not. If included, token balances are limited to at most 50 per account as outlined in HIP-367.

Example: true

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "desc"

ascdesc

Response

Body

accounts*Accounts (array of AccountInfo (object))

account*nullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

alias*nullable Alias (string)

RFC4648 no-padding base32 encoded account alias

Example: "HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"

Pattern: ^(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8})$

auto_renew_period*nullable integer (int64)

balance*nullable Balance (object)

timestamp*nullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

balance*nullable integer (int64)

tokens*array of object

token_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

balanceinteger (int64)

created_timestamp*nullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

decline_reward*boolean

Whether the account declines receiving a staking reward

deleted*nullable boolean

ethereum_nonce*nullable integer (int64)

evm_address*nullable EvmAddressNullable (string (binary))

A network entity encoded as an EVM address in hex.

Example: "0x0000000000000000000000000000000000001f41"

Pattern: ^(0x)?[A-Fa-f0-9]{40}$

expiry_timestamp*nullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

key*nullable Key (object)

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: 10101

max_automatic_token_associations*nullable integer (int32)

memo*nullable string

pending_rewardinteger (int64)

receiver_sig_required*nullable boolean

staked_account_id*all of

nullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

any

The account to which this account is staking

staked_node_id*nullable integer (int64)

The id of the node to which this account is staking

stake_period_start*all of

nullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

any

links*Links (object)

nextnullable string

Example: "/api/v1/transactions?timestamp=lt:1657598275.517984411"

Request

Response

const response = await fetch('https://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "accounts": [
    {
      "account": "0.0.8",
      "alias": "HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA",
      "auto_renew_period": null,
      "balance": {
        "timestamp": "0.000002345",
        "balance": 80,
        "tokens": [
          {
            "token_id": "0.0.200001",
            "balance": 8
          }
        ]
      },
      "created_timestamp": "1562591528.000123456",
      "decline_reward": false,
      "deleted": false,
      "ethereum_nonce": 10,
      "evm_address": "0xac384c53f03855fa1b3616052f8ba32c6c2a2fec",
      "expiry_timestamp": null,
      "key": null,
      "max_automatic_token_associations": 200,
      "memo": "entity memo",
      "pending_reward": 100,
      "receiver_sig_required": false,
      "staked_account_id": null,
      "staked_node_id": 3,
      "stake_period_start": "172800000.000000000"
    }
  ],
  "links": {
    "next": "/api/v1/transactions?timestamp=lt:1657598275.517984411"
  }
}