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

# List featured vaults

> Returns the admin-curated featured shortlist, one card per logical vault in curated order: display name, marketing description, deployed chains (highest-TVL first), supply token, aggregate TVL, and the highest 7/30/90-day APY across deployments. `vault_ids` carries per-deployment `{chainId}:{address}` ids for `/v1/vaults/{vault_id}` links, in the same order as `chains`.



## OpenAPI

````yaml GET /v1/vaults/featured
openapi: 3.1.0
info:
  title: Gauntlet API
  description: Gauntlet vault data and user positions API.
  contact:
    name: Gauntlet
    url: https://gauntlet.xyz
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.gauntlet.xyz
    description: Production
security: []
tags:
  - name: System
    description: Health checks and Prometheus metrics
  - name: TVL
    description: Aggregate live TVL
  - name: Strategies
    description: Curated strategy groupings with aggregate metrics
  - name: Vaults
    description: Vault listings, details, metrics, timeseries
  - name: Users
    description: Per-wallet position state and timeseries
  - name: Prices
    description: Token price lookups and historical timeseries
paths:
  /v1/vaults/featured:
    get:
      tags:
        - Vaults
      summary: List featured vaults
      description: >-
        Returns the admin-curated featured shortlist, one card per logical vault
        in curated order: display name, marketing description, deployed chains
        (highest-TVL first), supply token, aggregate TVL, and the highest
        7/30/90-day APY across deployments. `vault_ids` carries per-deployment
        `{chainId}:{address}` ids for `/v1/vaults/{vault_id}` links, in the same
        order as `chains`.
      operationId: list_featured_vaults
      responses:
        '200':
          description: Featured vault cards
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeaturedVaultsResponse'
        '401':
          description: Missing or invalid auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Data source unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    FeaturedVaultsResponse:
      type: object
      required:
        - meta
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FeaturedVault'
        meta:
          $ref: '#/components/schemas/ListMeta'
    ErrorResponse:
      type: object
      description: Standard error response envelope returned on 4xx/5xx
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
    FeaturedVault:
      type: object
      required:
        - vault_id
        - slug
        - name
        - chains
        - tvl
        - vault_ids
      properties:
        apy_30d_max:
          type:
            - number
            - 'null'
          format: double
          description: Highest 30-day APY across the vault's deployments.
        apy_7d_max:
          type:
            - number
            - 'null'
          format: double
          description: |-
            Highest 7-day APY across the vault's deployments, fraction
            (0.0573 = 5.73%). `null` while every window is warming up or APY
            display is disabled for this vault.
        apy_90d_max:
          type:
            - number
            - 'null'
          format: double
          description: Highest 90-day APY across the vault's deployments.
        chains:
          type: array
          items:
            type: string
          description: Chain slugs the vault is deployed on, highest-TVL first.
        description:
          type:
            - string
            - 'null'
          description: |-
            Curated marketing description; `null` when the curator hasn't
            written one.
        name:
          type: string
          description: |-
            Curated display name; falls back to the registry id when the
            curator hasn't named the vault yet. `vault_id` carries the
            stable logical identifier.
        short_description:
          type:
            - string
            - 'null'
          description: |-
            Card-length copy (e.g. "Conservative lending yield with low
            risk"). `null` when the curator hasn't written any; consumers
            decide whether to fall back to `description`.
        slug:
          type: string
          description: Stable public route for the logical vault group.
        supply_token:
          type:
            - string
            - 'null'
          description: |-
            Supply (numeraire) token symbol, from the highest-TVL deployment
            that reports one.
        tvl:
          $ref: '#/components/schemas/CuratedTvl'
          description: Aggregate TVL across the vault's deployments ("Total Supply").
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: |-
            Most recent indexer snapshot among the vault's deployments;
            `null` when no deployment carried a usable timestamp.
        vault_id:
          type: string
          description: Stable logical vault id assigned by Admin.
        vault_ids:
          type: array
          items:
            type: string
          description: |-
            Per-deployment API vault ids (`{chainId}:{address}`, same order
            as `chains`) for `/v1/vaults/{vault_id}` links.
    ListMeta:
      type: object
      description: |-
        Documented metadata for list endpoints; pagination fields are omitted
        by unpaginated responses.
      required:
        - request_id
        - refreshed_at
        - count
      properties:
        count:
          type: integer
          format: int64
          description: Number of items in this response.
        limit:
          type:
            - integer
            - 'null'
          format: int64
          description: Page-size cap actually applied to paginated lists.
        next_cursor:
          type:
            - string
            - 'null'
          description: Set when more pages exist; pass back as `?next=`.
        partial_errors:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/PartialResponseError'
          description: Item-scoped failures isolated from an aggregate response.
        refreshed_at:
          type: string
          format: date-time
        request_id:
          type: string
    ErrorBody:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Machine-readable error code (e.g. `NOT_FOUND`, `UNAUTHORIZED`)
        details: {}
        message:
          type: string
          description: Human-readable error message
    CuratedTvl:
      type: object
      description: |-
        USD amount on curated aggregates: decimal string, `null` when the
        pricing service is not configured.
      properties:
        usd:
          type:
            - string
            - 'null'
    PartialResponseError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Machine-readable error code for the isolated item failure.
        message:
          type: string
          description: Human-readable error message.
        resource_id:
          type:
            - string
            - 'null'
          description: Resource that failed inside the aggregate response, when known.

````