Inspect Address

GET /addresses/{addressId}

status: stable

Give useful information about the structure of a given address.

Path parameters

Responses

  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a request is not well-formed; that is, it fails to parse successfully. This could be the case when some required parameters are missing or, when malformed values are provided.

    • code string Required

      Value is bad_request.

  • 200 application/json

    Ok

    Hide response attributes Show response attributes object
    • address_style string Required

      Values are Shelley, Icarus, or Byron.

    • stake_reference string Required

      Values are none, by value, or by pointer.

    • Can be null for 'Icarus' and 'Byron' styles.

      Minimum value is 0.

    • spending_key_hash string(base16)

      Minimum length is 56, maximum length is 56.

    • spending_key_bech32 string(bech32)
    • stake_key_hash string(base16)

      Minimum length is 56, maximum length is 56.

    • stake_key_bech32 string(bech32)
    • script_hash string(base16)

      Minimum length is 64, maximum length is 64.

    • script_hash_bech32 string(bech32)
    • pointer object
      Hide pointer attributes Show pointer attributes object
    • address_root string(base16)

      Only for 'Icarus' and 'Byron' styles.

    • derivation_path string(base16)

      Only for 'Byron' style.

    • The raw type field of the address.

      Details about possible address types are following (refer also to cddl).

      address_type binary prefix Meaning
      0 0000 base address: keyhash28,keyhash28
      1 0001 base address: scripthash28,keyhash28
      2 0010 base address: keyhash28,scripthash28
      3 0011 base address: scripthash28,scripthash28
      4 0100 pointer address: keyhash28, 3 variable length uint
      5 0101 pointer address: scripthash28, 3 variable length uint
      6 0110 enterprise address: keyhash28
      7 0111 enterprise address: scripthash28
      8 1000 byron/icarus
      14 1110 reward account: keyhash28
      15 1111 reward account: scripthash28

      Minimum value is 0, maximum value is 15.

GET /addresses/{addressId}
curl \
 --request GET https://localhost:8090/v2/addresses/DdzFFzCqrhtCNjPk5Lei7E1FxnoqMoAYtJ8VjAWbFmDb614nNBWBwv3kt6QHJa59cGezzf6piMWsbK7sWRB5sv325QqWdRuusMqqLdMt
Response examples (400)
{
  "message": "string",
  "code": "bad_request"
}
Response examples (200)
{
  "address_style": "Shelley",
  "stake_reference": "none",
  "network_tag": 42,
  "spending_key_hash": "string",
  "spending_key_bech32": "string",
  "stake_key_hash": "string",
  "stake_key_bech32": "string",
  "script_hash": "string",
  "script_hash_bech32": "string",
  "pointer": {
    "slot_num": 42,
    "transaction_index": 42,
    "output_index": 42
  },
  "address_root": "string",
  "derivation_path": "string",
  "address_type": 42
}