☞ 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.
Earn dashboard integration
The Earn section in Ledger Wallet shows users their active staking positions. For each account used for staking, it displays:
- Staked amount: total assets delegated or locked in the account.
- Rewards %: the net APY (Annual Percentage Yield) for the position.
- Rewards earned: cumulative rewards to date, including any that have been claimed.
To populate these fields, Ledger Wallet‘s backend queries your service through standardised APIs described on this page.
Required endpoints
Your service must expose an API that, for each account used for staking, returns the data listed above. Depending on your protocol, this data may need to be broken down by validator address and/or pool ID, and include a rewards breakdown for specified time windows (for example, last 24 hours, last 7 days).
The full endpoint specifications, request/response schemas, and example payloads are in the Earn API reference.
Connection details to share with Ledger
Once your API is ready, provide Ledger with:
| Detail | Description |
|---|---|
| Base URL | The root URL of your API (e.g. https://api.yourprotocol.com) |
| Authentication | Any token, header, or credential required to call the API |
| Refresh rate | How quickly positions and rewards reflect on-chain state |
| Rate limit | Your API’s rate limit; the desired target is unlimited |
| Health codes | HTTP status codes that indicate the API is up (e.g. 200, 404) vs. down (e.g. 500, timeout) |
Related
- Earn integration overview — the three components required for an Earn integration
- Earn API reference — full endpoint specifications
- LiveApp — the frontend component of the Earn integration
- Clear Signing — the mandatory security component
