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

# Get Aerodrome V3 Position Yield

> Fee and AERO reward accrual. projected_yield_apr and estimated_total_yield match the position page. earned_apr_percentage is historical earned APR and stays non-zero out of range. unclaimed_fees is Pending Fees. unclaimed_rewards is Pending Rewards.

**Credits:** 8 per successful call.

These queries have their own credit cost.

| Query | Credits |
| --- | --- |
| `status=inactive` | 4 |



## OpenAPI

````yaml /openapi.yaml get /v1/positions/aerodromev3/{id}/yield
openapi: 3.1.0
info:
  title: DeFi Orbit API
  version: 1.0.0
  description: Public REST API for DeFi Orbit positions, lending, portfolio, and usage.
servers:
  - url: https://api.defiorbit.xyz
security:
  - bearerAuth: []
tags:
  - name: Portfolio
  - name: Snapshots
  - name: Uniswap V3
  - name: Aerodrome V3
  - name: Orca
  - name: Aave V3
  - name: Morpho
  - name: Kamino
  - name: Usage
paths:
  /v1/positions/aerodromev3/{id}/yield:
    get:
      tags:
        - Aerodrome V3
      summary: Get Aerodrome V3 Position Yield
      description: >-
        Fee and AERO reward accrual. projected_yield_apr and
        estimated_total_yield match the position page. earned_apr_percentage is
        historical earned APR and stays non-zero out of range. unclaimed_fees is
        Pending Fees. unclaimed_rewards is Pending Rewards.


        **Credits:** 8 per successful call.


        These queries have their own credit cost.


        | Query | Credits |

        | --- | --- |

        | `status=inactive` | 4 |
      operationId: get_v1_positions_aerodromev3_id_yield
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: Token ID.
            example: '1'
            x-default: '1'
        - name: chain_id
          in: query
          required: true
          schema:
            type: integer
            description: Chain ID.
            example: 8453
            x-default: 8453
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - inactive
            description: >-
              Omit for active positions. Set to `inactive` for closed positions.
              Default: active.
        - name: manager_address
          in: query
          required: false
          schema:
            type: string
            description: Manager address.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/RequestId'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          token_id:
                            type: string
                          chain_id:
                            type: integer
                          earned_apr_percentage:
                            type: object
                            properties:
                              yield:
                                type: string
                                description: Percent string for that component.
                              fees:
                                type: string
                                description: Percent string for that component.
                              rewards:
                                type: string
                                description: Percent string for that component.
                            required:
                              - yield
                              - fees
                              - rewards
                            description: >-
                              Simple APR percent strings, not compounded. Each
                              figure is value × 365 / days / time-weighted
                              capital. Days are at least 1 hour.
                          projected_yield_apr:
                            type: string
                            description: >-
                              Yearly in-range APR percent string. 0 when the
                              position is out of range or closed.
                          estimated_total_yield:
                            type: object
                            properties:
                              daily:
                                type: string
                              weekly:
                                type: string
                              monthly:
                                type: string
                              yearly:
                                type: string
                            required:
                              - daily
                              - weekly
                              - monthly
                              - yearly
                            description: >-
                              USD strings. Observed average daily fees and
                              rewards, scaled to a day, week, month, and year.
                          average_fees_usd_value:
                            type: object
                            properties:
                              daily:
                                type: object
                                properties:
                                  amount0:
                                    type: string
                                    description: Token amount as a decimal string.
                                  amount1:
                                    type: string
                                    description: Token amount as a decimal string.
                                  usdValue0:
                                    type: string
                                    description: USD value of token0 as a decimal string.
                                  usdValue1:
                                    type: string
                                    description: USD value of token1 as a decimal string.
                                  totalUsdValue:
                                    type: string
                                    description: USD total as a decimal string.
                                required:
                                  - amount0
                                  - amount1
                                  - usdValue0
                                  - usdValue1
                                  - totalUsdValue
                              hourly:
                                type: object
                                properties:
                                  amount0:
                                    type: string
                                    description: Token amount as a decimal string.
                                  amount1:
                                    type: string
                                    description: Token amount as a decimal string.
                                  usdValue0:
                                    type: string
                                    description: USD value of token0 as a decimal string.
                                  usdValue1:
                                    type: string
                                    description: USD value of token1 as a decimal string.
                                  totalUsdValue:
                                    type: string
                                    description: USD total as a decimal string.
                                required:
                                  - amount0
                                  - amount1
                                  - usdValue0
                                  - usdValue1
                                  - totalUsdValue
                              weekly:
                                type: object
                                properties:
                                  amount0:
                                    type: string
                                    description: Token amount as a decimal string.
                                  amount1:
                                    type: string
                                    description: Token amount as a decimal string.
                                  usdValue0:
                                    type: string
                                    description: USD value of token0 as a decimal string.
                                  usdValue1:
                                    type: string
                                    description: USD value of token1 as a decimal string.
                                  totalUsdValue:
                                    type: string
                                    description: USD total as a decimal string.
                                required:
                                  - amount0
                                  - amount1
                                  - usdValue0
                                  - usdValue1
                                  - totalUsdValue
                              monthly:
                                type: object
                                properties:
                                  amount0:
                                    type: string
                                    description: Token amount as a decimal string.
                                  amount1:
                                    type: string
                                    description: Token amount as a decimal string.
                                  usdValue0:
                                    type: string
                                    description: USD value of token0 as a decimal string.
                                  usdValue1:
                                    type: string
                                    description: USD value of token1 as a decimal string.
                                  totalUsdValue:
                                    type: string
                                    description: USD total as a decimal string.
                                required:
                                  - amount0
                                  - amount1
                                  - usdValue0
                                  - usdValue1
                                  - totalUsdValue
                              yearly:
                                type: object
                                properties:
                                  amount0:
                                    type: string
                                    description: Token amount as a decimal string.
                                  amount1:
                                    type: string
                                    description: Token amount as a decimal string.
                                  usdValue0:
                                    type: string
                                    description: USD value of token0 as a decimal string.
                                  usdValue1:
                                    type: string
                                    description: USD value of token1 as a decimal string.
                                  totalUsdValue:
                                    type: string
                                    description: USD total as a decimal string.
                                required:
                                  - amount0
                                  - amount1
                                  - usdValue0
                                  - usdValue1
                                  - totalUsdValue
                            required:
                              - daily
                              - hourly
                              - weekly
                              - monthly
                              - yearly
                            description: >-
                              Observed fee token amounts and USD value per hour,
                              day, week, month, and year.
                          average_rewards_usd_value:
                            type: object
                            properties:
                              hourly:
                                type: string
                              daily:
                                type: string
                              weekly:
                                type: string
                              monthly:
                                type: string
                              yearly:
                                type: string
                            required:
                              - hourly
                              - daily
                              - weekly
                              - monthly
                              - yearly
                            description: >-
                              Observed reward USD value per hour, day, week,
                              month, and year.
                          total_fees:
                            type: object
                            properties:
                              amount0:
                                type: string
                                description: Token amount as a decimal string.
                              amount1:
                                type: string
                                description: Token amount as a decimal string.
                              usdValue0:
                                type: string
                                description: USD value of token0 as a decimal string.
                              usdValue1:
                                type: string
                                description: USD value of token1 as a decimal string.
                              totalUsdValue:
                                type: string
                                description: USD total as a decimal string.
                            required:
                              - amount0
                              - amount1
                              - usdValue0
                              - usdValue1
                              - totalUsdValue
                            description: >-
                              Fee token amounts and USD value across collected,
                              compounded, and uncollected fees.
                          total_rewards:
                            type: object
                            properties:
                              totalUsdValue:
                                type: string
                                description: USD total as a decimal string.
                              totalTokenValue:
                                type: string
                            required:
                              - totalUsdValue
                              - totalTokenValue
                            description: Reward USD total and token total.
                          total_yield:
                            type: string
                            description: USD string. Total fees plus total rewards.
                          unclaimed_fees:
                            type: object
                            properties:
                              amount0:
                                type: string
                                description: Token amount as a decimal string.
                              amount1:
                                type: string
                                description: Token amount as a decimal string.
                              usdValue0:
                                type: string
                                description: USD value of token0 as a decimal string.
                              usdValue1:
                                type: string
                                description: USD value of token1 as a decimal string.
                              totalUsdValue:
                                type: string
                                description: USD total as a decimal string.
                            required:
                              - amount0
                              - amount1
                              - usdValue0
                              - usdValue1
                              - totalUsdValue
                            description: >-
                              Uncollected fee token amounts, valued at the
                              current price.
                          claimed_fees:
                            type: object
                            properties:
                              amount0:
                                type: string
                                description: Token amount as a decimal string.
                              amount1:
                                type: string
                                description: Token amount as a decimal string.
                              usdValue0:
                                type: string
                                description: USD value of token0 as a decimal string.
                              usdValue1:
                                type: string
                                description: USD value of token1 as a decimal string.
                              totalUsdValue:
                                type: string
                                description: USD total as a decimal string.
                            required:
                              - amount0
                              - amount1
                              - usdValue0
                              - usdValue1
                              - totalUsdValue
                            description: >-
                              Collected fee token amounts, valued at the
                              collection price.
                          unclaimed_rewards:
                            type: object
                            properties:
                              rewards:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    label:
                                      type: string
                                    valueInToken:
                                      type: string
                                    rewardToken:
                                      type: object
                                      properties:
                                        symbol:
                                          type: string
                                        decimals:
                                          type: integer
                                        name:
                                          type: string
                                        currentPriceUSD:
                                          type: string
                                      required:
                                        - symbol
                                        - decimals
                                        - name
                                        - currentPriceUSD
                                  required:
                                    - type
                                    - label
                                    - valueInToken
                                    - rewardToken
                              totalUsdValue:
                                type: string
                                description: USD total as a decimal string.
                            required:
                              - rewards
                              - totalUsdValue
                            description: Pending reward tokens and their USD total.
                          claimed_rewards:
                            type: object
                            properties:
                              rewards:
                                type: array
                                items:
                                  type: object
                              totalUsdValue:
                                type: string
                                description: USD total as a decimal string.
                              totalTokenValue:
                                type: string
                            required:
                              - rewards
                              - totalUsdValue
                              - totalTokenValue
                            description: >-
                              Collected reward tokens, with USD and token
                              totals.
                          is_closed:
                            type: boolean
                            description: True when the position liquidity is zero.
                        required:
                          - token_id
                          - chain_id
                          - earned_apr_percentage
                          - projected_yield_apr
                          - estimated_total_yield
                          - average_fees_usd_value
                          - average_rewards_usd_value
                          - total_fees
                          - total_rewards
                          - total_yield
                          - unclaimed_fees
                          - claimed_fees
                          - unclaimed_rewards
                          - claimed_rewards
                          - is_closed
                    required:
                      - data
              example:
                data:
                  token_id: '1'
                  chain_id: 8453
                  earned_apr_percentage:
                    yield: '35.00'
                    fees: '20.00'
                    rewards: '15.00'
                  projected_yield_apr: '35.00'
                  estimated_total_yield:
                    daily: '3.36'
                    weekly: '23.49'
                    monthly: '100.68'
                    yearly: '1226.40'
                  average_fees_usd_value:
                    daily:
                      amount0: '0.10'
                      amount1: '0.20'
                      usdValue0: '0.10'
                      usdValue1: '12.00'
                      totalUsdValue: '12.10'
                    hourly:
                      amount0: '0.10'
                      amount1: '0.20'
                      usdValue0: '0.10'
                      usdValue1: '12.00'
                      totalUsdValue: '12.10'
                    weekly:
                      amount0: '0.10'
                      amount1: '0.20'
                      usdValue0: '0.10'
                      usdValue1: '12.00'
                      totalUsdValue: '12.10'
                    monthly:
                      amount0: '0.10'
                      amount1: '0.20'
                      usdValue0: '0.10'
                      usdValue1: '12.00'
                      totalUsdValue: '12.10'
                    yearly:
                      amount0: '0.10'
                      amount1: '0.20'
                      usdValue0: '0.10'
                      usdValue1: '12.00'
                      totalUsdValue: '12.10'
                  average_rewards_usd_value:
                    hourly: '0.01'
                    daily: '0.11'
                    weekly: '0.77'
                    monthly: '3.29'
                    yearly: '40.00'
                  total_fees:
                    amount0: '0.10'
                    amount1: '0.20'
                    usdValue0: '0.10'
                    usdValue1: '12.00'
                    totalUsdValue: '12.10'
                  total_rewards:
                    totalUsdValue: '40.00'
                    totalTokenValue: '47.5'
                  total_yield: '120.00'
                  unclaimed_fees:
                    amount0: '0.10'
                    amount1: '0.20'
                    usdValue0: '0.10'
                    usdValue1: '12.00'
                    totalUsdValue: '12.10'
                  claimed_fees:
                    amount0: '0.10'
                    amount1: '0.20'
                    usdValue0: '0.10'
                    usdValue1: '12.00'
                    totalUsdValue: '12.10'
                  unclaimed_rewards:
                    rewards:
                      - type: aero
                        label: AERO
                        valueInToken: '14.5'
                        rewardToken:
                          symbol: AERO
                          decimals: 18
                          name: Aerodrome
                          currentPriceUSD: '0.83'
                    totalUsdValue: '12.00'
                  claimed_rewards:
                    rewards: []
                    totalUsdValue: '28.00'
                    totalTokenValue: '33.0'
                  is_closed: false
                request_id: req_...
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    RequestId:
      type: object
      required:
        - request_id
      properties:
        request_id:
          type: string
          description: Id to quote when you contact support.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
  responses:
    BadRequest:
      description: Missing or invalid parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_PARAMETER
              message: page must be a positive integer.
              request_id: req_...
    Unauthorized:
      description: Missing, malformed, invalid, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_API_KEY
              message: Missing API key.
              request_id: req_...
    PaymentRequired:
      description: The organization does not have enough credits.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INSUFFICIENT_CREDITS
              message: Insufficient API credits.
              request_id: req_...
    Forbidden:
      description: The organization is suspended, or the endpoint or feature is disabled.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCOUNT_SUSPENDED
              message: This organization is suspended.
              request_id: req_...
    TooManyRequests:
      description: The organization exceeded its requests-per-second limit.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests per second for the organization.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix time when the window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMIT_EXCEEDED
              message: Rate limit exceeded. Please try again later.
              request_id: req_...
    InternalError:
      description: Unexpected server error, or pricing is not configured.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred.
              request_id: req_...
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Paste your API key from the
        [dashboard](https://platform.defiorbit.xyz/dashboard/keys). The key
        starts with `do_sk_`.
      x-default: YOUR_API_KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.