Wallet API Client
☞ The renaming of “Ledger Live” to “Ledger Wallet” and “wallet” (in the hardware sense) to “signer” is still in progress. This page may contain legacy references that will be updated.
This page introduces the Wallet API Client: the library Live Apps use to talk to Ledger Wallet and, through it, to the user’s Ledger signer. For when to choose the Wallet API instead of the dApp Browser, see Adding a Live App to the Discover section.
A Live App is a decentralized application that runs inside Ledger Wallet. The Wallet API Client is how that Live App requests accounts, signs messages, and handles transactions. The library ships React hooks and utilities for crypto asset management apps, decentralized exchanges, and other blockchain projects. It also offers a framework-agnostic client for Live Apps that do not use React.
Migration from Platform SDK: If you are migrating from Platform SDK, see the migration guide.
The Wallet API Client is for developers who build Live Apps to embed in Ledger Wallet. It enables communication between a Live App and the user’s Ledger signer through Ledger Wallet . The library does not yet support other use cases, such as web apps connected to Ledger signers through the Ledger Extension .
The client sits between the Live App, Ledger Wallet, and the signer. Its modules, hooks, and utilities cover account management, message signing, and transaction handling. The families appendix lists the blockchains the Wallet API supports and what each family can do.
Main takeaways
Use the Wallet API Client when you are building a Live App inside Ledger Wallet and need typed access to accounts and signing. Start from the Core or React usage guides. Use the migration guide if you are coming from Platform SDK version 1.
