Skip to main content
Every Earn API call is scoped to a distributor. The distributor is what white-labels vault discovery, ties deposits back to your integration, and drives revenue share. This page is the canonical reference for that model. For the product-level story of who Turtle Earn is for and how the commercial relationship works, see the Turtle Earn overview.

What is a distributor

A distributor is an integration point that embeds Turtle vault opportunities into a product. Each distributor has a unique distributorId that scopes endpoint responses to that integration and tags the deposits it generates.

Distributor vs organization

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

How attribution works

You never call an endpoint to record attribution. It happens on-chain, automatically, off the deposit you generate.
1

Tracking signature embedded

When you generate a deposit transaction with your distributorId, Turtle embeds that ID into the transaction calldata as a tracking signature.
2

On-chain detection

Turtle monitors the supported chains and detects transactions that carry a tracking signature.
3

Deposit attributed

The detected deposit is attributed to your distributor account. No manual call is required.
The POST /v1/actions/attribute endpoint has been removed. Attribution is fully automatic. There is no endpoint to call to record it.
To confirm a specific transaction carries your tracking signature, use Verify Attribution. To pull the full list of deposits attributed to your distributor, use Distributor Activity.

Distributor-scoped opportunities

Each distributor has a curated set of opportunities configured in the Dashboard. 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, so users only see the vaults you have approved. See Get Opportunities for the full object reference and the distributor-scoped endpoint. You can attribute deposits without any API integration. Append your distributorId to any opportunity URL as a query parameter:
https://app.turtle.xyz/earn/opportunities/{slug}?distId={your_distributor_id}
Deposits made through that link trigger the same on-chain attribution as an API-generated deposit. See Share Links for the no-code guide.

Revenue share

Distributors earn a share of the yield generated by the users they onboard. Rates are configured per distributor in the Dashboard and revenue is tracked off the deposits attributed to your distributorId.