Euler Finance Protocol API

openapi: 3.2.0
info:
  title: Euler Data API (V3) Protocol API
  version: 3.0.0
  description: API specification for Euler Data v3.
servers:
- url: /
  description: Current environment
security: []
tags:
- name: Protocol
  description: Protocol-wide summary endpoints and aggregate metrics. In v3, these endpoints are explicitly summary-oriented and should be treated as lightweight rollups rather than replacements for full vault list payloads.
paths:
  /v3:
    get:
      tags:
      - Protocol
      summary: Service metadata
      x-status: implemented
      responses:
        '200':
          description: Service metadata
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                - meta
                properties:
                  data:
                    type: object
                    properties:
                      name:
                        type: string
                      version:
                        type: string
                      docs:
                        type: string
                      openapi:
                        type: string
                      health:
                        type: string
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
      operationId: getRoot
  /v3/openapi.json:
    get:
      tags:
      - Protocol
      summary: OpenAPI document
      x-status: implemented
      responses:
        '200':
          description: OpenAPI document
      operationId: getOpenapiJson
  /v3/docs:
    get:
      tags:
      - Protocol
      summary: Developer documentation UI
      x-status: implemented
      responses:
        '200':
          description: Documentation UI
      operationId: getDocs
  /v3/protocol/stats:
    get:
      tags:
      - Protocol
      summary: Protocol-wide EVK lending stats across chains
      description: Returns EVK lending aggregates across the selected chains. `earnTotalAssetsUsd` is reported separately and is not part of `totalSuppliedUsd` or `utilization`.
      x-status: implemented
      x-cache-ttl: 60
      parameters:
      - $ref: '#/components/parameters/ChainIdParam'
      responses:
        '200':
          description: Protocol stats
          headers:
            Cache-Control:
              $ref: '#/components/headers/Cache-Control'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProtocolStats'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '400':
          $ref: '#/components/responses/Error400'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
      operationId: getProtocolStats
components:
  headers:
    Cache-Control:
      description: Cache policy for this response.
      schema:
        type: string
    X-Request-Id:
      description: Request identifier for tracing.
      schema:
        type: string
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - requestId
          properties:
            code:
              type: string
              description: 'Domain error code. Examples:

                - INVALID_ADDRESS

                - CHAIN_NOT_SUPPORTED

                - VAULT_NOT_FOUND

                - TOKEN_NOT_FOUND

                - ACCOUNT_NOT_FOUND

                - VALIDATION_ERROR

                - RATE_LIMIT_EXCEEDED

                - UNSUPPORTED_MEDIA_TYPE

                - UNAUTHORIZED

                - FORBIDDEN

                - INTERNAL_ERROR

                '
            message:
              type: string
            requestId:
              type: string
            details:
              type: object
              additionalProperties: true
    ProtocolStats:
      type: object
      description: EVK lending aggregates across the selected chains, with Earn TVL reported separately.
      properties:
        totalSuppliedUsd:
          type: number
          description: Total EVK lending supply in USD. This is the sum of vault `cash + totalBorrows` valued in USD and excludes Earn vault assets.
        totalBorrowedUsd:
          type: number
          description: Total EVK lending borrows in USD across the selected chains.
        earnTotalAssetsUsd:
          type: number
          description: Total Earn vault assets in USD. Reported separately and not included in `totalSuppliedUsd` or `utilization`.
        utilization:
          type: number
          description: EVK lending utilization, computed as `totalBorrowedUsd / totalSuppliedUsd`. Earn assets are excluded from the denominator.
        vaultCount:
          type: integer
        chainCount:
          type: integer
    PaginationMeta:
      type: object
      required:
      - timestamp
      properties:
        total:
          type: integer
          description: Exact total count when the endpoint provides one.
        hasMore:
          type: boolean
          description: Indicates whether another page exists beyond the current page.
        offset:
          type: integer
        limit:
          type: integer
          description: Echoed page size after endpoint-side clamping.
        timestamp:
          type: string
          format: date-time
        chainId:
          type: string
          description: Comma-separated chain IDs for multi-chain responses.
  responses:
    Error400:
      description: Bad request
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Error500:
      description: Internal server error
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Error429:
      description: Rate limited
      headers:
        Retry-After:
          description: Seconds until next request is allowed.
          schema:
            type: integer
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    ChainIdParam:
      name: chainId
      in: query
      required: false
      schema:
        type: string
      description: Comma-separated list of chain IDs (single value allowed).
      example: 1,10,8453
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key authentication (optional; higher rate limits).
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Alternative to X-API-Key using Authorization: Bearer <key>'
    AdminSecret:
      type: apiKey
      in: header
      name: X-Admin-Secret
      description: Admin secret (server-to-server) for API key management.
    PlatformSession:
      type: apiKey
      in: cookie
      name: euler_platform_session
      description: Signed, httpOnly platform-operator browser session cookie.
    PlatformCsrf:
      type: apiKey
      in: header
      name: X-CSRF-Token
      description: Double-submit CSRF token required for unsafe cookie-authenticated methods.