List

GET /byron-wallets/{walletId}/addresses

status: stable

Return a list of known addresses, ordered from newest to oldest for sequential wallets. Arbitrarily ordered for random wallets.

Path parameters

  • walletId string(hex) Required

    Minimum length is 40, maximum length is 40.

Query parameters

  • state string

    An optional filter on the address state.

    Values are used or unused.

Responses

  • 406 application/json

    Not Acceptable

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Accept' header.

    • code string Required

      Value is not_acceptable.

  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a given walletId does not match with any known wallets (because it has been deleted, or has never existed).

    • code string Required

      Value is no_such_wallet.

    • info object
      Hide info attribute Show info attribute object
      • wallet_id string(hex) Required

        A unique identifier for the wallet

        Minimum length is 40, maximum length is 40.

  • 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
    • id string(base58|bech32) Required

      A sequence of characters that encodes (in Base58 or Bech32) a sequence of bytes which represents an address on the Cardano blockchain. Sequences in Base58 encoding are expected to be legacy Byron addresses, whereas sequences in Bech32 encoding correspond to current Shelley addresses.

      For more details, see CIP-0019 — Cardano addresses .

    • state string Required

      Values are used or unused.

    • derivation_path array[string] Required

      An individual segment within a derivation path.

      The H suffix indicates a Hardened child private key, which means that children of this key cannot be derived from the public key. Indices without a H suffix are called Soft.

      At least 1 element.

GET /byron-wallets/{walletId}/addresses
curl \
 --request GET https://localhost:8090/v2/byron-wallets/{walletId}/addresses
Response examples (406)
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (404)
{
  "message": "string",
  "code": "no_such_wallet",
  "info": {
    "wallet_id": "2512a00e9653fe49a44a5886202e24d77eeb998f"
  }
}
Response examples (400)
{
  "message": "string",
  "code": "bad_request"
}
Response examples (200)
[
  {
    "id": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
    "state": "used",
    "derivation_path": [
      "1852H"
    ]
  }
]