Staking and yield
Staked SUI with rewards so far, each validator's stake, commission and APY per epoch, and the places on Sui to earn yield.
When to use it
- Show a wallet's stakes and what they have earned.
- Chart a validator's commission and APY over epochs.
- Rank yield options by realized rate and risk.
Quickstart
Replace YOUR_API_KEY with your key from the developer portal, or drop the key header to use the keyless tier. See Quickstart.
1. Read a wallet's stakes
Each stake with its validator and rewards so far.
curl "https://api.tide.ad/v1/wallet/0x4fffd0005522be4bc029724c7f0f6ed7093a6bf3a09b90e62f61dc15181e1a3e/stakes" \
-H "x-api-key: YOUR_API_KEY"2. Read a validator's history
Stake, commission and APY by epoch.
curl "https://api.tide.ad/v1/validators/0x4fffd0005522be4bc029724c7f0f6ed7093a6bf3a09b90e62f61dc15181e1a3e/history?limit=5" \
-H "x-api-key: YOUR_API_KEY"3. List yield options
Where to earn on an asset, with realized rates and a risk readout.
curl "https://api.tide.ad/v1/yield/options?asset=USDC&max_tier=2&sort=apy&limit=5" \
-H "x-api-key: YOUR_API_KEY"API reference
| Method | What it does | Credits |
|---|---|---|
| wallet.stakesGET /v1/wallet/:wallet/stakes | A wallet's staked SUI: validator, status and rewards so far. | 3 |
| validators.historyGET /v1/validators/:address/history | One validator across epochs: stake, voting power, commission, gas price, rewards, APY. | 2 |
| yield.optionsGET /v1/yield/options | Every place on Sui to earn yield: lending, pools, liquid staking and native staking, with realized APY and a risk readout. | 2 |
| yield.planPOST /v1/yield/plan | A ranked menu of 3 to 6 yield options for an amount, with expected USD yield, exit cost, risk and steps; with build: true, the unsigned transactions to do it, checked. | varies |
| yield.withdrawPlanPOST /v1/yield/withdraw-plan | A wallet's staking, liquid staking and lending positions, each with the step that exits it, and the exits built and checked on request. | varies |
Full lists: Staking, Yield. Every method page has its parameters, credits and an example response.