Skip to main content
A yield is one earning opportunity on one network: staking, lending, a vault, an LP, or an RWA. Its metadata describes what it accepts, what it currently pays, and exactly what each action on it requires. An action (enter, exit, or manage) requests a state change and returns unsigned transactions: “We construct. You sign.” Once you sign and submit, the position appears in balances, and reward and historical data (current rates, claimable rewards, historical APY and TVL) put it in context.

​
The five concepts

Discover yields

Canonical for finding yields. GET /v1/yields returns the yields enabled for your project, filterable and paginated, not a global catalog.

Yield metadata

Canonical for the full shape of a yield: tokens, rates, mechanics, argument schemas, and live state.

Actions

Canonical for enter, exit, and manage: how a request turns into unsigned transactions.

Balances and positions

Canonical for a position’s lifecycle state after you enter: active, entering, exiting, withdrawable, claimable, or locked.

Rewards and history

Canonical for how rewards are represented and how current rates differ from historical APY and TVL.
For the hands-on version of this flow, run through Quickstart. Yields also carry configurable monetization options.