> ## 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 Gauntlet-curated vaults

> Returns identification-only rows for the admin-curated visible vaults, ordered most-recent-first; pass `?include_hidden=true` for every enabled vault (hidden included, disabled never). Each row's `group.id` groups deployments of the same logical Admin vault, `group.slug` is its unique public route, and `group.is_primary` identifies its representative. Use `/{vault_id}` for current metrics, `/{vault_id}/definition` for the full vault definition, `/{vault_id}/timeseries` for history.

Cursor-paginated, but the default page size is the cap so most callers don't need to think about it — pass `meta.next_cursor` back as `?next=` only if the result exceeds 1000 vaults.



## OpenAPI

````yaml GET /v1/vaults
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:
    get:
      tags:
        - Vaults
      summary: List Gauntlet-curated vaults
      description: >-
        Returns identification-only rows for the admin-curated visible vaults,
        ordered most-recent-first; pass `?include_hidden=true` for every enabled
        vault (hidden included, disabled never). Each row's `group.id` groups
        deployments of the same logical Admin vault, `group.slug` is its unique
        public route, and `group.is_primary` identifies its representative. Use
        `/{vault_id}` for current metrics, `/{vault_id}/definition` for the full
        vault definition, `/{vault_id}/timeseries` for history.


        Cursor-paginated, but the default page size is the cap so most callers
        don't need to think about it — pass `meta.next_cursor` back as `?next=`
        only if the result exceeds 1000 vaults.
      operationId: list_vaults
      parameters:
        - name: next
          in: query
          description: Opaque cursor from previous `meta.next_cursor`.
          required: false
          schema:
            type: string
        - name: limit
          in: query
          description: Page size (1–1000, default 1000).
          required: false
          schema:
            type: integer
            format: int64
        - name: include_hidden
          in: query
          description: >-
            Include hidden (enabled but unlisted) vaults alongside visible ones.
            Disabled vaults are never listed.
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: List of vaults
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultListResponse'
        '401':
          description: Missing or invalid auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid cursor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    VaultListResponse:
      type: object
      required:
        - meta
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/VaultDetail'
        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'
    VaultDetail:
      type: object
      required:
        - vault_id
        - chain_id
        - address
        - vault_type
        - name
        - symbol
        - numeraire_token
        - metrics
      properties:
        address:
          type: string
        chain_id:
          type: integer
          format: int64
        group:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/VaultGroupRef'
              description: >-
                Admin-curated logical group. Absent only when the deployment is
                not yet

                associated with an Admin vault group.
        metrics:
          $ref: '#/components/schemas/VaultMetrics'
        name:
          type: string
        numeraire_token:
          $ref: '#/components/schemas/TokenRef'
        strategy:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StrategyRef'
              description: |-
                Curated strategy from the admin registry; `null` when the vault
                has no strategy tag.
        symbol:
          type: string
        vault_id:
          type: string
        vault_type:
          type: string
    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
    VaultGroupRef:
      type: object
      description: Admin-curated logical grouping for a deployment-level vault row.
      required:
        - id
        - slug
        - is_primary
        - is_stable
      properties:
        deployment_date:
          type:
            - string
            - 'null'
          description: Admin-curated deployment date (`YYYY-MM-DD`).
        description:
          type:
            - string
            - 'null'
          description: Admin-curated long-form detail-page copy.
        id:
          type: string
          description: Stable internal group id from the Admin vault registry (`vlt_176`).
        is_primary:
          type: boolean
          description: Whether this deployment is the group's primary representative.
        is_stable:
          type: boolean
          description: Whether performance views should use a stable-denominated basis.
        slug:
          type: string
          description: Unique, curator-managed public route (`stgusda`).
    VaultMetrics:
      type: object
      required:
        - tvl
        - unit_price
        - total_supply
      properties:
        apy_30d:
          type:
            - number
            - 'null'
          format: double
        apy_7d:
          type:
            - number
            - 'null'
          format: double
        apy_90d:
          type:
            - number
            - 'null'
          format: double
        as_of:
          type:
            - integer
            - 'null'
          format: int64
        total_supply:
          type: string
        tvl:
          $ref: '#/components/schemas/AmountPair'
        unit_price:
          type: string
    TokenRef:
      type: object
      required:
        - address
      properties:
        address:
          type: string
        decimals:
          type:
            - integer
            - 'null'
          format: int32
        symbol:
          type:
            - string
            - 'null'
    StrategyRef:
      type: object
      description: Curated strategy assignment from the admin registry.
      required:
        - id
        - name
      properties:
        id:
          type: string
          description: |-
            Strategy label id (`prime_lending`, `earn`, …) — matches
            `/v1/strategies` card ids.
        name:
          type: string
          description: Display name (`Prime Lending`).
    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.
    AmountPair:
      type: object
      description: >-
        Decimal-string metric paired across native (numeraire-token) and USD.

        `native` is always present; `usd` is JSON null when pricing is
        unavailable.
      required:
        - native
      properties:
        native:
          type: string
        usd:
          type:
            - string
            - 'null'

````