accounts

Get account by alias, id, or evm address

Changed on

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}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/accounts/{idOrAliasOrEvmAddress}
  • Auth
    none declared

Path parameters

idOrAliasOrEvmAddressstring required

Account alias or account id or evm address

Query parameters

limitinteger

The maximum number of items to return

order'asc' | 'desc'

The order in which items are listed

timestampstring[]

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.

transactiontype'ATOMICBATCH' | 'CLPRCLOSECHANNEL' | 'CLPRCOMPLETECHANNEL' | 'CLPRCOMPLETECONNECTOR' | 'CLPRDEREGISTERCONNECTOR' | 'CLPRREDACTMESSAGE' | 'CLPRREGISTERCHANNEL' | 'CLPRREGISTERCONNECTOR' | 'CLPRSUBMITBUNDLE' | 'CLPRUPDATELEDGERCONFIGURATION' | 'CONSENSUSCREATETOPIC' | 'CONSENSUSDELETETOPIC' | 'CONSENSUSSUBMITMESSAGE' | 'CONSENSUSUPDATETOPIC' | 'CONTRACTCALL' | 'CONTRACTCREATEINSTANCE' | 'CONTRACTDELETEINSTANCE' | 'CONTRACTUPDATEINSTANCE' | 'CRSPUBLICATION' | 'CRYPTOADDLIVEHASH' | 'CRYPTOAPPROVEALLOWANCE' | 'CRYPTOCREATEACCOUNT' | 'CRYPTODELETE' | 'CRYPTODELETEALLOWANCE' | 'CRYPTODELETELIVEHASH' | 'CRYPTOTRANSFER' | 'CRYPTOUPDATEACCOUNT' | 'ETHEREUMTRANSACTION' | 'FILEAPPEND' | 'FILECREATE' | 'FILEDELETE' | 'FILEUPDATE' | 'FREEZE' | 'HINTSKEYPUBLICATION' | 'HINTSPARTIALSIGNATURE' | 'HINTSPREPROCESSINGVOTE' | 'HISTORYPROOFKEYPUBLICATION' | 'HISTORYPROOFSIGNATURE' | 'HISTORYPROOFVOTE' | 'HOOKSTORE' | 'LEDGERIDPUBLICATION' | 'MIGRATIONROOTHASHVOTE' | 'NODECREATE' | 'NODEDELETE' | 'NODESTAKEUPDATE' | 'NODEUPDATE' | 'REGISTEREDNODECREATE' | 'REGISTEREDNODEDELETE' | 'REGISTEREDNODEUPDATE' | 'SCHEDULECREATE' | 'SCHEDULEDELETE' | 'SCHEDULESIGN' | 'STATESIGNATURETRANSACTION' | 'SYSTEMDELETE' | 'SYSTEMUNDELETE' | 'TOKENAIRDROP' | 'TOKENASSOCIATE' | 'TOKENBURN' | 'TOKENCANCELAIRDROP' | 'TOKENCLAIMAIRDROP' | 'TOKENCREATION' | 'TOKENDELETION' | 'TOKENDISSOCIATE' | 'TOKENFEESCHEDULEUPDATE' | 'TOKENFREEZE' | 'TOKENGRANTKYC' | 'TOKENMINT' | 'TOKENPAUSE' | 'TOKENREJECT' | 'TOKENREVOKEKYC' | 'TOKENUNFREEZE' | 'TOKENUNPAUSE' | 'TOKENUPDATE' | 'TOKENUPDATENFTS' | 'TOKENWIPE' | 'UNCHECKEDSUBMIT' | 'UTILPRNG'
transactionsboolean

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

Response

OK

accountstring nullable required

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

aliasstring nullable required

RFC4648 no-padding base32 encoded account alias

auto_renew_periodinteger nullable required
created_timestampstring nullable required

A Unix timestamp in seconds.nanoseconds format

decline_rewardboolean required

Whether the account declines receiving a staking reward

delegation_addressstring binary nullable required

A network entity encoded as an EVM address in hex.

deletedboolean nullable required
ethereum_nonceinteger nullable required
evm_addressstring binary nullable required

A network entity encoded as an EVM address in hex.

expiry_timestampstring nullable required

A Unix timestamp in seconds.nanoseconds format

max_automatic_token_associationsinteger nullable required
memostring nullable required
pending_rewardinteger

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_requiredboolean nullable required
staked_account_idstring nullable required

The account to which this account is staking

staked_node_idinteger nullable required

The id of the node to which this account is staking

stake_period_startstring nullable required

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

Example 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,
  "delegation_address": "0x019b8ee526333d9cbbbc35fff0309794dfa73451",
  "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"
}

Changes

  • v1fc88183ee7a8Revision changes
    • warning

      added the new CLPRCLOSECHANNEL enum value to the /// response property for the response status

    • warning

      added the new CLPRCOMPLETECHANNEL enum value to the /// response property for the response status

    • warning

      added the new CLPRCOMPLETECONNECTOR enum value to the /// response property for the response status

    • warning

      added the new CLPRDEREGISTERCONNECTOR enum value to the /// response property for the response status

    • warning

      added the new CLPRREDACTMESSAGE enum value to the /// response property for the response status

    • warning

      added the new CLPRREGISTERCHANNEL enum value to the /// response property for the response status

    • warning

      added the new CLPRREGISTERCONNECTOR enum value to the /// response property for the response status

    • warning

      added the new CLPRSUBMITBUNDLE enum value to the /// response property for the response status

    • warning

      added the new CLPRUPDATELEDGERCONFIGURATION enum value to the /// response property for the response status

    • info

      added the new enum value CLPRCLOSECHANNEL to the query request parameter transactiontype

    • info

      added the new enum value CLPRCOMPLETECHANNEL to the query request parameter transactiontype

    • info

      added the new enum value CLPRCOMPLETECONNECTOR to the query request parameter transactiontype

    • info

      added the new enum value CLPRDEREGISTERCONNECTOR to the query request parameter transactiontype

    • info

      added the new enum value CLPRREDACTMESSAGE to the query request parameter transactiontype

    • info

      added the new enum value CLPRREGISTERCHANNEL to the query request parameter transactiontype

    • info

      added the new enum value CLPRREGISTERCONNECTOR to the query request parameter transactiontype

    • info

      added the new enum value CLPRSUBMITBUNDLE to the query request parameter transactiontype

    • info

      added the new enum value CLPRUPDATELEDGERCONFIGURATION to the query request parameter transactiontype

  • v18ce3e9a7251eRevision changes
    • info

      added the required property //// to the response with the status