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.

The distributor model is the foundation of the Turtle Earn API. Every API call is scoped to a distributor enabling white-label vault discovery, automated revenue attribution, and partner-specific opportunity sets.

​
What is a distributor

A distributor is an organization that embeds Turtle vault opportunities into their product via the Earn API. Each distributor has a unique distributor_id that scopes all endpoint responses to their integration.

​
How attribution works

1

Tracking signature embedded

When a deposit transaction is generated, Turtle embeds your distributor_id into the transaction calldata as a tracking signature.
2

On-chain detection

Turtle monitors all supported chains and detects transactions containing tracking signatures.
3

Deposit attributed automatically

Detected deposits are attributed to your distributor account automatically. No manual call required.
The POST /v1/actions/attribute endpoint has been removed. Attribution is fully automatic. You do not need to call any endpoint to record attribution.

​
Distributor vs organization

An organization can have multiple distributors. For example, a wallet product might have one distributor for mobile and a separate one for web, each with different opportunity sets configured in the Dashboard. An organization is the top-level entity that manages billing, team members, and settings. A distributor sits within an organization and represents a specific integration point with its own API keys, opportunity selections, and attribution tracking.

​
Distributor-scoped opportunities

Each distributor has a curated set of opportunities configured in the Dashboard. Use the Distributor Opportunities endpoint to fetch only the opportunities enabled for your integration: 
GET /v1/opportunities/distributors/{distributor_id}
This returns the same Opportunity objects as the full catalog, filtered to your selection. Use this to power your app so users only see the vaults you’ve approved. See Distributor Opportunities for full details.

​
Revenue share

Distributors earn a percentage of yield generated by users they onboard. Revenue share rates are configured per-distributor in the Turtle Dashboard. Revenue is tracked automatically based on deposits attributed to your distributor_id.