Skip to main content

/api/v1/accounts/{idOrAliasOrEvmAddress} REST API Endpoint

Get account by alias, id, or evm address

Updated on
Dec 18, 2024

Path Parameters

idOrAliasOrEvmAddress
string
REQUIRED

The account alias or account id or evm address

Query Parameters

limit
integer

The maximum number of items to return

order
string

The order in which items are listed (asc or desc)

timestamp
array

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

transactiontype
string

The transaction type, which can be: CONSENSUSCREATETOPIC, CONSENSUSDELETETOPIC, CONSENSUSSUBMITMESSAGE, CONSENSUSUPDATETOPIC, CONTRACTCALL, CONTRACTCREATEINSTANCE, CONTRACTDELETEINSTANCE, CONTRACTUPDATEINSTANCE, CRYPTOADDLIVEHASH, CRYPTOAPPROVEALLOWANCE, CRYPTOCREATEACCOUNT, CRYPTODELETE, CRYPTODELETEALLOWANCE, CRYPTODELETELIVEHASH, CRYPTOTRANSFER, CRYPTOUPDATEACCOUNT, ETHEREUMTRANSACTION, FILEAPPEND, FILECREATE, FILEDELETE, FILEUPDATE, FREEZE, NODECREATE, NODEDELETE, NODESTAKEUPDATE, NODEUPDATE, SCHEDULECREATE, SCHEDULEDELETE, SCHEDULESIGN, SYSTEMDELETE, SYSTEMUNDELETE, TOKENASSOCIATE, TOKENBURN, TOKENCREATION, TOKENDELETION, TOKENDISSOCIATE, TOKENFEESCHEDULEUPDATE, TOKENFREEZE, TOKENGRANTKYC, TOKENMINT, TOKENPAUSE, TOKENREJECT, TOKENREVOKEKYC, TOKENUNFREEZE, TOKENUNPAUSE, TOKENUPDATE, TOKENUPDATENFTS, TOKENWIPE, UNCHECKEDSUBMIT, UNKNOWN, UTILPRNG

transactions
boolean

If provided and set to false transactions will not be included in the response. Default value is set to true

Returns

account
string

The unique identifier of the account

alias
string | null

A human-readable alias for the account

auto_renew_period
integer

The period (in seconds) after which the account will automatically renew

balance
object

An object containing the balance details of the account

balance
integer

The current balance of the account in tinybars

timestamp
string

The timestamp when the balance was last updated

tokens
array

An array of token balances associated with the account

created_timestamp
string | null

The timestamp when the account was created

decline_reward
boolean

A boolean indicating whether the account declines to receive rewards

deleted
boolean

A boolean indicating whether the account has been deleted

ethereum_nonce
integer

The Ethereum nonce associated with the account

evm_address
string

The Ethereum-compatible address of the account

expiry_timestamp
string | null

The timestamp when the account is set to expire

key
object

An object containing the cryptographic key associated with the account

_type
string

The type of key

key
string

The public key in hexadecimal format

max_automatic_token_associations
integer

The maximum number of token associations the account can automatically handle

memo
string

An optional memo field for the account

pending_reward
integer

The amount of pending rewards for the account

receiver_sig_required
boolean | null

A boolean indicating if receiver's signature is required for transfers

staked_account_id
string | null

The account ID to which this account is staked

staked_node_id
integer | null

The node ID to which this account is staked

stake_period_start
string | null

The start of the staking period

transactions
array

An array containing transaction objects related to the specified account

bytes
string | null

The serialized bytes of the transaction

charged_tx_fee
integer

The transaction fee charged for this transaction

consensus_timestamp
string

The consensus timestamp when the transaction was processed, in seconds and nanoseconds since the epoch

entity_id
string | null

The ID of the entity involved in the transaction

high_volume_pricing_multiplier
integer | null

The multiplier applied to the transaction fee when high-volume pricing was in effect per HIP-1313, scaled by 1000 (e.g. 1000 = 1x, 4000 = 4x). A value of 0 means high-volume pricing was not applied. Null for pre-HIP-1313 transactions

max_fee
string

The maximum transaction fee that the payer is willing to pay

memo_base64
string

A base64-encoded string containing the memo field of the transaction

name
string

The type of the transaction

nft_transfers
array

An array containing NFT transfer details

node
string | null

The node account ID that processed the transaction

nonce
integer

The nonce of the transaction

parent_consensus_timestamp
string | null

The consensus timestamp of the parent transaction if this transaction is a child

result
string

The result of the transaction processing

scheduled
boolean

Indicates if the transaction was scheduled

staking_reward_transfers
array

An array containing staking reward transfer details

token_transfers
array

An array containing token transfer details

transaction_hash
string

A base64-encoded string representing the transaction hash

transaction_id
string

The unique identifier for the transaction

transfers
array

An array containing the details of hbar transfers involved in the transaction. Each transfer object includes:

account
string

The account ID involved in the transfer

amount
integer

The amount transferred, where a positive value indicates a credit and a negative value indicates a debit

is_approval
boolean

Indicates if the transfer was approved

valid_duration_seconds
string | null

The valid duration of the transaction in seconds

valid_start_timestamp
string

The valid start timestamp of the transaction in seconds and nanoseconds since the epoch

links
object

An object containing pagination links

next
string | null

A URL to fetch the next set of transactions, if available

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free