accounts

List account entities on network

Changed on

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

get/api/v1/accounts

Request

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

Query parameters

account.balancestring

The optional balance value to compare against

account.idstring

The ID of the account to return information for

account.publickeystring

The account's public key to compare against

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.

limitinteger

The maximum number of items to return

order'asc' | 'desc'

The order in which items are listed

Response

OK

Example 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,
      "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

  • v106a98b556c72Revision changes
    • warning

      changed the pattern of the query request parameter account.balance from ^((gte?|lte?|eq|ne)\:)?\d{1,10}$ to ^((gte?|lte?|eq|ne)\:)?\d{1,19}$

    • info

      added the non-success response with the status

  • v18ce3e9a7251eRevision changes
    • info

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