> ## 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 protocol by slug

> Returns the current protocol or a permanent redirect if the slug was renamed.



## OpenAPI

````yaml /openapi/public-api.yaml get /api/v1/protocols/{slug}
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/protocols/{slug}:
    get:
      tags:
        - Protocols
      summary: Get protocol by slug
      description: >-
        Returns the current protocol or a permanent redirect if the slug was
        renamed.
      operationId: getProtocol
      parameters:
        - $ref: '#/components/parameters/SlugPathParam'
      responses:
        '200':
          description: Protocol resource.
          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/PublicPlatform'
              examples:
                protocol:
                  $ref: '#/components/examples/ProtocolExample'
        '301':
          description: Resource moved permanently to the latest slug.
          headers:
            Location:
              schema:
                type: string
              description: New canonical URL for this resource.
              example: /api/v1/protocols/aave
        '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:
    SlugPathParam:
      name: slug
      in: path
      required: true
      description: Canonical resource slug.
      schema:
        type: string
  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:
    PublicPlatform:
      type: object
      required:
        - type
        - slug
        - name
        - url
        - logo64
        - stats
        - updated_at
      properties:
        type:
          type: string
          enum:
            - exchange
            - wallet
            - protocol
        slug:
          type: string
        name:
          type: string
        url:
          type: string
        logo64:
          type:
            - string
            - 'null'
        stats:
          oneOf:
            - $ref: '#/components/schemas/ExchangeStats'
            - $ref: '#/components/schemas/WalletStats'
            - $ref: '#/components/schemas/ProtocolStats'
        updated_at:
          type: string
          format: date-time
    ExchangeStats:
      type: object
      required:
        - num_coins
        - num_markets
        - weekly_visits
        - daily_spot_volume
        - is_centralized
      properties:
        num_coins:
          type:
            - integer
            - 'null'
        num_markets:
          type:
            - integer
            - 'null'
        weekly_visits:
          type:
            - integer
            - 'null'
        daily_spot_volume:
          type:
            - number
            - 'null'
        is_centralized:
          type:
            - boolean
            - 'null'
    WalletStats:
      type: object
      required:
        - wallet_type
        - num_coins
        - anonymity_rating
        - ease_of_use_rating
        - security_rating
        - platforms
        - additional_services
      properties:
        wallet_type:
          type:
            - string
            - 'null'
        num_coins:
          type:
            - integer
            - 'null'
        anonymity_rating:
          type:
            - number
            - 'null'
        ease_of_use_rating:
          type:
            - number
            - 'null'
        security_rating:
          type:
            - number
            - 'null'
        platforms:
          type: array
          items:
            type: string
        additional_services:
          type: array
          items:
            type: string
    ProtocolStats:
      type: object
      required:
        - category
        - tvl
      properties:
        category:
          type:
            - string
            - 'null'
        tvl:
          type:
            - string
            - 'null'
    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:
    ProtocolExample:
      summary: Protocol resource
      value:
        type: protocol
        slug: aave
        name: Aave
        url: https://aave.com
        logo64: https://s03.criffy.com/platforms/aave.png
        stats:
          category: Lending
          tvl: '12500000000.42'
        updated_at: '2026-04-23T10:00:00.000Z'
  responses:
    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

````