> ## Documentation Index > Fetch the complete documentation index at: https://docs.criffy.com/llms.txt > Use this file to discover all available pages before exploring further. # Get earn offer by ID ## OpenAPI ````yaml /openapi/public-api.yaml get /api/v1/earn/{id} openapi: 3.1.0 info: title: Criffy Public API version: 1.0.0 summary: Public market data APIs for Criffy Pro+ integrations. description: > Public REST reference for Criffy. Public data endpoints live under `/api/v1/*`. All documented endpoints require a Bearer API key tied to an active Pro+ subscription. API keys are created and managed from the signed-in Criffy dashboard under Settings -> API. servers: - url: https://criffy.com description: Production security: [] tags: - name: Exchanges - name: Wallets - name: Protocols - name: Currencies - name: Earn - name: Borrow - name: Collateral paths: /api/v1/earn/{id}: get: tags: - Earn summary: Get earn offer by ID operationId: getEarnOffer parameters: - $ref: '#/components/parameters/IdPathParam' responses: '200': description: Earn offer. headers: X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' X-Quota-Limit: $ref: '#/components/headers/XQuotaLimit' X-Quota-Remaining: $ref: '#/components/headers/XQuotaRemaining' X-Quota-Reset: $ref: '#/components/headers/XQuotaReset' content: application/json: schema: $ref: '#/components/schemas/PublicEarn' examples: earn: $ref: '#/components/examples/EarnExample' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidApiKey' '403': $ref: '#/components/responses/SubscriptionRequired' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimitExceeded' '503': $ref: '#/components/responses/ServiceUnavailable' security: - bearerAuth: [] components: parameters: IdPathParam: name: id in: path required: true description: Numeric offer identifier. schema: type: integer headers: XRateLimitLimit: description: Effective request-per-minute limit for the current API key. schema: type: string example: '60' XRateLimitRemaining: description: Remaining requests in the current rate-limit window. schema: type: string example: '53' XRateLimitReset: description: Unix timestamp for the next per-minute rate-limit window. schema: type: string example: '1777015260' XQuotaLimit: description: Effective monthly quota for the current API key. schema: type: string example: '100000' XQuotaRemaining: description: Remaining requests in the current monthly quota window. schema: type: string example: '87655' XQuotaReset: description: >- Unix timestamp for the next monthly quota reset, normally the 1st day of the next month at 00:00 UTC. schema: type: string example: '1777593600' RetryAfter: description: Number of seconds to wait before retrying. schema: type: string example: '60' schemas: PublicEarn: type: object required: - id - compositeKey - platform - chain - asset - reward_assets - product_type - product_name - duration_days - apy - estimated_apy - estimated_apy_updated_at - tvl - min_amount - max_amount - available - available_updated_at - link - updated_at properties: id: type: integer compositeKey: type: string platform: oneOf: - $ref: '#/components/schemas/PublicPlatformRef' - type: 'null' chain: oneOf: - $ref: '#/components/schemas/AssetRef' - type: 'null' asset: oneOf: - $ref: '#/components/schemas/AssetRef' - type: 'null' reward_assets: type: array items: $ref: '#/components/schemas/AssetRef' product_type: type: string product_name: type: string duration_days: type: - integer - 'null' apy: type: string description: >- APY percentage serialized as a decimal string. For example, `4.25` means 4.25%. estimated_apy: type: string description: Provider-estimated APY percentage serialized as a decimal string. estimated_apy_updated_at: type: string format: date-time tvl: type: - string - 'null' description: >- Total value locked in USD when available, serialized as a decimal string. min_amount: type: - string - 'null' max_amount: type: - string - 'null' available: type: boolean description: >- Runtime availability status for the earn offer. Published offers can be returned when this is false. available_updated_at: type: string format: date-time description: When the earn offer availability status was last refreshed. link: type: string updated_at: type: string format: date-time PublicPlatformRef: type: object required: - type - slug - name properties: type: type: string enum: - exchange - wallet - protocol slug: type: string name: type: string AssetRef: type: object required: - slug - symbol - name properties: slug: type: string symbol: type: string name: type: string ErrorEnvelope: type: object required: - error properties: error: $ref: '#/components/schemas/ApiError' ApiError: type: object required: - code - message properties: code: type: string enum: - invalid_api_key - subscription_required - rate_limit_exceeded - monthly_quota_exceeded - not_found - validation_error - service_unavailable - internal_error message: type: string details: type: - object - 'null' additionalProperties: true examples: EarnExample: summary: Earn offer value: id: 101 compositeKey: binance:eth:flexible platform: type: exchange slug: binance name: Binance chain: slug: ethereum symbol: ETH name: Ethereum asset: slug: ethereum symbol: ETH name: Ethereum reward_assets: [] product_type: savings product_name: Flexible ETH Savings duration_days: null apy: '3.25' estimated_apy: '3.10' estimated_apy_updated_at: '2026-04-23T09:55:00.000Z' tvl: '4200000.00' min_amount: '0.01' max_amount: null available: true available_updated_at: '2026-04-23T09:55:00.000Z' link: https://www.binance.com/en/earn updated_at: '2026-04-23T10:00:00.000Z' responses: ValidationError: description: Request failed validation. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: validation_error message: Bad Request Exception details: message: - limit must be less than or equal to 200 InvalidApiKey: description: Bearer API key is missing, invalid, or revoked. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid_api_key message: Invalid or revoked API key. SubscriptionRequired: description: Endpoint requires an active Pro+ subscription. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: subscription_required message: This endpoint requires an active Pro+ subscription. NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: not_found message: Resource not found. RateLimitExceeded: description: Per-minute rate limit or monthly quota exceeded. headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: rateLimitExceeded: summary: Rate limit exceeded value: error: code: rate_limit_exceeded message: Rate limit of 60 requests per minute exceeded. details: reset_at: '2026-04-23T10:01:00.000Z' limit: 60 monthlyQuotaExceeded: summary: Monthly quota exceeded value: error: code: monthly_quota_exceeded message: You have exceeded your monthly quota of 100,000 requests. details: reset_at: '2026-05-01T00:00:00.000Z' limit: 100000 ServiceUnavailable: description: Request failed closed because a dependency was unavailable. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: service_unavailable message: Service temporarily unavailable. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: Bearer API key for authenticated `/api/v1/*` access. x-default: criffy_live_your_api_key_here ````