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

# Get reward details

> Returns current reward rates, next accrual time, lifetime earned, and total available rewards

```bash OAuth Scope theme={null}
rewards:read_rewards_details
```


## OpenAPI

````yaml get /rewards/details
openapi: 3.0.0
info:
  title: Paxos Rewards API
  version: v2-preview
servers: []
security: []
paths:
  /rewards/details:
    get:
      tags:
        - Rewards
      summary: Get reward details
      description: >-
        Returns current reward rates, next accrual time, lifetime earned, and
        total available rewards.
      operationId: GetRewardDetails
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRewardDetailsResponse'
      security:
        - OAuth2:
            - rewards:read_rewards_details
components:
  schemas:
    GetRewardDetailsResponse:
      type: object
      properties:
        rates:
          type: array
          items:
            $ref: '#/components/schemas/RewardRate'
          description: Current reward rates.
        next_accrual:
          type: string
          format: date-time
          description: The next time rewards will accrue.
        lifetime_earned:
          type: string
          description: Total rewards earned over the lifetime of the account.
        total_available_rewards:
          type: string
          description: Total rewards currently available to claim in business units.
        est_next_accrual_amount:
          type: string
          description: >-
            Estimated amount of the next accrual based on current balances,
            pending rewards, and multiplier rates.
    RewardRate:
      type: object
      title: A reward rate configuration
      properties:
        id:
          type: string
          description: The rate ID.
        multiplier_id:
          type: string
          description: Maps to on-chain multiplier ID.
        rate:
          type: string
          description: >-
            The annualized yield rate as a decimal string (e.g., "0.0376" for
            3.76%).
        networks:
          type: array
          items:
            type: string
          description: The networks this rate applies to (e.g., ["ethereum", "polygon"]).
        jurisdiction:
          $ref: '#/components/schemas/Jurisdiction'
        tier:
          $ref: '#/components/schemas/Tier'
        effective_at:
          type: string
          format: date-time
          description: When this rate becomes effective.
        created_at:
          type: string
          format: date-time
          description: When this rate was created.
    Jurisdiction:
      type: string
      enum:
        - EU
        - US
      example: EU
    Tier:
      type: string
      enum:
        - FOUNDER
        - PARTNER_CUSTODY_REMOVAL_PROGRAM
        - PARTNER_STANDARD_CUSTODY_TIER_1
        - PARTNER_STANDARD_CUSTODY_TIER_2
        - PARTNER_STANDARD_CUSTODY_TIER_3
      example: PARTNER_STANDARD_CUSTODY_TIER_1
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://oauth.paxos.com/oauth2/token
          scopes:
            rewards:read_monitoring_address: Read reward addresses
            rewards:write_monitoring_address: Create and manage reward addresses
            rewards:read_claims_schedule: Read claim schedules
            rewards:write_claims_schedule: Create and manage claim schedules
            rewards:read_claims: Read claims
            rewards:read_payout_groups: Read payout groups
            rewards:write_payout_groups: Create and manage payout groups
            rewards:read_rewards_details: Read reward details

````