> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superform.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Provider By Id

> Returns a single provider. The {id} path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_{day,week,month,year} computed across the provider's eligible vaults.



## OpenAPI

````yaml https://persephone.superform.xyz/openapi.json get /v1/providers/{id}
openapi: 3.1.0
info:
  title: Superform API
  description: API for interacting with the Superform platform
  version: 33.2.0
  contact:
    name: Superform Team
    url: https://superform.xyz
servers:
  - url: https://persephone.superform.xyz
security:
  - SF-API-KEY: []
tags:
  - name: RestAPIService
paths:
  /v1/providers/{id}:
    get:
      tags:
        - RestAPIService
      summary: Get Provider By Id
      description: >-
        Returns a single provider. The {id} path param accepts a provider id, a
        vanity_url, or a slugified name; the BE tries each in turn. 404 when the
        slug does not resolve OR the provider is hidden/unapproved (the BE
        deliberately does not leak existence). Detail responses include
        pre-resolved chains and highest_apy_{day,week,month,year} computed
        across the provider's eligible vaults.
      operationId: RestAPIService_GetProviderById
      parameters:
        - name: id
          description: >-
            Provider id, vanity_url, or slugified name. The BE resolves all
            three (id first, then vanity_url, then slug).
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/restGetProviderByIdResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
components:
  schemas:
    restGetProviderByIdResponse:
      type: object
      properties:
        provider:
          $ref: '#/components/schemas/commonProvider'
    rpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    commonProvider:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        provider_type:
          type: string
          example: protocol
          description: 'Provider type. Possible values: protocol, curator, issuer'
        category:
          type: array
          items:
            type: string
        chain_ids:
          type: array
          items:
            type: string
            format: uint64
        is_hidden:
          type: boolean
        vanity_url:
          type: string
          example: morpho-blue
          description: >-
            Optional admin-set URL slug. When non-empty it overrides the
            slugified name as the provider's canonical slug.
        num_vaults:
          type: string
          format: int64
        tagline:
          type: string
        status_message:
          type: string
        metadata:
          $ref: '#/components/schemas/commonProviderMetadata'
        deployers:
          type: array
          items:
            $ref: '#/components/schemas/commonDeployer'
        users:
          type: array
          items:
            $ref: '#/components/schemas/commonUser'
          title: these are admins
        stats_basic:
          $ref: '#/components/schemas/commonProviderStatsBasic'
        created_at:
          type: string
          format: date-time
        admin_status:
          type: string
          example: approved
          description: >-
            Admin approval status for the provider. One of: enqueued, approved,
            rejected.
        auto_list_vaults:
          type: boolean
          example: false
          description: >-
            Whether newly approved vaults for this provider should be
            auto-listed. Defaults to false.
        slug:
          type: string
          example: morpho-blue
          description: >-
            Canonical URL-safe slug (vanity_url when set, else slugified name).
            Unique across providers.
        chains:
          type: array
          items:
            $ref: '#/components/schemas/commonChain'
          description: >-
            Pre-resolved chains (id/name/icon) for the chains this provider
            operates on. Populated on provider-detail responses.
        highest_apy_day:
          type: number
          format: double
        highest_apy_week:
          type: number
          format: double
        highest_apy_month:
          type: number
          format: double
        highest_apy_year:
          type: number
          format: double
      title: Provider represents a DeFi protocol
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
      additionalProperties: {}
    commonProviderMetadata:
      type: object
      properties:
        audits:
          type: array
          items:
            $ref: '#/components/schemas/commonAudit'
        faq:
          type: array
          items:
            $ref: '#/components/schemas/commonFAQ'
        graphics:
          $ref: '#/components/schemas/ProviderMetadataGraphics'
        links:
          $ref: '#/components/schemas/ProviderMetadataLinks'
    commonDeployer:
      type: object
      properties:
        address:
          type: string
        name:
          type: string
        is_verified:
          type: boolean
        admin_status:
          type: string
          example: approved
          description: >-
            Admin approval status for the deployer-provider association. One of:
            enqueued, approved, rejected.
        created_at:
          type: string
    commonUser:
      type: object
      properties:
        address:
          type: string
        name:
          type: string
        role:
          type: string
    commonProviderStatsBasic:
      type: object
      properties:
        tvl_total:
          type: number
          format: double
        tvl_superform:
          type: number
          format: double
        tvl_total_change_day:
          type: number
          format: double
        tvl_total_change_week:
          type: number
          format: double
        tvl_total_change_month:
          type: number
          format: double
        tvl_total_change_year:
          type: number
          format: double
        tvl_total_change_all_time:
          type: number
          format: double
        tvl_superform_change_day:
          type: number
          format: double
        tvl_superform_change_week:
          type: number
          format: double
        tvl_superform_change_month:
          type: number
          format: double
        tvl_superform_change_year:
          type: number
          format: double
        tvl_superform_change_all_time:
          type: number
          format: double
    commonChain:
      type: object
      properties:
        chain_id:
          type: string
          format: uint64
        name:
          type: string
        icon:
          type: string
        is_l1:
          type: boolean
        rpcs:
          type: array
          items:
            type: string
        explorers:
          type: array
          items:
            type: string
        currency_name:
          type: string
        currency_symbol:
          type: string
        currency_icon:
          type: string
        currency_decimals:
          type: integer
          format: int32
        currency_min_gas:
          type: string
      title: Chain represents a blockchain network
    commonAudit:
      type: object
      properties:
        date:
          type: string
          format: date-time
        url:
          type: string
        auditor:
          type: string
    commonFAQ:
      type: object
      properties:
        question:
          type: string
        answer:
          type: string
      title: '--- metadata types ---'
    ProviderMetadataGraphics:
      type: object
      properties:
        icon:
          type: string
        header:
          type: string
        watermark:
          type: string
    ProviderMetadataLinks:
      type: object
      properties:
        discord:
          type: string
        documentation:
          type: string
        github:
          type: string
        medium:
          type: string
        telegram:
          type: string
        twitter:
          type: string
        website:
          type: string
  securitySchemes:
    SF-API-KEY:
      type: apiKey
      description: >-
        API key required for authentication. Use the value {{v2_api_key}} in
        Postman.
      name: SF-API-KEY
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.