Skip to main content

Documentation Index

Fetch the complete documentation index at: https://yieldxyz.mintlify.app/llms.txt

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

​
DataKit

DataKit is Yield.xyz’s data layer for yield discovery, portfolio tracking, rewards, and analytics — designed to work with or without transaction execution. It serves three common integration needs:
  • Discover and compare yield opportunities across the Yield.xyz catalog
  • Track positions and rewards with lifecycle-aware portfolio data
  • Go deeper with premium history and external (non-originating) position coverage
Pricing principle: Clients should never pay for the data required to launch and operate yield products. DataKit is included for Yield.xyz-originated positions and billed only for premium historical/external data beyond that scope.

​
What DataKit includes

Yield discovery metadata

Discovery-ready yield catalog, including the data you need to list opportunities in-product (APY/TVL signals, protocol and network context, mechanics).

Portfolio & position tracking

Normalized balances and position states across networks and yield types, designed for user-facing UX and operations.

Rewards & balance tracking

Reward accrual tracking and balance slices for Yield.xyz-originated positions starting from the moment a user enters via Yield.xyz.

Historical & external positions (premium)

Deeper history and analytics for positions created outside Yield.xyz (imports, migrations, external wallets) and long-range historical queries.

​
Baseline vs Premium

Baseline DataKit is included by default when tied to positions that originate through Yield.xyz.Included in baseline:
  • Yield catalog and discovery metadata (including what’s required to render yields in UX)
  • Position balances for Yield.xyz-originated positions
  • Reward accrual tracking from the moment a user enters via Yield.xyz
  • Transaction history related to Yield.xyz-originated positions
If a user enters through Yield.xyz, you can power the full end-user experience for that position (discovery → portfolio → rewards) without separate “data product” billing.

​
How DataKit is priced

DataKit is intentionally designed to avoid pricing models that penalize large wallets or create unpredictable bills.
We do not charge per end-user, per wallet count, or based on a client’s user base size.
Baseline yield data usage is not designed to rack up large bills simply for normal product operation.
Premium DataKit access is billed via Compute Units for historical/external queries and advanced analytics, as defined in the Compute Unit contract.
Standard / Pro / Enterprise tiers include baseline DataKit usage.
Premium DataKit is an add-on that can be introduced later, without blocking launch.
A practical way to scope DataKit:
Baseline covers everything required to ship and operate Yield.xyz-powered products.
Premium is for imports, migrations, and deep history that goes beyond Yield.xyz origin.

​
Pricing & enablement

Baseline DataKit is included for Yield.xyz-originated positions. Premium DataKit access (historical and external coverage) is metered via Compute Units.

Plans, limits & Compute Units

See how premium DataKit usage is metered, what’s included by plan, and how Compute Units map to your expected usage.

Enable Premium DataKit

Share your environment and whether you need historical and/or external positions. We’ll confirm pricing, limits, and the right setup for your project.

​
What to expect from the API

DataKit is designed to feel consistent across protocols and networks by normalizing yield and portfolio data behind a stable model.
Use DataKit to power browsing, filtering, and approvals: yield mechanics, protocol and network context, and the metadata required to list yields in your product.
Track positions using lifecycle-aware balance states (e.g., active, entering, exiting, claimable) to support reliable UX and reporting.
For Yield.xyz-originated positions, reward accrual starts from entry and remains available for ongoing UX and reporting.
For non-originating positions, full historical rewards may require premium access.
Enable deep history and portfolio views for positions created outside Yield.xyz, including imported wallets and migrated positions.

​
When you need Premium

You likely need Premium DataKit if you want to:
  • Import users’ existing positions from other wallets/providers
  • Show rewards history that predates entry via Yield.xyz
  • Provide broad portfolio analytics not scoped to Yield.xyz actions
  • Offer historical reporting across non-originating positions
If you only need to:
  • List yields
  • Track positions created via Yield.xyz
  • Show rewards from the moment of entry
    …baseline coverage is sufficient.

​
Coverage and fit

Ecosystem scale

Normalized yield data across 80+ networks and 2,900+ yield opportunities (catalog evolves over time).

Protocol breadth

Coverage across 30+ staking providers and 40+ DeFi protocols, with consistent discovery and portfolio primitives.

Built for wallets and fintechs

Keep UX unblocked and costs predictable — no per-user pricing for baseline usage.

Institutional-ready

Clear origin boundaries, predictable premium metering, and an architecture compatible with regulated custody environments.

​
Security and trust (high-level)

  • Non-custodial architecture: Yield.xyz does not custody funds or private keys.
  • SOC 2 Type I is completed; SOC 2 Type II is in progress.
  • For transaction-intent validation (when executing), Shield can be used as part of your signing flow.

​
Next steps

Quickstart

Run the end-to-end integration flow.

Plans & Limits

Understand tiers and compute-unit billing for premium access.

API Reference: Discovery

Explore yield discovery endpoints.

API Reference: Portfolio

Explore balances and portfolio endpoints.