> ## Documentation Index
> Fetch the complete documentation index at: https://yieldxyz.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# DataKit

> Yield data and analytics — included for Yield.xyz-originated positions, billed only for historical/external data.

# 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

<Note>
  **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.
</Note>

***

## What DataKit includes

<CardGroup cols={2}>
  <Card title="Yield discovery metadata" icon="magnifying-glass">
    Discovery-ready yield catalog, including the data you need to list opportunities in-product (APY/TVL signals, protocol and network context, mechanics).
  </Card>

  <Card title="Portfolio & position tracking" icon="wallet">
    Normalized balances and position states across networks and yield types, designed for user-facing UX and operations.
  </Card>

  <Card title="Rewards & balance tracking" icon="coins">
    Reward accrual tracking and balance slices for Yield.xyz-originated positions starting from the moment a user enters via Yield.xyz.
  </Card>

  <Card title="Historical & external positions (premium)" icon="clock">
    Deeper history and analytics for positions created outside Yield.xyz (imports, migrations, external wallets) and long-range historical queries.
  </Card>
</CardGroup>

***

## Baseline vs Premium

<Tabs>
  <Tab title="Baseline (included)">
    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

    <Tip>
      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.
    </Tip>
  </Tab>

  <Tab title="Premium (add-on)">
    Premium DataKit applies only when clients need data **beyond Yield.xyz origin** or additional depth.

    **Premium use cases:**

    * Historical performance and rewards **before** a position entered via Yield.xyz
    * Positions created outside Yield.xyz (imported wallets, migrations, other providers)
    * Full historical rewards for non-originating positions
    * Portfolio analytics and scans not tied to Yield.xyz actions
    * Advanced or non-standard data access patterns

    **How premium is billed:**

    * Premium access is metered via **Compute Units** (contract-defined).
    * This makes billing linear and predictable for production-scale integrations.

    <Warning>
      Premium DataKit is **not required** to launch Earn/Yield products.\
      Most teams start with baseline and add premium only when they need imported portfolios or deep historical reporting.
    </Warning>
  </Tab>
</Tabs>

***

## How DataKit is priced

DataKit is intentionally designed to avoid pricing models that penalize large wallets or create unpredictable bills.

<AccordionGroup>
  <Accordion title="Not end-user based">
    We do **not** charge per end-user, per wallet count, or based on a client’s user base size.
  </Accordion>

  <Accordion title="Not request-based for baseline usage">
    Baseline yield data usage is not designed to rack up large bills simply for normal product operation.
  </Accordion>

  <Accordion title="Compute Units apply only to premium">
    Premium DataKit access is billed via **Compute Units** for historical/external queries and advanced analytics, as defined in the Compute Unit contract.
  </Accordion>

  <Accordion title="How this interacts with plans">
    Standard / Pro / Enterprise tiers include baseline DataKit usage.\
    Premium DataKit is an add-on that can be introduced later, without blocking launch.
  </Accordion>
</AccordionGroup>

<Info>
  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.
</Info>

### Pricing & enablement

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

<CardGroup cols={2}>
  <Card title="Plans, limits & Compute Units" icon="gauge" href="/documentation/plans-limits" cta="View pricing" arrow="true">
    See how premium DataKit usage is metered, what’s included by plan, and how Compute Units map to your expected usage.
  </Card>

  <Card title="Enable Premium DataKit" icon="envelope" href="mailto:hello@yield.xyz?subject=Enable%20Premium%20DataKit%20for%20our%20project&body=Hi%20Yield.xyz%20team%2C%0A%0AWe%E2%80%99d%20like%20to%20enable%20Premium%20DataKit%20(historical%20%2F%20external%20coverage)%20for%20our%20project.%0A%0AProject%20name%3A%20%0AEnvironment%20(prod%20%2F%20sandbox)%3A%20%0AUse%20case%3A%20(historical%20%2F%20external%20positions%20%2F%20both)%0AExpected%20usage%20(volume%2C%20time%20range%2C%20assets)%3A%20%0A%0AThanks%21" cta="Contact us" arrow="true">
    Share your environment and whether you need historical and/or external positions. We’ll confirm pricing, limits, and the right setup for your project.
  </Card>
</CardGroup>

***

## 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.

<AccordionGroup>
  <Accordion title="Yield catalog & discovery metadata">
    Use DataKit to power browsing, filtering, and approvals: yield mechanics, protocol and network context, and the metadata required to list yields in your product.
  </Accordion>

  <Accordion title="Portfolio balances & lifecycle states">
    Track positions using lifecycle-aware balance states (e.g., active, entering, exiting, claimable) to support reliable UX and reporting.
  </Accordion>

  <Accordion title="Rewards tracking (origin-aware)">
    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.
  </Accordion>

  <Accordion title="Historical & external coverage (premium)">
    Enable deep history and portfolio views for positions created outside Yield.xyz, including imported wallets and migrated positions.
  </Accordion>
</AccordionGroup>

***

## 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

<CardGroup cols={2}>
  <Card title="Ecosystem scale" icon="globe">
    Normalized yield data across 80+ networks and 2,900+ yield opportunities (catalog evolves over time).
  </Card>

  <Card title="Protocol breadth" icon="layers">
    Coverage across 30+ staking providers and 40+ DeFi protocols, with consistent discovery and portfolio primitives.
  </Card>

  <Card title="Built for wallets and fintechs" icon="smartphone">
    Keep UX unblocked and costs predictable — no per-user pricing for baseline usage.
  </Card>

  <Card title="Institutional-ready" icon="building-columns">
    Clear origin boundaries, predictable premium metering, and an architecture compatible with regulated custody environments.
  </Card>
</CardGroup>

***

## 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

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/documentation/quickstart">
    Run the end-to-end integration flow.
  </Card>

  <Card title="Plans & Limits" icon="gauge" href="/documentation/plans-limits">
    Understand tiers and compute-unit billing for premium access.
  </Card>

  <Card title="API Reference: Discovery" icon="code" href="/api-reference/YieldsController_getYields">
    Explore yield discovery endpoints.
  </Card>

  <Card title="API Reference: Portfolio" icon="wallet" href="/api-reference/YieldsController_getAggregateBalances">
    Explore balances and portfolio endpoints.
  </Card>
</CardGroup>