ONonflow
Accounts

Get an individual Account Key By Address and Index

Changed on

Get an account data by provided address in latest "sealed" block or by provided block height.

get/accounts/{address}/keys/{index}

Request

  • Base URL
    https://rest-testnet.onflow.org/v1
  • URL
    https://rest-testnet.onflow.org/v1/accounts/{address}/keys/{index}
  • Auth
    none declared

Path parameters

addressstring hexadecimal required

The 8-byte address of an account.

The address of the account.

indexstring uint64 required

Index of the public key.

The index of the account key.

Query parameters

string uint64
OR
'final' | 'sealed'

The block height to query for the account details at the "sealed" is used by default.

expandstring[]

A comma-separated list indicating which properties of the content to expand.

selectstring[]

A comma-separated list indicating which properties of the content to return.

agreeing_executors_countstring uint64

A minimum number of execution receipts for the execution result.

required_executor_idsIdentifier[]

A set of execution node IDs, one of which must have produced the execution result.

include_executor_metadataboolean

Specifies whether or not to include the executor metadata in the response.

Response

OK

indexstring uint64 required

Index of the public key.

public_keystring hex required

Hex encoded public key.

signing_algorithm'BLSBLS12381' | 'ECDSAP256' | 'ECDSASecp256k1' required
hashing_algorithm'SHA2_256' | 'SHA2_384' | 'SHA3_256' | 'SHA3_384' | 'KMAC128' required
sequence_numberstring uint64 required

Current account sequence number.

weightstring uint64 required

Weight of the key.

revokedboolean required

Flag indicating whether the key is active or not.

Example response

{
  "public_key": "public_key",
  "sequence_number": "sequence_number",
  "metadata": {
    "executor_metadata": {
      "execution_result_id": null,
      "executor_ids": [
        null,
        null
      ]
    }
  },
  "index": "index",
  "weight": "weight",
  "signing_algorithm": "BLSBLS12381",
  "revoked": true,
  "hashing_algorithm": "SHA2_256"
}

Changes

  • ef376ce0d11fRevision changes
    • info

      added the new optional query request parameter agreeing_executors_count

    • info

      added the new optional query request parameter include_executor_metadata

    • info

      added the new optional query request parameter required_executor_ids

    • info

      added the optional property to the response with the status

  • 04fb304815f2Revision changes
    • warning

      deleted the query request parameter agreeing_executors_count

    • warning

      deleted the query request parameter include_executor_metadata

    • warning

      deleted the query request parameter required_executor_ids

    • warning

      removed the optional property from the response with the status