> ## 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 collateral offer by ID



## OpenAPI

````yaml /openapi/public-api.yaml get /api/v1/collateral/{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/collateral/{id}:
    get:
      tags:
        - Collateral
      summary: Get collateral offer by ID
      operationId: getCollateralOffer
      parameters:
        - $ref: '#/components/parameters/IdPathParam'
      responses:
        '200':
          description: Collateral 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/PublicCollateral'
              examples:
                collateral:
                  $ref: '#/components/examples/CollateralExample'
        '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:
    PublicCollateral:
      type: object
      required:
        - id
        - compositeKey
        - platform
        - chain
        - asset
        - platform_type
        - term_days
        - initial_ltv
        - margin_call_ltv
        - liquidation_ltv
        - is_active
        - link
        - synced_at
        - 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:
          $ref: '#/components/schemas/AssetRef'
        platform_type:
          type: string
        term_days:
          type:
            - integer
            - 'null'
        initial_ltv:
          type: string
          description: Initial loan-to-value percentage serialized as a decimal string.
        margin_call_ltv:
          type:
            - string
            - 'null'
          description: >-
            Margin-call LTV percentage serialized as a decimal string when
            available.
        liquidation_ltv:
          type:
            - string
            - 'null'
          description: >-
            Liquidation LTV percentage serialized as a decimal string when
            available.
        is_active:
          type: boolean
          description: >-
            Runtime activity status for the collateral offer. Published offers
            can be returned when this is false.
        link:
          type: string
        synced_at:
          type: string
          format: date-time
        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:
    CollateralExample:
      summary: Collateral offer
      value:
        id: 701
        compositeKey: aave:ethereum:wbtc
        platform:
          type: protocol
          slug: aave
          name: Aave
        chain:
          slug: ethereum
          symbol: ETH
          name: Ethereum
        asset:
          slug: wrapped-bitcoin
          symbol: WBTC
          name: Wrapped Bitcoin
        platform_type: protocol
        term_days: null
        initial_ltv: '70'
        margin_call_ltv: '78'
        liquidation_ltv: '80'
        is_active: true
        link: https://app.aave.com
        synced_at: '2026-04-23T09:58:00.000Z'
        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

````