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

> Daily/weekly/monthly/yearly interest earned vs. paid, plus net APY. Optional `market_id` (default main) and `target_health_factor` (default 1.5).

**Credits:** 8 per successful call.



## OpenAPI

````yaml /openapi.yaml get /v1/lending/aavev3/position/{chain_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/lending/aavev3/position/{chain_id}/yield:
    get:
      tags:
        - Aave V3
      summary: Get Position Yield
      description: >-
        Daily/weekly/monthly/yearly interest earned vs. paid, plus net APY.
        Optional `market_id` (default main) and `target_health_factor` (default
        1.5).


        **Credits:** 8 per successful call.
      operationId: get_v1_lending_aavev3_position_chain_id_yield
      parameters:
        - name: chain_id
          in: path
          required: true
          schema:
            type: integer
            description: Chain ID.
            example: 8453
            x-default: 8453
        - name: wallet
          in: query
          required: true
          schema:
            type: string
            description: Wallet address.
            example: '0xbf7620d0377b0660a6cbaef5cdfe2e00eddc1495'
            x-default: '0xbf7620d0377b0660a6cbaef5cdfe2e00eddc1495'
        - name: market_id
          in: query
          required: false
          schema:
            type: string
            enum:
              - main
              - lido
              - horizon
            description: 'Default: `main`. Values: `main`, `lido`, `horizon`.'
            default: main
        - name: target_health_factor
          in: query
          required: false
          schema:
            type: number
            description: 'Target health factor. Default: 1.5.'
            default: 1.5
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/RequestId'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          chain_id:
                            type: integer
                          wallet:
                            type: string
                          market_id:
                            type: string
                          daily_supply_interest_usd:
                            type: string
                          daily_borrow_interest_usd:
                            type: string
                          net_daily_interest_usd:
                            type: string
                          net_apy:
                            type: string
                          position_leverage:
                            type: string
                          weighted_supply_apy:
                            type: string
                          weighted_borrow_apy:
                            type: string
                          projected_earnings_detailed:
                            type: object
                            properties:
                              simple:
                                type: object
                                properties:
                                  oneDay:
                                    type: string
                                  sevenDays:
                                    type: string
                                  thirtyDays:
                                    type: string
                                  oneYear:
                                    type: string
                                required:
                                  - oneDay
                                  - sevenDays
                                  - thirtyDays
                                  - oneYear
                              compounding:
                                type: object
                                properties:
                                  sevenDays:
                                    type: string
                                  thirtyDays:
                                    type: string
                                  oneYear:
                                    type: string
                                required:
                                  - sevenDays
                                  - thirtyDays
                                  - oneYear
                            required:
                              - simple
                              - compounding
                        required:
                          - chain_id
                          - wallet
                          - market_id
                          - daily_supply_interest_usd
                          - daily_borrow_interest_usd
                          - net_daily_interest_usd
                          - net_apy
                          - position_leverage
                          - weighted_supply_apy
                          - weighted_borrow_apy
                          - projected_earnings_detailed
                    required:
                      - data
              example:
                data:
                  chain_id: 8453
                  wallet: '0xbf7620d0377b0660a6cbaef5cdfe2e00eddc1495'
                  market_id: main
                  daily_supply_interest_usd: '0.08'
                  daily_borrow_interest_usd: '0.35'
                  net_daily_interest_usd: '-0.27'
                  net_apy: '-4.47'
                  position_leverage: '1.28'
                  weighted_supply_apy: '1.63'
                  weighted_borrow_apy: '4.48'
                  projected_earnings_detailed:
                    simple:
                      oneDay: '-0.27'
                      sevenDays: '-1.89'
                      thirtyDays: '-7.99'
                      oneYear: '-97.22'
                    compounding:
                      sevenDays: '-1.89'
                      thirtyDays: '-8.10'
                      oneYear: '-99.40'
                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.