enter, exit, or manage) requests a change to a position and returns unsigned transactions for you to sign. Once you sign and submit them, the position appears in balances, split by state and listing its pending actions, and reward and history data (current rates, claimable rewards, historical APY and TVL) put it in context.
The five concepts
Discover yields
Find yields with
GET /v1/yields, which returns only the yields enabled for your project, filterable and paginated.Yield metadata
The full shape of a yield: tokens, rates, risk ratings, mechanics, fees, argument schemas, and live state.
Actions
How an
enter, exit, or manage request turns into unsigned transactions, and how you track them.Balances and positions
A position’s state after you enter (active, entering, exiting, withdrawable, claimable, or locked) and the actions available on it.
Rewards and history
How rewards are represented, and how current rates differ from historical APY and TVL.