Responses

• 415 application/json

  Unsupported Media Type

  Hide response attributes Show response attributes object

  • message string Required

    May occur when providing an invalid 'Content-Type' header.

  • code string Required

    Value is unsupported_media_type.

• 409 application/json

  Conflict

  Hide response attributes Show response attributes object

  • message string Required

    May occur when a otherwise valid request would yield a wallet that already exists.

  • code string Required

    Value is wallet_already_exists.

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

  • address_pool_gap integer Required

    Number of consecutive unused addresses allowed.

    IMPORTANT DISCLAIMER: Using values other than 20 automatically makes your wallet invalid with regards to BIP-44 address discovery. It means that you will not be able to fully restore your wallet in a different software which is strictly following BIP-44.

    Beside, using large gaps is not recommended as it may induce important performance degradations. Use at your own risks.

    IMPORTANT DISCLAIMER 2: There is no way to import addresses generated outside (e.g. using cardano-addresses) into the wallet. Wallet only discovers transactions on its used and unused addresses that are within its currently seen address_pool_gap. Transactions on addresses that "belong" to the wallet but happen to be beyond its address_pool_gap will not be visible to the wallet. This is a technical limitation of the industry standard BIP-44. See also CIP-1852.

    Minimum value is 10, maximum value is 100000. Default value is 20.

  • balance object Required

    Wallet current Ada balance(s).

    Hide balance attributes Show balance attributes object

    • available object Required

      Available Ada UTxO balance (funds that can be spent without condition).

      Hide available attributes Show available attributes object

      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is lovelace.

    • reward object Required

      The Ada balance of the reward account for this wallet.

      Hide reward attributes Show reward attributes object

      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is lovelace.

    • total object Required

      Total Ada balance (available balance plus pending change and reward balance).

      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.

  • delegation object Required

    Delegation settings

    Hide delegation attributes Show delegation attributes object

    • active object Required

      Currently active delegation status.

      Hide active attributes Show active attributes object

      • status string Required

        Values are not_delegating, delegating, voting, or delegating_and_voting.

      • target string(hex|bech32)

        A unique Stake-Pool identifier (present only if status = delegating)

      • voting string | string(bech32)

        Decentralized representative (DRep) that the wallet is delegating its vote to. One can abstain, give no confidence vote, or vote for a representative specified by a key hash or script hash. Vote delegation can be done together with stake delegation action.

        One of:

        casting a default vote string vote to a drep represented by key hash string(bech32) vote to a drep represented by script hash string(bech32)

        Values are abstain or no_confidence.

        DRep's key hash.

        Format should match the following pattern: ^(drep)1[0-9a-z]*$.

        DRep's script hash.

        Format should match the following pattern: ^(drep_script)1[0-9a-z]*$.

    • next array[object] Required
      Hide next attributes Show next attributes object

      • status string Required

        Values are not_delegating, delegating, voting, or delegating_and_voting.

      • target string(hex|bech32)

        A unique Stake-Pool identifier (present only if status = delegating)

      • voting string | string(bech32)

        Decentralized representative (DRep) that the wallet is delegating its vote to. One can abstain, give no confidence vote, or vote for a representative specified by a key hash or script hash. Vote delegation can be done together with stake delegation action.

        One of:

        casting a default vote string vote to a drep represented by key hash string(bech32) vote to a drep represented by script hash string(bech32)

        Values are abstain or no_confidence.

        DRep's key hash.

        Format should match the following pattern: ^(drep)1[0-9a-z]*$.

        DRep's script hash.

        Format should match the following pattern: ^(drep_script)1[0-9a-z]*$.

      • changes_at object Required
        Hide changes_at attributes Show changes_at attributes object

        • epoch_number integer Required

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

          Minimum value is 0.

        • epoch_start_time string(iso-8601-date-and-time) Required
  • 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.