Cardano Foundation

Cardano Wallet Backend API

Cardano Wallet Backend API endpoints from Cardano Foundation

Finance & banking#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

<p align="right">
<svg width="18%" style="position: relative; top: -10em; margin-bottom: -12em;" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 375 346.51"><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path d="M102.76,172a25.31,25.31,0,0,0,23.78,26.65c.49,0,1,0,1.46,0A25.26,25.26,0,1,0,102.76,172Z" fill="#0033ad"/><path d="M8.62,165.5a8.16,8.16,0,1,0,7.69,8.61A8.15,8.15,0,0,0,8.62,165.5Z" fill="#0033ad"/><path d="M101.16,25.43a8.16,8.16,0,1,0-11-3.62A8.18,8.18,0,0,0,101.16,25.43Z" fill="#0033ad"/><path d="M126.78,70.1a12.61,12.61,0,1,0-16.94-5.59A12.62,12.62,0,0,0,126.78,70.1Z" fill="#0033ad"/><path d="M40.58,100.82a10.39,10.39,0,1,0-3-14.38A10.39,10.39,0,0,0,40.58,100.82Z" fill="#0033ad"/><path d="M55.93,161a12.62,12.62,0,1,0,11.88,13.31A12.62,12.62,0,0,0,55.93,161Z" fill="#0033ad"/><path d="M42,245.72a10.39,10.39,0,1,0,13.95,4.6A10.37,10.37,0,0,0,42,245.72Z" fill="#0033ad"/><path d="M91,134.89a14.84,14.84,0,1,0-4.27-20.55A14.83,14.83,0,0,0,91,134.89Z" fill="#0033ad"/><path d="M246.47,69.1a12.62,12.62,0,1,0-3.63-17.47A12.61,12.61,0,0,0,246.47,69.1Z" fill="#0033ad"/><path d="M272.35,24.57A8.16,8.16,0,1,0,270,13.26,8.16,8.16,0,0,0,272.35,24.57Z" fill="#0033ad"/><path d="M248.45,147.91a25.25,25.25,0,0,0-2.87,50.42c.49,0,1,0,1.45,0a25.25,25.25,0,0,0,1.42-50.46Z" fill="#0033ad"/><path d="M135.08,133.14A25.12,25.12,0,0,0,157.64,147a25.25,25.25,0,0,0,22.54-36.62,25.25,25.25,0,1,0-45.1,22.73Z" fill="#0033ad"/><path d="M333,100.79a10.39,10.39,0,1,0-14-4.6A10.4,10.4,0,0,0,333,100.79Z" fill="#0033ad"/><path d="M269,108.83a14.84,14.84,0,1,0,19.94,6.58A14.86,14.86,0,0,0,269,108.83Z" fill="#0033ad"/><path d="M186.55,20.76a10.39,10.39,0,1,0-9.79-11A10.38,10.38,0,0,0,186.55,20.76Z" fill="#0033ad"/><path d="M186.43,86.13a14.84,14.84,0,1,0-14-15.66A14.84,14.84,0,0,0,186.43,86.13Z" fill="#0033ad"/><path d="M106,237.68a14.84,14.84,0,1,0-19.93-6.58A14.85,14.85,0,0,0,106,237.68Z" fill="#0033ad"/><path d="M196,107.79a25.22,25.22,0,1,0,21.14-11.41A25.28,25.28,0,0,0,196,107.79Z" fill="#0033ad"/><path d="M239.92,213.37a25.26,25.26,0,1,0-11.18,33.91A25.11,25.11,0,0,0,239.92,213.37Z" fill="#0033ad"/><path d="M284,211.62a14.84,14.84,0,1,0,4.27,20.55A14.84,14.84,0,0,0,284,211.62Z" fill="#0033ad"/><path d="M332.38,173.68a12.62,12.62,0,1,0-13.31,11.88A12.62,12.62,0,0,0,332.38,173.68Z" fill="#0033ad"/><path d="M367.3,164.71a8.16,8.16,0,1,0,7.69,8.61A8.17,8.17,0,0,0,367.3,164.71Z" fill="#0033ad"/><path d="M334.42,245.68a10.39,10.39,0,1,0,3,14.39A10.39,10.39,0,0,0,334.42,245.68Z" fill="#0033ad"/><path d="M102.65,321.94a8.16,8.16,0,1,0,2.34,11.3A8.17,8.17,0,0,0,102.65,321.94Z" fill="#0033ad"/><path d="M273.83,321.08a8.16,8.16,0,1,0,11,3.62A8.16,8.16,0,0,0,273.83,321.08Z" fill="#0033ad"/><path d="M179,238.71a25.25,25.25,0,1,0-21.14,11.41A25.1,25.1,0,0,0,179,238.71Z" fill="#0033ad"/><path d="M128.53,277.41a12.62,12.62,0,1,0,3.63,17.47A12.62,12.62,0,0,0,128.53,277.41Z" fill="#0033ad"/><path d="M187.38,325.74a10.39,10.39,0,1,0,9.78,11A10.39,10.39,0,0,0,187.38,325.74Z" fill="#0033ad"/><path d="M187.49,260.37a14.84,14.84,0,1,0,14,15.67A14.85,14.85,0,0,0,187.49,260.37Z" fill="#0033ad"/><path d="M248.21,276.4a12.62,12.62,0,1,0,17,5.59A12.62,12.62,0,0,0,248.21,276.4Z" fill="#0033ad"/></g></g></svg>
</p>

Endpoints 96

Experimental

  • POSTSign Metadata/wallets/:walletId/signatures/:role/:index<p align="right">status: <strong>experimental</strong></p> ⚠️ WARNING ⚠️ This endpoint is experimental and for internal use in the Catalyst project. This…

Wallets

  • GETList/wallets<p align="right">status: <strong>stable</strong></p> Return a list of known wallets, ordered from oldest to newest.
  • POSTCreate / Restore/wallets<p align="right">status: <strong>stable</strong></p> Create and restore a wallet from a mnemonic sentence or account public key.
  • GETUTxO Statistics/wallets/:walletId/statistics/utxos<p align="right">status: <strong>stable</strong></p> Return the UTxO distribution across the whole wallet, in the form of a histogram. │ 100 ─ │ │ ┌───┐ 10 ─…
  • GETA snapshot of the wallet's UTxO set/wallets/:walletId/utxoGenerate a snapshot of the wallet's UTxO set. This endpoint is intended for debugging purposes.
  • GETGet/wallets/:walletId<p align="right">status: <strong>stable</strong></p>
  • PUTUpdate Metadata/wallets/:walletId<p align="right">status: <strong>stable</strong></p>
  • DELETEDelete/wallets/:walletId<p align="right">status: <strong>stable</strong></p>
  • PUTUpdate Passphrase/wallets/:walletId/passphrase<p align="right">status: <strong>stable</strong></p>

Assets

  • GETList Assets/wallets/:walletId/assetsList all assets associated with the wallet, and their metadata if known. An asset is _associated_ with a wallet if, at one point in history, it was spendable…
  • GETGet Asset/wallets/:walletId/assets/:policyId/:assetNameFetch a single asset from its policy_id and asset_name, with its metadata if any. The asset must be associated with the wallet.
  • GETGet Asset (empty name)/wallets/:walletId/assets/:policyIdFetch the asset from policy_id with an empty name. The asset must be associated with the wallet.

Transactions

  • POSTEstimate Fee/wallets/:walletId/payment-fees<p align="right">status: <strong>stable</strong></p> Estimate fee for the transaction. The estimate is made by assembling multiple transactions and analyzing…
  • GETList/wallets/:walletId/transactions<p align="right">status: <strong>stable</strong></p> Lists all incoming and outgoing wallet's transactions.
  • POSTCreate/wallets/:walletId/transactions<p align="right">status: <strong>stable</strong></p> Create and send transaction from the wallet.
  • GETGet/wallets/:walletId/transactions/:transactionId<p align="right">status: <strong>stable</strong></p> Get transaction by id.
  • DELETEForget/wallets/:walletId/transactions/:transactionId<p align="right">status: <strong>stable</strong></p> Forget pending transaction. Importantly, a transaction, when sent, cannot be cancelled. One can only…

Transactions New

  • POSTConstruct/wallets/:walletId/transactions-construct<p align="right">status: <strong>stable</strong></p> Create a transaction to be signed from the wallet.
  • POSTSign/wallets/:walletId/transactions-sign<p align="right">status: <strong>stable</strong></p> Signs a serialised transaction either hex-encoded or base64-encoded, returning the modified transaction.…
  • POSTDecode/wallets/:walletId/transactions-decode<p align="right">status: <strong>stable</strong></p> Decode a serialized transaction, either freshly constructed, partially signed or fully-signed.
  • POSTSubmit/wallets/:walletId/transactions-submit<p align="right">status: <strong>stable</strong></p> Submit a transaction that was already created and signed. Fails for foreign transactions that is…
  • POSTBalance/wallets/:walletId/transactions-balance<p align="right">status: <strong>under development</strong></p> Balance a transaction body of a given transaction, add needed inputs/outputs, so as the…

Addresses

  • GETList/wallets/:walletId/addresses<p align="right">status: <strong>stable</strong></p> Return a list of known addresses, ordered from newest to oldest
  • GETInspect Address/addresses/:addressId<p align="right">status: <strong>stable</strong></p> Give useful information about the structure of a given address.
  • POSTConstruct Address/addresses<p align="right">status: <strong>stable</strong></p> Construct any address by specyfying credential for payment or delegation. In Cardano, Addresses are made…

Keys

  • POSTCreate Account Public Key/wallets/:walletId/keys/:index<p align="right">status: <strong>stable</strong></p> Derive an account public key for any account index. For this key derivation to be possible, the wallet…
  • GETGet Account Public Key/wallets/:walletId/keys<p align="right">status: <strong>stable</strong></p> Retrieve the account public key of this wallet. To get an extended public key, instead of the public key,…
  • GETGet Public Key/wallets/:walletId/keys/:role/:index<p align="right">status: <strong>stable</strong></p> Return a public key for a given role and derivation index. To get a hash of the public key, instead of…
  • POSTCreate Policy Id/wallets/:walletId/policy-id<p align="right">status: <strong>stable</strong></p> Create policy id for the wallet and a given mint/burn script.
  • GETGet Policy Key/wallets/:walletId/policy-key<p align="right">status: <strong>stable</strong></p> Return a policy key for a derivation index = 0. To get a hash of the policy key instead of the policy…
  • POSTCreate Policy Key/wallets/:walletId/policy-key<p align="right">status: <strong>stable</strong></p> Create policy key for the wallet. In order to be able to mint/burn assets with POST Construct endpoint…

Stake Pools

  • GETList Stake Keys/wallets/:walletId/stake-keys<p align="right">status: <strong>Experimental</strong></p> List stake-keys relevant to the wallet, and how much ada is associated with each.
  • GETList/stake-pools?stake=0<p align="right">status: <strong>stable</strong></p> List all known stake pools ordered by descending non_myopic_member_rewards. The non_myopic_member_rewards…
  • GETView Maintenance Actions/stake-pools/maintenance-actionsReturns the current status of the stake pools maintenance actions.
  • POSTTrigger Maintenance Actions/stake-pools/maintenance-actionsPerforms maintenance actions on stake pools, such as triggering metadata garbage collection. Actions may not be instantaneous.
  • GETEstimate Fee/wallets/:walletId/delegation-fees<p align="right">status: <strong>stable</strong></p> Estimate fee for joining or leaving a stake pool. Note that it is an estimation because a delegation…
  • DELETEQuit/stake-pools/*/wallets/:walletId<p align="right">status: <strong>stable</strong></p> Stop delegating completely. The wallet's stake will become inactive. Any current rewards will…
  • PUTJoin/stake-pools/:stakePoolId/wallets/:walletId<p align="right">status: <strong>stable</strong></p> Delegate all (current and future) addresses from the given wallet to the given stake pool.…

DReps

  • GETList Registered DReps/dreps<p align="right">status: <strong>stable</strong></p> Returns all DRep registrations known to the local node, with voting power inline. Only credential-based…
  • GETDRep Summary/dreps/summary<p align="right">status: <strong>stable</strong></p> Returns aggregate statistics for all registered DReps: total staked voting power, active count, inactive…
  • GETSuggested DReps/dreps/suggested<p align="right">status: <strong>stable</strong></p> Returns a random selection of DReps suitable for delegation. DReps are ranked by delegated voting power.…
  • GETGet DRep/dreps/:drepId<p align="right">status: <strong>stable</strong></p> Returns full data for the given DRep, including the complete CIP-0119 off-chain metadata in the metadata…
  • PUTJoin/dreps/:drepId/wallets/:walletId<p align="right">status: <strong>stable</strong></p> Delegate all votes from the given wallet to the given DRep or case abstain or no-confidence

Coin Selections

  • POSTRandom/wallets/:walletId/coin-selections/random<p align="right">status: <strong>stable</strong></p> Select coins to cover the given set of payments. Uses the <a…

Migrations

  • POSTMigrate/wallets/:walletId/migrationsMigrate the UTxO balance of this wallet to the given set of addresses. This operation will attempt to transfer as much of the wallet's balance as possible to…
  • POSTCreate a migration plan/wallets/:walletId/migrations/planGenerate a plan for migrating the UTxO balance of this wallet to another wallet, without executing the plan. This operation generates a plan that transfers as…

Byron Wallets

  • GETList/byron-wallets<p align="right">status: <strong>stable</strong></p> Return a list of known Byron wallets, ordered from oldest to newest.
  • POSTRestore/byron-wallets<p align="right">status: <strong>stable</strong></p> Restore a Byron wallet from a mnemonic sentence or encrypted root private key (deprecated). ⚠️ WARNING ⚠️…
  • GETUTxO Statistics/byron-wallets/:walletId/statistics/utxos<p align="right">status: <strong>stable</strong></p> Return the UTxO distribution across the whole wallet, in the form of a histogram. │ 100 ─ │ │ ┌───┐ 10 ─…
  • GETA snapshot of the wallet's UTxO set/byron-wallets/:walletId/utxoGenerate a snapshot of the wallet's UTxO set. This endpoint is intended for debugging purposes.
  • GETGet/byron-wallets/:walletId<p align="right">status: <strong>stable</strong></p> Return information about a Byron wallet.
  • PUTUpdate Metadata/byron-wallets/:walletId<p align="right">status: <strong>stable</strong></p>
  • DELETEDelete/byron-wallets/:walletId<p align="right">status: <strong>stable</strong></p> Delete a Byron wallet.
  • PUTUpdate Passphrase/byron-wallets/:walletId/passphrase<p align="right">status: <strong>stable</strong></p>

Byron Assets

  • GETList Assets/byron-wallets/:walletId/assetsList all assets associated with the wallet, and their metadata if known. An asset is _associated_ with a wallet if it is involved in a transaction of the…
  • GETGet Asset/byron-wallets/:walletId/assets/:policyId/:assetNameFetch a single asset from its policy_id and asset_name, with its metadata if any. The asset must be associated with the wallet.
  • GETGet Asset (empty name)/byron-wallets/:walletId/assets/:policyIdFetch the asset from policy_id with an empty name. The asset must be associated with the wallet.

Byron Addresses

  • GETList/byron-wallets/:walletId/addresses<p align="right">status: <strong>stable</strong></p> Return a list of known addresses, ordered from newest to oldest for sequential wallets. Arbitrarily…
  • PUTImport Addresses/byron-wallets/:walletId/addresses<p align="right">status: <strong>stable</strong></p> ⚠️ This endpoint is available for random wallets only. Any attempt to call this endpoint on another type…
  • POSTCreate Address/byron-wallets/:walletId/addresses<p align="right">status: <strong>stable</strong></p> ⚠️ This endpoint is available for random wallets only. Any attempt to call this endpoint on another type…
  • PUTImport Address/byron-wallets/:walletId/addresses/:addressId<p align="right">status: <strong>stable</strong></p> ⚠️ This endpoint is available for random wallets only. Any attempt to call this endpoint on another type…

Byron Transactions

  • POSTEstimate Fee/byron-wallets/:walletId/payment-fees<p align="right">status: <strong>stable</strong></p> Estimate fee for the transaction.
  • GETList/byron-wallets/:walletId/transactions<p align="right">status: <strong>stable</strong></p> List all incoming and outgoing transactions for the given wallet.
  • POSTCreate/byron-wallets/:walletId/transactions<p align="right">status: <strong>stable</strong></p> Create and send transaction from the wallet.
  • GETGet/byron-wallets/:walletId/transactions/:transactionId<p align="right">status: <strong>stable</strong></p> Get transaction by id.
  • DELETEForget/byron-wallets/:walletId/transactions/:transactionId<p align="right">status: <strong>stable</strong></p> Forget pending Byron transaction. Importantly, a transaction, when sent, cannot be cancelled. One can…

Byron Coin Selections

  • POSTRandom/byron-wallets/:walletId/coin-selections/random<p align="right">status: <strong>stable</strong></p> Select coins to cover the given set of payments. Uses the <a…

Byron Migrations

  • POSTMigrate/byron-wallets/:walletId/migrationsMigrate the UTxO balance of this wallet to the given set of addresses. This operation will attempt to transfer as much of the wallet's balance as possible to…
  • POSTCreate a migration plan/byron-wallets/:walletId/migrations/planGenerate a plan for migrating the UTxO balance of this wallet to another wallet, without executing the plan. This operation generates a plan that transfers as…

Network

  • GETInformation/network/information<p align="right">status: <strong>stable</strong></p>
  • GETClock/network/clock<p align="right">status: <strong>stable</strong></p>
  • GETParameters/network/parameters<p align="right">status: <strong>stable</strong></p> Returns the set of network parameters for the current epoch.

Proxy

  • POSTSubmit External Transaction/proxy/transactions<p align="right">status: <strong>stable</strong></p> Submits a transaction that was created and signed outside of cardano-wallet. NOTE: Unlike the…

Settings

  • GETGet settings/settings<p align="right">status: <strong>stable</strong></p> Return the current settings.
  • PUTUpdate settings/settings<p align="right">status: <strong>stable</strong></p> Overwrite current settings.

Utils

  • GETCurrent SMASH health/smash/healthGet health status of the currently active SMASH server.

Shared Wallets

  • GETList/shared-wallets<p align="right">status: <strong>stable</strong></p> Return a list of known shared wallets, ordered from oldest to newest.
  • POSTCreate/shared-wallets<p align="right">status: <strong>stable</strong></p> Create a shared wallet from either an account public key and script templates or mnemonic and script…
  • GETGet/shared-wallets/:walletId<p align="right">status: <strong>stable</strong></p> Get a shared wallet for a given wallet id.
  • PUTUpdate Metadata/shared-wallets/:walletId<p align="right">status: <strong>stable</strong></p>
  • DELETEDelete/shared-wallets/:walletId<p align="right">status: <strong>stable</strong></p>
  • GETUTxO Statistics/shared-wallets/:walletId/statistics/utxos<p align="right">status: <strong>stable</strong></p> Return the UTxO distribution across the whole wallet, in the form of a histogram. │ 100 ─ │ │ ┌───┐ 10 ─…
  • GETA snapshot of the wallet's UTxO set/shared-wallets/:walletId/utxoGenerate a snapshot of the wallet's UTxO set. This endpoint is intended for debugging purposes.
  • PATCHUpdate Payment/shared-wallets/:walletId/payment-script-template<p align="right">status: <strong>stable</strong></p> Update payment script template for a given shared wallet by updating/adding account public key for…
  • PATCHUpdate Delegation/shared-wallets/:walletId/delegation-script-template<p align="right">status: <strong>stable</strong></p> Update delegation script template for a given shared wallet by updating/adding account public key for…

Shared Transactions

  • POSTConstruct/shared-wallets/:walletId/transactions-construct<p align="right">status: <strong>stable</strong></p> Create a transaction to be signed from the shared wallet. Works for the following fields: payments…
  • POSTDecode/shared-wallets/:walletId/transactions-decode<p align="right">status: <strong>stable</strong></p> Decode a serialized transaction, either freshly constructed, partially signed or fully-signed.
  • POSTSign/shared-wallets/:walletId/transactions-sign<p align="right">status: <strong>stable</strong></p> Signs a serialised transaction, returning the modified transaction. This endpoint will add new witnesses…
  • POSTSubmit/shared-wallets/:walletId/transactions-submit<p align="right">status: <strong>stable</strong></p> Submit a transaction that was already created and fully signed. Fails for foreign transactions that is…
  • GETList/shared-wallets/:walletId/transactions<p align="right">status: <strong>stable</strong></p> Lists all incoming and outgoing wallet's transactions.
  • GETGet/shared-wallets/:walletId/transactions/:transactionId<p align="right">status: <strong>stable</strong></p> Get transaction by id.

Shared Keys

  • POSTCreate Account Public Key/shared-wallets/:walletId/keys/:index<p align="right">status: <strong>stable</strong></p> Derive an account public key for any account index. For this key derivation to be possible, the wallet…
  • GETGet Account Public Key/shared-wallets/:walletId/keys<p align="right">status: <strong>stable</strong></p> Retrieve the account public key of this shared wallet. To get an extended public key, instead of the…
  • GETGet Public Key/shared-wallets/:walletId/keys/:role/:index<p align="right">status: <strong>stable</strong></p> Return a public key for a given role and derivation index for a shared wallet. To get a hash of the…

Shared Addresses

  • GETList/shared-wallets/:walletId/addresses<p align="right">status: <strong>stable</strong></p> Return a list of known addresses, ordered from newest to oldest

Node

  • GETBlock Header/blocks/latest/header<p align="right">status: <strong>stable</strong></p> Return the latest block-header available at the chain source

API details

Base URL
https://localhost:8090/v2
Authentication
None declared in the description
Operations
96 operations on 78 pathsGET 47POST 31PUT 10DELETE 6PATCH 2
Main resources
Shared Wallets 9Byron Wallets 8Wallets 8Stake Pools 7Keys 6Shared Transactions 6Byron Transactions 5DReps 5Transactions 5Transactions New 5
Response formats
application/json application/octet-stream
Description format
OpenAPI 3.0.3, API version v2026-10-07

How to test the Cardano Wallet Backend API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cardano Wallet Backend API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Sign Metadata” (POST /wallets/:walletId/signatures/:role/:index), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cardano Wallet Backend API?

Cardano Wallet Backend API endpoints from Cardano Foundation It is listed under Finance & banking and has 96 endpoints.

Who publishes the Cardano Wallet Backend API?

It is listed from Cardano Foundation's public API description (an OpenAPI document), not published by Cardano Foundation on Swastik Codes. Anyone who controls cardanofoundation.org can claim the profile by adding a DNS TXT record.

What is the base URL of the Cardano Wallet Backend API?

Requests go to https://localhost:8090/v2. Endpoint paths are added to this base URL.

How do I authenticate with the Cardano Wallet Backend API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Cardano Wallet Backend API have?

96 operations on 78 paths (47 GET, 31 POST, 10 PUT, 6 DELETE, 2 PATCH). The largest groups are Shared Wallets, Byron Wallets, Wallets, Stake Pools.

Is forking the Cardano Wallet Backend API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.