Schema

The Staking Rewards API is built on GraphQL, providing a strongly-typed schema that defines all available types, fields, and relationships.

Relations Overview

Reward Options (Core Concept)

Reward Options are the core and center of the API. Each Reward Option connects to an Asset, Validator, Chain, and Provider.

Examples of Reward Options:

• Depositing ETH into Lido yields stETH
• Staking stETH in Curve produces CRV rewards
• Converting ETH to WETH via smart contract

Metrics

Metrics are connected to Assets, Reward Options, Providers, and Validators for storing individual object data. This allows you to query performance metrics, staking data, and historical information for any entity.

Assets

Assets are only connected to Reward Options, Metrics, and other Assets — not directly to Validators or Providers. To access provider or validator information for an asset, you must go through Reward Options.

Validators

Validators are connected only to Reward Options and Metrics. They are relevant through Provider relationships, as providers operate validators across different networks.

Providers

Providers are connected to Reward Options, their own Reward Option Types, and Metrics. They represent the entities that offer staking services.

Object Relationships Diagram

                    ┌─────────────┐
                    │   Assets    │
                    └──────┬──────┘
                           │
                           ▼
┌─────────────┐    ┌─────────────────┐    ┌─────────────┐
│  Providers  │◄───│  Reward Options │───►│ Validators  │
└──────┬──────┘    └────────┬────────┘    └──────┬──────┘
       │                    │                    │
       ▼                    ▼                    ▼
┌─────────────┐    ┌─────────────────┐    ┌─────────────┐
│   Metrics   │    │     Metrics     │    │   Metrics   │
└─────────────┘    └─────────────────┘    └─────────────┘

Get Schema Through a Client

You can access the full schema documentation via GraphQL Playground and its built-in introspection capabilities. The Docs and Schema tabs allow you to explore available types and fields.

Next Steps

• Learn about Assets and their fields
• Understand Providers and how they operate
• Explore Reward Options, the core of the API