Create Address

POST /byron-wallets/{walletId}/addresses

status: stable

⚠️ This endpoint is available for random wallets only. Any attempt to call this endpoint on another type of wallet will result in a 403 Forbidden error from the server.

Path parameters

  • walletId string(hex) Required

    Minimum length is 40, maximum length is 40.

application/json

Body Required

  • passphrase string Required

    A master passphrase to lock and protect the wallet for sensitive operation (e.g. sending funds)

    Minimum length is 0, maximum length is 255.

  • An address derivation index.

    Minimum value is 0, maximum value is 4294967295.

Responses

  • 415 application/json

    Unsupported Media Type

    Hide response attributes Show response attributes object
    • message string Required

      A descriptive error message.

    • code string Required

      A specific error code for this error, more precise than HTTP ones.

  • 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.

  • 403 application/json

    Forbidden

    Hide response attributes Show response attributes object
    • message string Required

      A descriptive error message.

    • code string Required

      A specific error code for this error, more precise than HTTP ones.

  • 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.

  • 201 application/json

    Created

    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.

POST /byron-wallets/{walletId}/addresses
curl \
 --request POST https://localhost:8090/v2/byron-wallets/{walletId}/addresses \
 --header "Content-Type: application/json" \
 --data '{"passphrase":"Secure Passphrase","address_index":42.0}'
Request examples
{
  "passphrase": "Secure Passphrase",
  "address_index": 42.0
}
Response examples (415)
{
  "message": "string",
  "code": "an_error_code"
}
Response examples (406)
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (403)
{
  "message": "string",
  "code": "an_error_code"
}
Response examples (400)
{
  "message": "string",
  "code": "bad_request"
}
Response examples (201)
{
  "id": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
  "state": "used",
  "derivation_path": [
    "1852H"
  ]
}