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.

• 409 application/json

  Conflict

  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.

• 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(hex) Required

    A unique identifier for the wallet

    Minimum length is 40, maximum length is 40.

  • balance object Required

    Byron wallet's current balance(s)

    Hide balance attributes Show balance attributes object

    • available object Required

      Available balance (funds that can be spent)

      Hide available attributes Show available attributes object

      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is lovelace.

    • total object Required

      Total balance (available balance plus pending change)

      Hide total attributes Show total attributes object

      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is lovelace.

  • assets object Required

    Current non-Ada asset holdings of the wallet.

    The amount of assets available to spend may be less than the total unspent assets due to transaction change amounts which are yet to be fully confirmed (pending).

    Hide assets attributes Show assets attributes object

    • available array[object] Required

      Available UTxO asset balances (funds that can be spent without condition).

      Hide available attributes Show available attributes object

      • policy_id string(hex) Required

        A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.

        The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.

        Minimum length is 56, maximum length is 56.

      • asset_name string(hex) Required

        The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.

        For policies with a single fungible asset item, asset name is typically an empty string.

        This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).

        Maximum length is 64.

      • quantity integer Required

        Number of assets for the given policy_id and asset_name.

        Minimum value is 0.

    • total array[object] Required

      Total asset balances (available balances plus pending change balances).

      Hide total attributes Show total attributes object

      • policy_id string(hex) Required

        A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.

        The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.

        Minimum length is 56, maximum length is 56.

      • asset_name string(hex) Required

        The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.

        For policies with a single fungible asset item, asset name is typically an empty string.

        This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).

        Maximum length is 64.

      • quantity integer Required

        Number of assets for the given policy_id and asset_name.

        Minimum value is 0.

  • discovery string Required

    Mechanism used for discovering addresses.

    Values are random or sequential.

  • name string Required

    Minimum length is 1, maximum length is 255.

  • passphrase object

    Information about the wallet's passphrase

    Hide passphrase attribute Show passphrase attribute object

    • last_updated_at string(iso-8601-date-and-time) Required
  • state object Required

    Whether a wallet is ready to use or still syncing

    Hide state attributes Show state attributes object

    • status string Required

      Values are ready, syncing, or not_responding.

    • progress object

      if: status == syncing
      

      Hide progress attributes Show progress attributes object

      • quantity number Required

        Minimum value is 0, maximum value is 100.

      • unit string Required

        Value is percent.

  • tip object Required

    A reference to a particular time slot, and the block height at that point.

    Hide tip attributes Show tip attributes object

    • absolute_slot_number integer Required

      The 0-based slot index starting from genesis of the blockchain.

      Minimum value is 0.

    • slot_number integer Required

      The zero-based slot index within an epoch.

      Minimum value is 0.

    • epoch_number integer Required

      An epoch is a time period which is divided into slots.

      Minimum value is 0.

    • time string(iso-8601-date-and-time) Required
    • height object Required
      Hide height attributes Show height attributes object

      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is block.