openapi: 3.1.0 info: title: Euler Data API (V3) Accounts Rewards API version: 3.0.0 description: "API specification for Euler Data v3. This spec defines the current\nresource-oriented contract for the platform, with emphasis on consistent\nschemas, predictable REST semantics, caching, observability, and a uniform\ndeveloper experience.\n\nMigration notes\n- Euler Data v3 is not a path-for-path clone of v1/v2. Some endpoints map\n directly, some require multiple v3 calls, and some legacy aggregates were\n intentionally removed.\n- The live [migration guide](/v3/docs/migration) explains how legacy v1/v2\n endpoints and payloads map into the v3 resource model.\n- Important semantic changes:\n - Vault base APY and rewards APY are exposed separately in v3.\n - Account positions are flattened into account-vault rows instead of the\n legacy nested sub-account shape.\n - All supported API paths live under `/v3`; legacy paths return `410`.\n - Summary endpoints prefer smaller, focused resources over large\n BFF-style payloads.\n\nBase path: /v3\n\nConventions\n- JSON field naming: camelCase\n- Addresses: accept lowercase or checksum; responses are EIP-55 checksummed\n- Public APY values (`*Apy`, `apy*`): percent numbers with 6 decimal places (e.g., 5.123456 = 5.123456%)\n- Contract interest-rate fields (`borrowAPY`, `supplyAPY` in `interestRates`): decimal strings in contract fraction units\n- Ratios (utilization, LTV, etc.): numbers with 6 decimal places\n- Response timestamps: ISO-8601 strings (UTC). Some legacy fields still expose unix\n seconds for compatibility and include `*Iso` companions.\n- Query time ranges: unix seconds (from/to)\n\nUnit policy\n- v3 separates market metadata from contract verdicts by both name and type.\n- Market-normalized USD prices and USD values are JSON numbers. These are values\n derived from off-chain pricing, cached price snapshots, or API-level market math.\n This includes `/v3/prices`, token price routes, vault/earn/protocol USD totals,\n portfolio market values, portfolio USD liquidation/risk fields such as\n `liabilityValueUsd`, `totalCollateralValueUsd`, `borrowLiquidationPriceUsd`,\n and `collateralLiquidationPricesUsd`, and vault holder `assetsUsd`.\n- Contract-derived oracle and raw account-liquidity verdict values are exact strings.\n These preserve the integer value used by contracts, normalized to 18 decimals\n for API exposure. Oracle prices are quoted in the vault unit of account, which\n can be USD, ETH, or another asset. This includes `/v3/oracles/prices`, raw\n account-liquidity `liabilityValue` and `totalCollateralValue` objects,\n `liabilityValueBorrowing`, `liabilityValueLiquidation`, and collateral verdict\n values.\n- On-chain token quantities are bigint strings in their native unit scale. This\n includes amounts, balances, shares, assets, borrows, reward amounts, liquidation\n repay/yield amounts, and block numbers.\n- Caps are also bigint strings, but EVK caps are exposed as resolved underlying\n asset-unit amounts rather than packed contract config words.\n- LTV config values use canonical basis-point strings. Legacy decimal aliases\n may remain on config-history payloads for compatibility when explicitly named.\n\nRate limiting\n- Optional API keys for higher limits\n- Default limits are configurable; current defaults: free tier 100 req/min (IP-based)\n and authenticated 1000 req/min (per API key), 60s window.\n- By default, proxy headers are not trusted for IP identity unless explicitly enabled.\n- Redis failures default to fail-closed (503) for strict enforcement; fail-open is opt-in.\n- RateLimit-* (IETF draft-6) and legacy X-RateLimit-* headers are returned.\n\nCORS\n- Public API responses use wildcard CORS, including preflight responses for unsafe methods.\n- Unsafe methods with request bodies must use a JSON media type.\n\nCaching\n- Cache-Control headers are returned for cacheable endpoints.\n- Defaults (may be adjusted in config):\n - Prices: 300s\n - APYs: 600s\n - Rewards: 900s\n - General responses: 60s (short 30s, long 300s)\n\nErrors\n- All errors use a standard envelope: { error: { code, message, requestId, details? } }\n- Domain error codes are documented in this spec.\n- JSON request bodies must use `Content-Type: application/json` or another `application/*+json` media type.\n- Request bodies larger than 1 MiB are rejected before route parsing with `413 PAYLOAD_TOO_LARGE`.\n" servers: - url: / description: Current environment security: [] tags: - name: Rewards description: Reward campaign APRs and per-account reward breakdowns. Rewards APY is intentionally separate from base vault APY in v3; combine them client-side when you need a legacy-style total supply APY. paths: /v3/apys/rewards: get: tags: - Rewards summary: Rewards APYs x-status: implemented x-cache-ttl: 900 parameters: - $ref: '#/components/parameters/ChainIdParam' - name: vault in: query required: false schema: type: string responses: '200': description: Rewards APYs 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: type: array items: $ref: '#/components/schemas/RewardsApy' meta: $ref: '#/components/schemas/PaginationMeta' operationId: getApysRewards /v3/apys/rewards/history: get: tags: - Rewards summary: Rewards APY history description: 'Rewards APY history for a required time range. Required query params: `chainId`, `from`, `to`. Optional filters: `vault`, `resolution`, `offset`, `limit`. Maximum allowed window is 30 days per request. ' x-status: implemented x-cache-ttl: 300 parameters: - name: chainId in: query required: true schema: type: integer - name: from in: query required: true schema: type: integer - name: to in: query required: true schema: type: integer - name: resolution in: query required: false schema: type: string enum: - 1h - 1d default: 1d - name: vault in: query required: false schema: type: string - $ref: '#/components/parameters/OffsetParam' - $ref: '#/components/parameters/LimitParam' responses: '200': description: Rewards APY history 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: type: array items: $ref: '#/components/schemas/RewardsApyHistoryPoint' meta: $ref: '#/components/schemas/PaginationMeta' '400': $ref: '#/components/responses/Error400' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' operationId: getApysRewardsHistory /v3/rewards/breakdown: get: tags: - Rewards summary: Per-user reward breakdowns x-status: implemented x-cache-ttl: 60 parameters: - $ref: '#/components/parameters/ChainIdParam' - name: account in: query required: true schema: type: string - name: vault in: query required: false schema: type: string responses: '200': description: Reward breakdowns headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: type: object properties: data: type: array items: type: object meta: $ref: '#/components/schemas/PaginationMeta' operationId: getRewardsBreakdown components: responses: 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' Error500: description: Internal server error headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Error400: description: Bad request headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Error404: description: Not found headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: 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. RewardsApy: type: object properties: chainId: type: integer vault: type: string campaigns: type: array items: type: object properties: id: type: string provider: type: string apr: type: number description: Reward APR contribution as a public percent number. rewardToken: $ref: '#/components/schemas/AssetRef' source: type: string enum: - merkl - turtle - direct startTimestamp: type: string format: date-time endTimestamp: type: string format: date-time status: type: string enum: - active - upcoming - ended description: Campaign status. 'active' = ongoing, 'upcoming' = not yet started, 'ended' = past. campaignType: type: string collateralAsset: type: string requiresCb1Verification: type: boolean merklCampaignId: type: string description: Original Merkl campaign id when the public campaign is fanned out into vault-level instances. opportunityType: type: string description: Merkl opportunity type that produced this campaign. distributionType: type: string description: Merkl distribution type for the campaign. whitelist: type: array description: Lowercase recipient addresses eligible for whitelist-gated campaigns. items: type: string blacklist: type: array description: Lowercase recipient addresses excluded from blacklist-gated campaigns. items: type: string totalApr: type: number description: Sum of currently active reward APR contributions as a public percent number. 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 RewardsApyHistoryPoint: type: object properties: chainId: type: integer vault: type: string rewardsApy: type: number description: Rewards APY as a public percent number. timestamp: type: string format: date-time description: Bucket timestamp as an ISO-8601 UTC string. AssetRef: type: object properties: address: type: string symbol: type: string decimals: type: integer name: type: string nullable: true headers: X-Request-Id: description: Request identifier for tracing. schema: type: string Cache-Control: description: Cache policy for this response. schema: type: string parameters: LimitParam: name: limit in: query required: false description: Requested page size. Values above the endpoint cap are clamped; the default shared cap is 100. schema: type: integer default: 20 maximum: 100 ChainIdParam: name: chainId in: query required: false schema: type: string description: Comma-separated list of chain IDs (single value allowed). example: 1,10,8453 OffsetParam: name: offset in: query required: false schema: type: integer default: 0 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 ' 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.