Skip to main content
Before implementing yield features in your application, you’ll need to retrieve essential information such as APY rates, minimum deposit requirements, and other terms. This guide explains how to fetch this data using our API endpoints.
In the yield category, we encompass various passive income-generating activities in DeFi. This includes lending (where users earn interest by providing liquidity), investing in yield-generating vaults (which automatically compound returns), and staking (where users lock tokens to earn rewards).

​
Introduction

​
Authentication

Every request requires:
  • The key identifies your customer. Fee configuration and strategy catalog are scoped to it.
  • Success responses are the bare JSON body (HTTP 200). Errors use { "error": { "code", "message", "details?" } }.
  • Keep the API key on your backend — never expose it in a browser app.
Don’t have a key yet? Get an API key.

​
Integration flow

1

Get Available Protocols

First, retrieve the list of all supported protocols:
The JSON body is { "data": [ …strategies ], "pagination": { … } }. Use pagination.hasMore, pagination.total, and pagination.totalPages to page through results. Query parameters include page, limit (default limit is 100), network, protocol, and category to filter results. See the OpenAPI description for the full ListPagination shape.
2

Query Protocol Details

Then, fetch specific protocol information using:
Required Parameters:Example Request:
Full guide: Get available protocols.
3

Deposit

Generate deposit bytecode, then execute the returned bytecode[] on-chain (batch legs on the same chain into one atomic transaction):
4

Track deposit status

Same-chain deposits confirm with the on-chain receipt. Cross-chain deposits settle asynchronously — poll with the id from the deposit bytecode response until it completes:
Full guide: Deposit to Yield.
5

Check open positions

Read the wallet’s live positions — principal, profit, and any pending requests:
Full guide: Check Positions.
6

Withdraw

Generate withdraw bytecode, then execute it on-chain. Cross-chain withdrawals are async — track them via GET /actions/:id:
Full guide: Withdraw from Yield.

​
UI Integration Example

Protocol Selection UI Example UI implementation showing protocol selection

​
Next Steps

Get available protocols

List strategies and read a strategy’s details

Deposit to Yield

Execute a deposit into a yield protocol