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

# Rewards

> A series of endpoints that drill down on rewards related metrics for both entities and validators.

export const Endpoint = ({type, path, url}) => {
  const methodColors = {
    post: 'bg-blue-400/20 text-blue-700 dark:bg-blue-400/20 dark:text-blue-400',
    get: 'bg-green-400/20 text-green-700 dark:bg-green-400/20 dark:text-green-400',
    put: 'bg-yellow-400/20 text-yellow-700 dark:bg-yellow-400/20 dark:text-yellow-400',
    delete: 'bg-red-400/20 text-red-700 dark:bg-red-400/20 dark:text-red-400',
    patch: 'bg-orange-400/20 text-orange-700 dark:bg-orange-400/20 dark:text-orange-400'
  };
  const pathParts = path.startsWith('/') ? path.substring(1).split('/') : path.split('/');
  return <a href={url} className="relative flex-1 flex gap-2 min-w-0 rounded-xl items-center cursor-pointer p-1.5 border-standard">
        <div className={`rounded-lg font-bold px-1.5 py-0.5 text-sm leading-5 ${methodColors[type.toLowerCase()]}`}>
          {type}
        </div>
        <div className="flex items-center space-x-2 overflow-x-auto flex-1 no-scrollbar">
          <div className="group flex items-center flex-1 gap-0.5 font-mono">
            {url && <div className="absolute right-0 p-2 rounded-lg hidden group-hover:block">
                <Icon icon="arrow-right" />
              </div>}
            {pathParts.map((part, i) => {
    const isParam = part.includes('{');
    return <>
                  <div className="text-sm text-gray-400">/</div>
                  {isParam ? <div className="text-sm font-mono font-medium rounded-md px-1 border-2 min-w-max text-[#2AB673] bg-[#2AB673]/10 border-[#2AB673]/30">
                      {part}
                    </div> : <div className="text-sm font-medium text-gray-800 dark:text-white min-w-max">
                      {part}
                    </div>}
                </>;
  })}
          </div>
        </div>
      </a>;
};

## Entity Rewards

The rewards endpoints give you a breakdown of all rewards earned and penalties accrued by an entity over time.  Please head to our [Glossary](/rated-api/glossary) to understand what individual metrics refer to.

### Get rewards metrics for Pools, Operators and Addresses

<Endpoint type="GET" path="/v1/eth/entities/{entity_id}/rewards" url="/rated-api/api-reference/v1/ethereum/rewards/get-rewards-metrics-for-pools-operators-and-addresses" />

### Get penalty metrics for Pools, Operators and Addresses

<Endpoint type="GET" path="/v1/eth/entities/{entity_id}/penalties" url="/rated-api/api-reference/v1/ethereum/rewards/get-penalty-metrics-for-pools-operators-and-addresses" />

***

## Validator Rewards

### Individual validators

Similar to the entity rewards endpoints, the validator rewards endpoints provide a breakdown of all rewards earned and penalties accrued by a single validator index or pubkey over time.  Please head to our [Glossary](/rated-api/glossary/ethereum/validators) to understand what individual metrics refer to.

### Get validator rewards metrics

<Endpoint type="GET" path="/v1/eth/validators/{validator_index_or_pubkey}/rewards" url="/rated-api/api-reference/v1/ethereum/rewards/get-validator-rewards-metrics" />

### Get validator penalty metrics

<Endpoint type="GET" path="/v1/eth/validators/{validator_index_or_pubkey}/penalties" url="/rated-api/api-reference/v1/ethereum/rewards/get-validator-penalty-metrics" />

### Aggregating Validator Indices

Unlike the entities endpoint, validators can be aggregated across all the metrics that live under the rewards endpoints across a number of validator indices or pubkeys (150). This aggregation is available over a time window or over validator indices.

#### Get aggregated rewards for validators

<Endpoint type="GET" path="/v1/eth/validators/rewards" url="/rated-api/api-reference/v1/ethereum/rewards/get-rewards-metrics-for-a-group-of-validators" />

#### Get aggregated penalties for validators

<Endpoint type="GET" path="/v1/eth/validators/penalties" url="/rated-api/api-reference/v1/ethereum/rewards/get-aggregated-penalty-metrics-for-validators" />

***

## Sets Rewards

Sets or Private Sets, helps organizations group validators into custom, private, sets enabling usecases such as executing controlled experiments and analyses to assess various aspects of their validators' cluster performance and rewards metrics. Head to [Private Sets](/rated-api/api-reference/v1/ethereum/private-sets/private-sets) to learn more about the different endpoints you'll need to call as a precursor to calling the endpoints below.

<Note>
  Note that the set rewards endpoints behave identical to the entities rewards endpoints with the caveat that (i) only the org that creates a set can view rewards metrics for that set (hence *private sets*) and (ii) sets data does not surface on the Rated Explorer.
</Note>

### Get rewards metrics for a private set

<Endpoint type="GET" path="/v1/eth/sets/{set_id}/rewards" url="/rated-api/api-reference/v1/ethereum/rewards/get-rewards-metrics-for-a-private-set" />

### Get penalty metrics for a private set

<Endpoint type="GET" path="/v1/eth/sets/{set_id}/penalties" url="/rated-api/api-reference/v1/ethereum/rewards/get-penalty-metrics-for-a-private-set" />
