Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.turtle.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Turtle Earn is a revenue-sharing product for partners who surface Turtle opportunities within their applications. Embed curated DeFi vault opportunities into your product — every deposit attributed to your integration earns you a share of the yield.

​
How It Works

1

Sign Up

Create an organization in the Client Portal and get approved as a distribution partner. You’ll receive a unique distributor_id that scopes all activity to your integration.
2

Choose Your Integration

Pick the integration method that fits your product — from a no-code referral link to a full API integration. See options below.
3

Curate Opportunities

Select which vault opportunities to surface to your users via the Dashboard. Use the Distributor Opportunities endpoint to fetch only your curated set.
4

Users Deposit

Your users discover and deposit into vaults through your integration. Turtle’s attribution system automatically tracks every deposit back to your distributor ID.
5

Earn Revenue

You earn a percentage of yield generated by users you onboard. Revenue is tracked automatically in the Distribution Dashboard.

​
Integration Options

Turtle Earn offers two integration paths depending on your technical needs. The fastest way to start. Generate a link in the Distribution Dashboard and share it with your audience. Users land on a hosted Turtle deposit page attributed to your distributor. Best for: KOLs, newsletters, content creators, non-technical partners.

Distribution Dashboard

Log in and generate your referral link in seconds.

​
Earn API (Full Integration)

Build a fully custom experience using the Earn API. Generate deposit and withdrawal transactions, query opportunities, and track user activity — all scoped to your distributor.

Earn API Overview

Generate on-chain deposit and withdrawal transactions.

Opportunities API

Fetch your curated opportunity set by distributor ID.

Wallet Activity

Query deposit and withdrawal history for any wallet.

Distributor Model

Understand how attribution and revenue tracking work.

​
Attribution

Every deposit transaction generated through the Earn API embeds your distributor_id into the on-chain calldata. Turtle’s Lumon collector monitors all supported chains and automatically attributes deposits to your integration — no manual calls required. See Distributor Model for the full attribution flow.

​
Revenue Share

Distribution partners earn a percentage of yield generated by the liquidity they route into Turtle vaults. Revenue share rates are configured per-distributor in the Dashboard. Track your attributed volume and estimated earnings in the Distribution Dashboard.

​
Supported Chains

Earn opportunities are available across 20+ chains including Ethereum, Base, Arbitrum, Avalanche, BSC, Optimism, Polygon, Linea, Scroll, and the Katana network — with more being added regularly.

​
Getting Started

  1. Sign up at dashboard.turtle.xyz
  2. Get approved — the Turtle team reviews new organizations
  3. Choose your integration — referral link or API
  4. Start distributing — share opportunities and earn revenue

API Quickstart

Go from zero to your first attributed deposit in five steps.

Earn API Docs

Full API documentation for deposits, withdrawals, and attribution.