Skip to main content
The Turtle API is one REST API for distributing yield opportunities, running reward campaigns, and reading portfolio data. Most integrations start with Earn and attributed deposits, but the same keys and the same organization also give you Streams and portfolio data. If you already have access and want to ship a deposit, go straight to the Earn quickstart.

​
Get access

You need three things before your first call.
  1. An organization. Create one in the Client Portal, or ask an existing org owner to add you to theirs. Turtle approves new organizations before any keys are issued.
  2. API keys. Keys are issued with the organization. The publishable key (pk_live_) is safe in client-side code and covers reads; the secret key (sk_live_) is server-side only and required for writes such as generating deposits or managing streams. See API Keys.
  3. A distributor ID. Found under Distribution in the Client Portal. You pass it on Earn calls so deposits are attributed to your integration. See the Distributor Model.

​
Products

  • Turtle Earn - Turn a vault interaction into ready-to-sign deposit and withdrawal transactions. Deposits are attributed to your distributor automatically, which is what drives revenue share.
  • Streams - Run points and token incentive campaigns against vault positions. The API handles snapshots, merkle trees, and on-chain claims.
  • Portfolio & Activity - Read what a wallet holds, what it has done, and which deposits flowed through your integration.

​
Shared fundamentals

These apply across every product:
  • API Keys - authenticate every request with the X-API-Key header, and read your rate-limit budget from the response headers.
  • Register Wallet - action endpoints require the user’s wallet to be a registered Turtle member (EIP-4361).
  • Distributor model and deposit modes - the concepts behind attribution and settlement.
  • Error codes and the API explorer - the shared error set and a browsable reference for every endpoint.