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 Streams API lets you create and manage incentive distributions tied to vault positions. Use it to run points campaigns, distribute tokens to depositors, and track wallet-level reward accumulation.

Create Stream

Create a new token or points incentive stream.

Get Streams

List and filter streams for your organization.

Get Stream Wallets

List participating wallets and their snapshots.

Get Wallet Data

View a single wallet’s accumulated rewards in a stream.

​
What is a stream

A stream is an on-chain incentive distribution tied to a set of vault positions. You define the reward token or point type, the start and end time, and the total amount to distribute. The Streams API handles the rest including merkle tree computation, snapshot scheduling, and on-chain commitment.

​
Points vs token streams

The API supports two stream types:
  • Points streams use off-chain point systems. Points are tracked by Turtle and can be queried per wallet. They are useful for gamification, loyalty programs, and pre-token incentive campaigns.
  • Token streams distribute ERC-20 tokens on-chain via a smart contract. Token allocations are computed per snapshot and committed to a merkle tree that users can claim against.