1 of 8

Accounts

Get Accounts

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

This method will use 15 .

Get Accounts by ID

Return the account transactions and balance information given an account alias, an account id, or an evm address.

This method will use 15 Compute Units.

Get Allowances

Returns information for all crypto allowances for an account.

This method will use 15 Compute Units.

Get Token Allowances by Account

Returns information for fungible token allowances for an account.

This method will use 15 Compute Units.

Get NFTs by Account

Returns information for all non-fungible tokens for an account.

This method will use 15 Compute Units.

Get Rewards by Account

Returns information for all past staking reward payouts for an account.

This method will use 15 Compute Units.

Get Token Relationships by Account

Returns information for all token relationships for an account.

This method will use 15 Compute Units.

Get Token Allowances by Account

Returns information for fungible token allowances for an account.

This method will use 15 Compute Units.

Get fungible token allowances for an account

Returns information for fungible token allowances for an account.

Ordering

The order is governed by a combination of the spender id and the token id values, with spender id being the parent column. The token id value governs its order within the given spender id.

Note: The default order for this API is currently ASC

Filtering

When filtering there are some restrictions enforced to ensure correctness and scalability.

The table below defines the restrictions and support for the endpoint

Query Param	Comparison Operator	Support	Description	Example
spender.id	eq	Y	Single occurrence only.	?spender.id=X
	ne	N
	lt(e)	Y	Single occurrence only.	?spender.id=lte:X
	gt(e)	Y	Single occurrence only.	?spender.id=gte:X
token.id	eq	Y	Single occurrence only. Requires the presence of a spender.id query	?token.id=lt:Y
	ne	N
	lt(e)	Y	Single occurrence only. Requires the presence of an lte or eq spender.id query	?spender.id=lte:X&token.id=lt:Y
	gt(e)	Y	Single occurrence only. Requires the presence of an gte or eq spender.id query	?spender.id=gte:X&token.id=gt:Y

Both filters must be a single occurrence of gt(e) or lt(e) which provide a lower and or upper boundary for search.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/tokens

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "desc"

ascdesc

spender.idEntityIdQuery (string)

The ID of the spender to return information for

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

token.idEntityIdQuery (string)

The ID of the token to return information for

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

Response

Body

allowancesTokenAllowances (array of TokenAllowance (all of))

amount_grantedinteger (int64)

The granted amount of the spender's allowance.

Example: 100

ownernullable 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}$

spendernullable 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}$

timestampTimestampRange (object)

A timestamp range an entity is valid for

fromall of

Timestamp (string)

Example: "1586567700.453054000"

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

any

The inclusive from timestamp in seconds

toall of

nullable TimestampNullable (string)

Example: "1586567700.453054000"

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

any

The exclusive to timestamp in seconds

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}$

linksLinks (object)

nextnullable string

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

Request

Response

Get Allowances

Returns information for all crypto allowances for an account.

This method will use 15 Compute Units.

Get crypto allowances for an account info

Returns information for all crypto allowances for an account.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/crypto

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

spender.idEntityIdQuery (string)

The ID of the spender to return information for

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

Response

Body

allowancesCryptoAllowances (array of CryptoAllowance (all of))

amount_grantedinteger (int64)

The granted amount of the spender's allowance.

Example: 100

ownernullable 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}$

spendernullable 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}$

timestampTimestampRange (object)

A timestamp range an entity is valid for

fromall of

Timestamp (string)

Example: "1586567700.453054000"

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

any

The inclusive from timestamp in seconds

toall of

nullable TimestampNullable (string)

Example: "1586567700.453054000"

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

any

The exclusive to timestamp in seconds

amount_grantedany

The granted amount of the spender's allowance in tinybars.

linksLinks (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)

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.

GET/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. If multiple values are provided the last value will be the only value used.

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.0.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)

A Unix timestamp in seconds.nanoseconds format

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.0.2"

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

balanceinteger (int64)

created_timestamp*nullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

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)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

key*nullable Key (object)

The public key which controls access to various network entities.

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: "421050820e1485acdd59726088e0e4a2130ebbbb70009f640ad95c78dd5a7b38"

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.0.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)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

any

links*Links (object)

nextnullable string

Request

Response

Get account by alias, id, or evm address

Return the account transactions and balance information given an account alias, an account id, or an evm address. The information will be limited to at most 1000 token balances for the account as outlined in HIP-367. When the timestamp parameter is supplied, we will return transactions and account state for the relevant timestamp query. Balance information will be accurate to within 15 minutes of the provided timestamp query. Historical ethereum nonce information is currently not available and may not be the exact value at a provided timestamp.

GET/api/v1/accounts/{idOrAliasOrEvmAddress}

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.

itemsstring

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

transactiontypeTransactionTypes (enum)

Example: "cryptotransfer"

CONSENSUSCREATETOPICCONSENSUSDELETETOPICCONSENSUSSUBMITMESSAGECONSENSUSUPDATETOPICCONTRACTCALLCONTRACTCREATEINSTANCECONTRACTDELETEINSTANCECONTRACTUPDATEINSTANCECRYPTOADDLIVEHASHCRYPTOAPPROVEALLOWANCECRYPTOCREATEACCOUNTCRYPTODELETECRYPTODELETEALLOWANCECRYPTODELETELIVEHASHCRYPTOTRANSFERCRYPTOUPDATEACCOUNTETHEREUMTRANSACTIONFILEAPPENDFILECREATEFILEDELETEFILEUPDATEFREEZENODECREATENODEDELETENODESTAKEUPDATENODEUPDATESCHEDULECREATESCHEDULEDELETESCHEDULESIGNSYSTEMDELETESYSTEMUNDELETETOKENAIRDROPTOKENASSOCIATETOKENBURNTOKENCANCELAIRDROPTOKENCLAIMAIRDROPTOKENCREATIONTOKENDELETIONTOKENDISSOCIATETOKENFEESCHEDULEUPDATETOKENFREEZETOKENGRANTKYCTOKENMINTTOKENPAUSETOKENREJECTTOKENREVOKEKYCTOKENUNFREEZETOKENUNPAUSETOKENUPDATETOKENUPDATENFTSTOKENWIPEUNCHECKEDSUBMITUNKNOWNUTILPRNG

transactionsboolean

If provided and set to false transactions will not be included in the response

Example: true

Response

Body

account*nullable EntityId (string)

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

Example: "0.0.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)

A Unix timestamp in seconds.nanoseconds format

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.0.2"

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

balanceinteger (int64)

created_timestamp*nullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

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)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

key*nullable Key (object)

The public key which controls access to various network entities.

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: "421050820e1485acdd59726088e0e4a2130ebbbb70009f640ad95c78dd5a7b38"

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.0.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)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

any

transactions*Transactions (array of Transaction (object))

bytesnullable string (byte)

charged_tx_feeinteger (int64)

consensus_timestampTimestamp (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

entity_idnullable EntityId (string)

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

Example: "0.0.2"

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

max_feestring

memo_base64nullable string (byte)

nameTransactionTypes (enum)

nft_transfersarray of object

is_approval*boolean

receiver_account_id*nullable EntityId (string)

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

Example: "0.0.2"

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

sender_account_id*nullable EntityId (string)

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

Example: "0.0.2"

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

serial_number*integer (int64)

Example: 1

token_id*nullable EntityId (string)

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

Example: "0.0.2"

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

nodenullable EntityId (string)

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

Example: "0.0.2"

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

nonceinteger

parent_consensus_timestampnullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

resultstring

scheduledboolean

staking_reward_transfersStakingRewardTransfers (array of StakingRewardTransfer (object))

account*nullable EntityId (string)

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

Example: "0.0.2"

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

amount*integer (int64)

The number of tinybars awarded

Example: 10

token_transfersarray of object

token_id*nullable EntityId (string)

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

Example: "0.0.2"

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

account*nullable EntityId (string)

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

Example: "0.0.2"

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

amount*integer (int64)

is_approvalboolean

transaction_hashstring (byte)

transaction_idstring

transfersarray of object

account*nullable EntityId (string)

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

Example: "0.0.2"

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

amount*integer (int64)

is_approvalboolean

valid_duration_secondsstring

valid_start_timestampTimestamp (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

links*Links (object)

nextnullable string

Request

Response

Get nfts for an account info

Returns information for all non-fungible tokens for an account.

Ordering

When considering NFTs, their order is governed by a combination of their numerical token.Id and serialnumber values, with token.id being the parent column. A serialnumbers value governs its order within the given token.id

In that regard, if a user acquired a set of NFTs in the order (2-2, 2-4 1-5, 1-1, 1-3, 3-3, 3-4), the following layouts illustrate the ordering expectations for ownership listing

All NFTs in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
All NFTs in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3, 1-1
NFTs above 1-1 in ASC order: 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
NFTs below 3-3 in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4
NFTs between 1-3 and 3-3 inclusive in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3

Note: The default order for this API is currently DESC

Filtering

When filtering there are some restrictions enforced to ensure correctness and scalability.

The table below defines the restrictions and support for the NFT ownership endpoint

Query Param	Comparison Operator	Support	Description	Example
token.id	eq	Y	Single occurrence only.	?token.id=X
	ne	N
	lt(e)	Y	Single occurrence only.	?token.id=lte:X
	gt(e)	Y	Single occurrence only.	?token.id=gte:X
serialnumber	eq	Y	Single occurrence only. Requires the presence of a token.id query	?serialnumber=Y
	ne	N
	lt(e)	Y	Single occurrence only. Requires the presence of an lte or eq token.id query	?token.id=lte:X&serialnumber=lt:Y
	gt(e)	Y	Single occurrence only. Requires the presence of an gte or eq token.id query	?token.id=gte:X&serialnumber=gt:Y
spender.id	eq	Y		?spender.id=Z
	ne	N
	lt(e)	Y		?spender.id=lt:Z
	gt(e)	Y		?spender.id=gt:Z

Note: When searching across a range for individual NFTs a serialnumber with an additional token.id query filter must be provided. Both filters must be a single occurrence of gt(e) or lt(e) which provide a lower and or upper boundary for search.

GET/api/v1/accounts/{idOrAliasOrEvmAddress}/nfts

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

serialnumberstring

The nft serial number (64 bit type). Requires a tokenId value also be populated.

Pattern: ^((eq|gt|gte|lt|lte):)?\d{1,19}?$

spender.idEntityIdQuery (string)

The ID of the spender to return information for

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

token.idEntityIdQuery (string)

The ID of the token to return information for

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

Response

Body

nftsarray of Nft (object)

account_idnullable EntityId (string)

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

Example: "0.0.2"

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

created_timestampnullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

delegating_spendernullable EntityId (string)

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

Example: "0.0.2"

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

deletedboolean

whether the nft or the token it belongs to has been deleted

metadatastring (byte)

Arbitrary binary data associated with this NFT encoded in base64.

modified_timestampnullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

serial_numberinteger (int64)

Example: 1

spendernullable EntityId (string)

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

Example: "0.0.2"

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

token_idnullable EntityId (string)

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

Example: "0.0.2"

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

linksLinks (object)

nextnullable string

Request

Response

Get past staking reward payouts for an account

Returns information for all past staking reward payouts for an account.

GET/api/v1/accounts/{idOrAliasOrEvmAddress}/rewards

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

itemsstring

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

Response

Body

rewardsarray of StakingReward (object)

account_id*nullable EntityId (string)

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

Example: "0.0.2"

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

amount*integer (int64)

The number of tinybars awarded

Example: 10

timestamp*Timestamp (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

linksLinks (object)

nextnullable string

Request

Response

Get Rewards by Account

Returns information for all past staking reward payouts for an account.

This method will use 15 Compute Units.

Get past staking reward payouts for an account

Returns information for all past staking reward payouts for an account.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/rewards

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

The consensus timestamp in seconds.nanoseconds format with an optional comparison operator

itemsstring

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

Response

Body

rewardsarray of StakingReward (object)

account_id*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}$

amount*integer (int64)

The number of tinybars awarded

Example: 10

timestamp*Timestamp (string)

Example: "1586567700.453054000"

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

linksLinks (object)

nextnullable string

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

Request

Response

Get past staking reward payouts for an account

Returns information for all past staking reward payouts for an account.

GET/api/v1/accounts/{idOrAliasOrEvmAddress}/rewards

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

itemsstring

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

Response

Body

rewardsarray of StakingReward (object)

account_id*nullable EntityId (string)

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

Example: "0.0.2"

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

amount*integer (int64)

The number of tinybars awarded

Example: 10

timestamp*Timestamp (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

linksLinks (object)

nextnullable string

Request

Response

Get nfts for an account info

Returns information for all non-fungible tokens for an account.

Ordering

In that regard, if a user acquired a set of NFTs in the order (2-2, 2-4 1-5, 1-1, 1-3, 3-3, 3-4), the following layouts illustrate the ordering expectations for ownership listing

All NFTs in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
All NFTs in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3, 1-1
NFTs above 1-1 in ASC order: 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
NFTs below 3-3 in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4
NFTs between 1-3 and 3-3 inclusive in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3

Note: The default order for this API is currently DESC

Filtering

When filtering there are some restrictions enforced to ensure correctness and scalability.

The table below defines the restrictions and support for the NFT ownership endpoint

Query Param	Comparison Operator	Support	Description	Example
token.id	eq	Y	Single occurrence only.	?token.id=X
	ne	N
	lt(e)	Y	Single occurrence only.	?token.id=lte:X
	gt(e)	Y	Single occurrence only.	?token.id=gte:X
serialnumber	eq	Y	Single occurrence only. Requires the presence of a token.id query	?serialnumber=Y
	ne	N
	lt(e)	Y	Single occurrence only. Requires the presence of an lte or eq token.id query	?token.id=lte:X&serialnumber=lt:Y
	gt(e)	Y	Single occurrence only. Requires the presence of an gte or eq token.id query	?token.id=gte:X&serialnumber=gt:Y
spender.id	eq	Y		?spender.id=Z
	ne	N
	lt(e)	Y		?spender.id=lt:Z
	gt(e)	Y		?spender.id=gt:Z

GET/api/v1/accounts/{idOrAliasOrEvmAddress}/nfts

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

serialnumberstring

The nft serial number (64 bit type). Requires a tokenId value also be populated.

Pattern: ^((eq|gt|gte|lt|lte):)?\d{1,19}?$

spender.idEntityIdQuery (string)

The ID of the spender to return information for

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

token.idEntityIdQuery (string)

The ID of the token to return information for

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

Response

Body

nftsarray of Nft (object)

account_idnullable EntityId (string)

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

Example: "0.0.2"

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

created_timestampnullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

delegating_spendernullable EntityId (string)

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

Example: "0.0.2"

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

deletedboolean

whether the nft or the token it belongs to has been deleted

metadatastring (byte)

Arbitrary binary data associated with this NFT encoded in base64.

modified_timestampnullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

serial_numberinteger (int64)

Example: 1

spendernullable EntityId (string)

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

Example: "0.0.2"

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

token_idnullable EntityId (string)

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

Example: "0.0.2"

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

linksLinks (object)

nextnullable string

Request

Response

List account entities on network

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

GET/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

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.0.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)

A Unix timestamp in seconds.nanoseconds format

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.0.2"

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

balanceinteger (int64)

created_timestamp*nullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

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)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

key*nullable Key (object)

The public key which controls access to various network entities.

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: "421050820e1485acdd59726088e0e4a2130ebbbb70009f640ad95c78dd5a7b38"

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.0.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)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

any

links*Links (object)

nextnullable string

Request

Response

Get account by alias, id, or evm address

GET/api/v1/accounts/{idOrAliasOrEvmAddress}

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

itemsstring

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

transactiontypeTransactionTypes (enum)

Example: "cryptotransfer"

transactionsboolean

If provided and set to false transactions will not be included in the response

Example: true

Response

Body

account*nullable EntityId (string)

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

Example: "0.0.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)

A Unix timestamp in seconds.nanoseconds format

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.0.2"

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

balanceinteger (int64)

created_timestamp*nullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

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)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

key*nullable Key (object)

The public key which controls access to various network entities.

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: "421050820e1485acdd59726088e0e4a2130ebbbb70009f640ad95c78dd5a7b38"

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.0.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)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

any

transactions*Transactions (array of Transaction (object))

bytesnullable string (byte)

charged_tx_feeinteger (int64)

consensus_timestampTimestamp (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

entity_idnullable EntityId (string)

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

Example: "0.0.2"

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

max_feestring

memo_base64nullable string (byte)

nameTransactionTypes (enum)

nft_transfersarray of object

is_approval*boolean

receiver_account_id*nullable EntityId (string)

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

Example: "0.0.2"

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

sender_account_id*nullable EntityId (string)

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

Example: "0.0.2"

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

serial_number*integer (int64)

Example: 1

token_id*nullable EntityId (string)

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

Example: "0.0.2"

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

nodenullable EntityId (string)

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

Example: "0.0.2"

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

nonceinteger

parent_consensus_timestampnullable TimestampNullable (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

resultstring

scheduledboolean

staking_reward_transfersStakingRewardTransfers (array of StakingRewardTransfer (object))

account*nullable EntityId (string)

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

Example: "0.0.2"

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

amount*integer (int64)

The number of tinybars awarded

Example: 10

token_transfersarray of object

token_id*nullable EntityId (string)

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

Example: "0.0.2"

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

account*nullable EntityId (string)

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

Example: "0.0.2"

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

amount*integer (int64)

is_approvalboolean

transaction_hashstring (byte)

transaction_idstring

transfersarray of object

account*nullable EntityId (string)

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

Example: "0.0.2"

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

amount*integer (int64)

is_approvalboolean

valid_duration_secondsstring

valid_start_timestampTimestamp (string)

A Unix timestamp in seconds.nanoseconds format

Example: "1586567700.453054000"

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

links*Links (object)

nextnullable string

Request

Response

{
  "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": null
  }
}

{
  "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",
  "transactions": [
    {
      "bytes": null,
      "charged_tx_fee": 7,
      "consensus_timestamp": "1234567890.000000007",
      "entity_id": "0.0.2281979",
      "max_fee": 33,
      "memo_base64": null,
      "name": "CRYPTOTRANSFER",
      "nft_transfers": [
        {
          "is_approval": true,
          "receiver_account_id": "0.0.121",
          "sender_account_id": "0.0.122",
          "serial_number": 1,
          "token_id": "0.0.123"
        },
        {
          "is_approval": true,
          "receiver_account_id": "0.0.321",
          "sender_account_id": "0.0.422",
          "serial_number": 2,
          "token_id": "0.0.123"
        }
      ],
      "node": "0.0.3",
      "nonce": 0,
      "parent_consensus_timestamp": "1234567890.000000007",
      "result": "SUCCESS",
      "scheduled": false,
      "staking_reward_transfers": [
        {
          "account": 3,
          "amount": 150
        },
        {
          "account": 9,
          "amount": 200
        }
      ],
      "transaction_hash": "vigzKe2J7fv4ktHBbNTSzQmKq7Lzdq1/lJMmHT+a2KgvdhAuadlvS4eKeqKjIRmW",
      "transaction_id": "0.0.8-1234567890-000000006",
      "token_transfers": [
        {
          "token_id": "0.0.90000",
          "account": "0.0.9",
          "amount": 1200,
          "is_approval": false
        },
        {
          "token_id": "0.0.90000",
          "account": "0.0.8",
          "amount": -1200,
          "is_approval": false
        }
      ],
      "transfers": [
        {
          "account": "0.0.3",
          "amount": 2,
          "is_approval": false
        },
        {
          "account": "0.0.8",
          "amount": -3,
          "is_approval": false
        },
        {
          "account": "0.0.98",
          "amount": 1,
          "is_approval": false
        },
        {
          "account": "0.0.800",
          "amount": 150,
          "is_approval": false
        },
        {
          "account": "0.0.800",
          "amount": 200,
          "is_approval": false
        }
      ],
      "valid_duration_seconds": 11,
      "valid_start_timestamp": "1234567890.000000006"
    }
  ],
  "links": {
    "next": null
  }
}

Get Accounts by ID

Return the account transactions and balance information given an account alias, an account id, or an evm address.

This method will use 15 Compute Units.

Get account by alias, id, or evm address

Return the account transactions and balance information given an account alias, an account id, or an evm address. The information will be limited to at most 1000 token balances for the account as outlined in HIP-367. When the timestamp parameter is supplied, we will return transactions and account state for the relevant timestamp query. Balance information will be accurate to within 15 minutes of the provided timestamp query. Historical stake and reward information is not currently available so these fields contain current data. Historical ethereum nonce information is also currently not available and may not be the exact value at a provided timestamp.

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

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

The consensus timestamp in seconds.nanoseconds format with an optional comparison operator

itemsstring

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

transactiontypeTransactionTypes (enum)

Example: "cryptotransfer"

CONSENSUSCREATETOPICCONSENSUSDELETETOPICCONSENSUSSUBMITMESSAGECONSENSUSUPDATETOPICCONTRACTCALLCONTRACTCREATEINSTANCECONTRACTDELETEINSTANCECONTRACTUPDATEINSTANCECRYPTOADDLIVEHASHCRYPTOAPPROVEALLOWANCECRYPTOCREATEACCOUNTCRYPTODELETECRYPTODELETEALLOWANCECRYPTODELETELIVEHASHCRYPTOTRANSFERCRYPTOUPDATEACCOUNTETHEREUMTRANSACTIONFILEAPPENDFILECREATEFILEDELETEFILEUPDATEFREEZENODESTAKEUPDATESCHEDULECREATESCHEDULEDELETESCHEDULESIGNSYSTEMDELETESYSTEMUNDELETETOKENASSOCIATETOKENBURNTOKENCREATIONTOKENDELETIONTOKENDISSOCIATETOKENFEESCHEDULEUPDATETOKENFREEZETOKENGRANTKYCTOKENMINTTOKENPAUSETOKENREVOKEKYCTOKENUNFREEZETOKENUNPAUSETOKENUPDATETOKENWIPEUNCHECKEDSUBMITUNKNOWNUTILPRNG

transactionsboolean

If provided and set to false transactions will not be included in the response

Example: true

Response

Body

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

transactions*Transactions (array of Transaction (object))

bytesnullable string (byte)

charged_tx_feeinteger (int64)

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

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

entity_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}$

max_feestring

memo_base64nullable string (byte)

nameTransactionTypes (enum)

CONSENSUSCREATETOPICCONSENSUSDELETETOPICCONSENSUSSUBMITMESSAGECONSENSUSUPDATETOPICCONTRACTCALLCONTRACTCREATEINSTANCECONTRACTDELETEINSTANCECONTRACTUPDATEINSTANCECRYPTOADDLIVEHASHCRYPTOAPPROVEALLOWANCECRYPTOCREATEACCOUNTCRYPTODELETECRYPTODELETEALLOWANCECRYPTODELETELIVEHASHCRYPTOTRANSFERCRYPTOUPDATEACCOUNTETHEREUMTRANSACTIONFILEAPPENDFILECREATEFILEDELETEFILEUPDATEFREEZENODESTAKEUPDATESCHEDULECREATESCHEDULEDELETESCHEDULESIGNSYSTEMDELETESYSTEMUNDELETETOKENASSOCIATETOKENBURNTOKENCREATIONTOKENDELETIONTOKENDISSOCIATETOKENFEESCHEDULEUPDATETOKENFREEZETOKENGRANTKYCTOKENMINTTOKENPAUSETOKENREVOKEKYCTOKENUNFREEZETOKENUNPAUSETOKENUPDATETOKENWIPEUNCHECKEDSUBMITUNKNOWNUTILPRNG

nft_transfersarray of object

is_approval*boolean

receiver_account_id*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}$

sender_account_id*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}$

serial_number*integer (int64)

Example: 1

token_id*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}$

nodenullable 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}$

nonceinteger

parent_consensus_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

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

resultstring

scheduledboolean

staking_reward_transfersStakingRewardTransfers (array of StakingRewardTransfer (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}$

amount*integer (int64)

The number of tinybars awarded

Example: 10

token_transfersarray of object

token_id*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}$

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}$

amount*integer (int64)

is_approvalboolean

transaction_hashstring (byte)

transaction_idstring

transfersarray of 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}$

amount*integer (int64)

is_approvalboolean

valid_duration_secondsstring

valid_start_timestampTimestamp (string)

Example: "1586567700.453054000"

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

links*Links (object)

nextnullable string

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

Request

Response

Get NFTs by Account

Returns information for all non-fungible tokens for an account.

This method will use 15 Compute Units.

Get nfts for an account info

Returns information for all non-fungible tokens for an account.

Ordering

In that regard, if a user acquired a set of NFTs in the order (2-2, 2-4 1-5, 1-1, 1-3, 3-3, 3-4), the following layouts illustrate the ordering expectations for ownership listing

All NFTs in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
All NFTs in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3, 1-1
NFTs above 1-1 in ASC order: 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
NFTs below 3-3 in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4
NFTs between 1-3 and 3-3 inclusive in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3

Note: The default order for this API is currently DESC

Filtering

When filtering there are some restrictions enforced to ensure correctness and scalability.

The table below defines the restrictions and support for the NFT ownership endpoint

Query Param	Comparison Operator	Support	Description	Example
token.id	eq	Y	Single occurrence only.	?token.id=X
	ne	N
	lt(e)	Y	Single occurrence only.	?token.id=lte:X
	gt(e)	Y	Single occurrence only.	?token.id=gte:X
serialnumber	eq	Y	Single occurrence only. Requires the presence of a token.id query	?serialnumber=Y
	ne	N
	lt(e)	Y	Single occurrence only. Requires the presence of an lte or eq token.id query	?token.id=lte:X&serialnumber=lt:Y
	gt(e)	Y	Single occurrence only. Requires the presence of an gte or eq token.id query	?token.id=gte:X&serialnumber=gt:Y
spender.id	eq	Y		?spender.id=Z
	ne	N
	lt(e)	Y		?spender.id=lt:Z
	gt(e)	Y		?spender.id=gt:Z

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/nfts

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

serialnumberstring

The nft serial number (64 bit type). Requires a tokenId value also be populated.

Pattern: ^((eq|gt|gte|lt|lte):)?\d{1,19}?$

spender.idEntityIdQuery (string)

The ID of the spender to return information for

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

token.idEntityIdQuery (string)

The ID of the token to return information for

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

Response

Body

nftsarray of Nft (object)

account_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}$

created_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

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

delegating_spendernullable 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}$

deletedboolean

whether the nft or the token it belongs to has been deleted

metadatastring (byte)

base64 encoded binary data

modified_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

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

serial_numberinteger (int64)

Example: 1

spendernullable 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}$

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}$

linksLinks (object)

nextnullable string

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

Request

Response

Get Token Relationships by Account

Returns information for all token relationships for an account.

This method will use 15 Compute Units.

Get token relationships info for an account

Returns information for all token relationships for an account.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/tokens

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "desc"

ascdesc

token.idEntityIdQuery (string)

The ID of the token to return information for

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

Response

Body

tokensarray of TokenRelationship (object)

automatic_association*boolean

Specifies if the relationship is implicitly/explicitly associated.

Example: true

balance*integer (int64)

For FUNGIBLE_COMMON, the balance that the account holds in the smallest denomination. For NON_FUNGIBLE_UNIQUE, the number of NFTs held by the account.

Example: 5

created_timestamp*Timestamp (string)

Example: "1586567700.453054000"

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

freeze_status*enum

The Freeze status of the account.

Example: "UNFROZEN"

NOT_APPLICABLEFROZENUNFROZEN

kyc_status*enum

The KYC status of the account.

Example: "GRANTED"

NOT_APPLICABLEGRANTEDREVOKED

token_id*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}$

linksLinks (object)

nextnullable string

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

Request

Response

Get fungible token allowances for an account

Returns information for fungible token allowances for an account.

Ordering

The order is governed by a combination of the spender id and the token id values, with spender id being the parent column. The token id value governs its order within the given spender id.

Note: The default order for this API is currently ASC

Filtering

When filtering there are some restrictions enforced to ensure correctness and scalability.

The table below defines the restrictions and support for the endpoint

Query Param	Comparison Operator	Support	Description	Example
spender.id	eq	Y	Single occurrence only.	?spender.id=X
	ne	N
	lt(e)	Y	Single occurrence only.	?spender.id=lte:X
	gt(e)	Y	Single occurrence only.	?spender.id=gte:X
token.id	eq	Y	Single occurrence only. Requires the presence of a spender.id query	?token.id=lt:Y
	ne	N
	lt(e)	Y	Single occurrence only. Requires the presence of an lte or eq spender.id query	?spender.id=lte:X&token.id=lt:Y
	gt(e)	Y	Single occurrence only. Requires the presence of an gte or eq spender.id query	?spender.id=gte:X&token.id=gt:Y

Both filters must be a single occurrence of gt(e) or lt(e) which provide a lower and or upper boundary for search.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/tokens

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "desc"

ascdesc

spender.idEntityIdQuery (string)

The ID of the spender to return information for

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

token.idEntityIdQuery (string)

The ID of the token to return information for

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

Response

Body

allowancesTokenAllowances (array of TokenAllowance (all of))

amount_grantedinteger (int64)

The granted amount of the spender's allowance.

Example: 100

ownernullable 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}$

spendernullable 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}$

timestampTimestampRange (object)

A timestamp range an entity is valid for

fromall of

Timestamp (string)

Example: "1586567700.453054000"

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

any

The inclusive from timestamp in seconds

toall of

nullable TimestampNullable (string)

Example: "1586567700.453054000"

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

any

The exclusive to timestamp in seconds

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}$

linksLinks (object)

nextnullable string

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

Request

Response

Get crypto allowances for an account info

Returns information for all crypto allowances for an account.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/crypto

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

spender.idEntityIdQuery (string)

The ID of the spender to return information for

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

Response

Body

allowancesCryptoAllowances (array of CryptoAllowance (all of))

amount_grantedinteger (int64)

The granted amount of the spender's allowance.

Example: 100

ownernullable 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}$

spendernullable 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}$

timestampTimestampRange (object)

A timestamp range an entity is valid for

fromall of

Timestamp (string)

Example: "1586567700.453054000"

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

any

The inclusive from timestamp in seconds

toall of

nullable TimestampNullable (string)

Example: "1586567700.453054000"

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

any

The exclusive to timestamp in seconds

amount_grantedany

The granted amount of the spender's allowance in tinybars.

linksLinks (object)

nextnullable string

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

Request

Response

Get past staking reward payouts for an account

Returns information for all past staking reward payouts for an account.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/rewards

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

The consensus timestamp in seconds.nanoseconds format with an optional comparison operator

itemsstring

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

Response

Body

rewardsarray of StakingReward (object)

account_id*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}$

amount*integer (int64)

The number of tinybars awarded

Example: 10

timestamp*Timestamp (string)

Example: "1586567700.453054000"

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

linksLinks (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

{
  "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"
  }
}

Get token relationships info for an account

Returns information for all token relationships for an account.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/tokens

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "desc"

ascdesc

token.idEntityIdQuery (string)

The ID of the token to return information for

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

Response

Body

tokensarray of TokenRelationship (object)

automatic_association*boolean

Specifies if the relationship is implicitly/explicitly associated.

Example: true

balance*integer (int64)

For FUNGIBLE_COMMON, the balance that the account holds in the smallest denomination. For NON_FUNGIBLE_UNIQUE, the number of NFTs held by the account.

Example: 5

created_timestamp*Timestamp (string)

Example: "1586567700.453054000"

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

freeze_status*enum

The Freeze status of the account.

Example: "UNFROZEN"

NOT_APPLICABLEFROZENUNFROZEN

kyc_status*enum

The KYC status of the account.

Example: "GRANTED"

NOT_APPLICABLEGRANTEDREVOKED

token_id*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}$

linksLinks (object)

nextnullable string

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

Request

Response

Get nfts for an account info

Returns information for all non-fungible tokens for an account.

Ordering

In that regard, if a user acquired a set of NFTs in the order (2-2, 2-4 1-5, 1-1, 1-3, 3-3, 3-4), the following layouts illustrate the ordering expectations for ownership listing

All NFTs in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
All NFTs in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3, 1-1
NFTs above 1-1 in ASC order: 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
NFTs below 3-3 in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4
NFTs between 1-3 and 3-3 inclusive in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3

Note: The default order for this API is currently DESC

Filtering

When filtering there are some restrictions enforced to ensure correctness and scalability.

The table below defines the restrictions and support for the NFT ownership endpoint

Query Param	Comparison Operator	Support	Description	Example
token.id	eq	Y	Single occurrence only.	?token.id=X
	ne	N
	lt(e)	Y	Single occurrence only.	?token.id=lte:X
	gt(e)	Y	Single occurrence only.	?token.id=gte:X
serialnumber	eq	Y	Single occurrence only. Requires the presence of a token.id query	?serialnumber=Y
	ne	N
	lt(e)	Y	Single occurrence only. Requires the presence of an lte or eq token.id query	?token.id=lte:X&serialnumber=lt:Y
	gt(e)	Y	Single occurrence only. Requires the presence of an gte or eq token.id query	?token.id=gte:X&serialnumber=gt:Y
spender.id	eq	Y		?spender.id=Z
	ne	N
	lt(e)	Y		?spender.id=lt:Z
	gt(e)	Y		?spender.id=gt:Z

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/accounts/{idOrAliasOrEvmAddress}/nfts

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

serialnumberstring

The nft serial number (64 bit type). Requires a tokenId value also be populated.

Pattern: ^((eq|gt|gte|lt|lte):)?\d{1,19}?$

spender.idEntityIdQuery (string)

The ID of the spender to return information for

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

token.idEntityIdQuery (string)

The ID of the token to return information for

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

Response

Body

nftsarray of Nft (object)

account_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}$

created_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

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

delegating_spendernullable 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}$

deletedboolean

whether the nft or the token it belongs to has been deleted

metadatastring (byte)

base64 encoded binary data

modified_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

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

serial_numberinteger (int64)

Example: 1

spendernullable 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}$

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}$

linksLinks (object)

nextnullable string

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

Request

Response

Get account by alias, id, or evm address

Return the account transactions and balance information given an account alias, an account id, or an evm address. The information will be limited to at most 1000 token balances for the account as outlined in HIP-367. When the timestamp parameter is supplied, we will return transactions and account state for the relevant timestamp query. Balance information will be accurate to within 15 minutes of the provided timestamp query. Historical stake and reward information is not currently available so these fields contain current data. Historical ethereum nonce information is also currently not available and may not be the exact value at a provided timestamp.

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

Path parameters

idOrAliasOrEvmAddress*string

Account alias or account id or evm address

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

Query parameters

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

The consensus timestamp in seconds.nanoseconds format with an optional comparison operator

itemsstring

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

transactiontypeTransactionTypes (enum)

Example: "cryptotransfer"

CONSENSUSCREATETOPICCONSENSUSDELETETOPICCONSENSUSSUBMITMESSAGECONSENSUSUPDATETOPICCONTRACTCALLCONTRACTCREATEINSTANCECONTRACTDELETEINSTANCECONTRACTUPDATEINSTANCECRYPTOADDLIVEHASHCRYPTOAPPROVEALLOWANCECRYPTOCREATEACCOUNTCRYPTODELETECRYPTODELETEALLOWANCECRYPTODELETELIVEHASHCRYPTOTRANSFERCRYPTOUPDATEACCOUNTETHEREUMTRANSACTIONFILEAPPENDFILECREATEFILEDELETEFILEUPDATEFREEZENODESTAKEUPDATESCHEDULECREATESCHEDULEDELETESCHEDULESIGNSYSTEMDELETESYSTEMUNDELETETOKENASSOCIATETOKENBURNTOKENCREATIONTOKENDELETIONTOKENDISSOCIATETOKENFEESCHEDULEUPDATETOKENFREEZETOKENGRANTKYCTOKENMINTTOKENPAUSETOKENREVOKEKYCTOKENUNFREEZETOKENUNPAUSETOKENUPDATETOKENWIPEUNCHECKEDSUBMITUNKNOWNUTILPRNG

transactionsboolean

If provided and set to false transactions will not be included in the response

Example: true

Response

Body

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

transactions*Transactions (array of Transaction (object))

bytesnullable string (byte)

charged_tx_feeinteger (int64)

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

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

entity_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}$

max_feestring

memo_base64nullable string (byte)

nameTransactionTypes (enum)

CONSENSUSCREATETOPICCONSENSUSDELETETOPICCONSENSUSSUBMITMESSAGECONSENSUSUPDATETOPICCONTRACTCALLCONTRACTCREATEINSTANCECONTRACTDELETEINSTANCECONTRACTUPDATEINSTANCECRYPTOADDLIVEHASHCRYPTOAPPROVEALLOWANCECRYPTOCREATEACCOUNTCRYPTODELETECRYPTODELETEALLOWANCECRYPTODELETELIVEHASHCRYPTOTRANSFERCRYPTOUPDATEACCOUNTETHEREUMTRANSACTIONFILEAPPENDFILECREATEFILEDELETEFILEUPDATEFREEZENODESTAKEUPDATESCHEDULECREATESCHEDULEDELETESCHEDULESIGNSYSTEMDELETESYSTEMUNDELETETOKENASSOCIATETOKENBURNTOKENCREATIONTOKENDELETIONTOKENDISSOCIATETOKENFEESCHEDULEUPDATETOKENFREEZETOKENGRANTKYCTOKENMINTTOKENPAUSETOKENREVOKEKYCTOKENUNFREEZETOKENUNPAUSETOKENUPDATETOKENWIPEUNCHECKEDSUBMITUNKNOWNUTILPRNG

nft_transfersarray of object

is_approval*boolean

receiver_account_id*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}$

sender_account_id*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}$

serial_number*integer (int64)

Example: 1

token_id*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}$

nodenullable 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}$

nonceinteger

parent_consensus_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

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

resultstring

scheduledboolean

staking_reward_transfersStakingRewardTransfers (array of StakingRewardTransfer (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}$

amount*integer (int64)

The number of tinybars awarded

Example: 10

token_transfersarray of object

token_id*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}$

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}$

amount*integer (int64)

is_approvalboolean

transaction_hashstring (byte)

transaction_idstring

transfersarray of 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}$

amount*integer (int64)

is_approvalboolean

valid_duration_secondsstring

valid_start_timestampTimestamp (string)

Example: "1586567700.453054000"

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

links*Links (object)

nextnullable string

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

Request

Response

{
  "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",
  "transactions": [
    {
      "bytes": null,
      "charged_tx_fee": 7,
      "consensus_timestamp": "1234567890.000000007",
      "entity_id": "0.0.2281979",
      "max_fee": 33,
      "memo_base64": null,
      "name": "CRYPTOTRANSFER",
      "nft_transfers": [
        {
          "is_approval": true,
          "receiver_account_id": "0.0.121",
          "sender_account_id": "0.0.122",
          "serial_number": 1,
          "token_id": "0.0.123"
        },
        {
          "is_approval": true,
          "receiver_account_id": "0.0.321",
          "sender_account_id": "0.0.422",
          "serial_number": 2,
          "token_id": "0.0.123"
        }
      ],
      "node": "0.0.3",
      "nonce": 0,
      "parent_consensus_timestamp": "1234567890.000000007",
      "result": "SUCCESS",
      "scheduled": false,
      "staking_reward_transfers": [
        {
          "account": 3,
          "amount": 150
        },
        {
          "account": 9,
          "amount": 200
        }
      ],
      "transaction_hash": "vigzKe2J7fv4ktHBbNTSzQmKq7Lzdq1/lJMmHT+a2KgvdhAuadlvS4eKeqKjIRmW",
      "transaction_id": "0.0.8-1234567890-000000006",
      "token_transfers": [
        {
          "token_id": "0.0.90000",
          "account": "0.0.9",
          "amount": 1200,
          "is_approval": false
        },
        {
          "token_id": "0.0.90000",
          "account": "0.0.8",
          "amount": -1200,
          "is_approval": false
        }
      ],
      "transfers": [
        {
          "account": "0.0.3",
          "amount": 2,
          "is_approval": false
        },
        {
          "account": "0.0.8",
          "amount": -3,
          "is_approval": false
        },
        {
          "account": "0.0.98",
          "amount": 1,
          "is_approval": false
        },
        {
          "account": "0.0.800",
          "amount": 150,
          "is_approval": false
        },
        {
          "account": "0.0.800",
          "amount": 200,
          "is_approval": false
        }
      ],
      "valid_duration_seconds": 11,
      "valid_start_timestamp": "1234567890.000000006"
    }
  ],
  "links": {
    "next": "/api/v1/transactions?timestamp=lt:1657598275.517984411"
  }
}