Skip to main content
The Earn API turns a vault interaction into a set of unsigned, ready-to-sign transactions. You call an action endpoint, the API returns an ordered list of transactions, and the user signs them with any wallet infrastructure. Deposits are attributed to your distributor automatically, with no extra call. For who Turtle Earn is for and how the commercial relationship works, see the Turtle Earn overview. Base URL: https://earn.turtle.xyz
Action endpoints require a registered Turtle member as the user, and most require an API key. See API Keys for the key header and Register Wallet for membership.

​
Before you build

Two concepts shape every deposit. Read them once and the task pages will make sense:

Distributor model

How calls are scoped to your distributor and how deposits get attributed automatically.

Deposit modes

Direct vs swap input, and instant vs async settlement.

​
Tasks

Deposit

Build a deposit, including the swap-mode variant, and broadcast it.

Async deposits

Claim or cancel a deposit that the vault queued for later processing.

Withdraw

Build a withdrawal to redeem shares from a position.

Verify attribution

Confirm a transaction carries your distributor tracking data.

Find opportunities

Discover vaults and the opportunity IDs every action needs.