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

# Vault catalog

> The tracked vault universe — every vault Atlas scores, with its live APY and TVL. Use it to discover vaultIds before querying /scores.



## OpenAPI

````yaml api-reference/openapi.yaml GET /catalog
openapi: 3.1.0
info:
  title: AtlasYield API
  version: '1.0'
  description: >-
    Read-only access to the Atlas Score Index: neutral 16-factor vault scores
    across four pillars — Yield, Safety, Liquidity, Sustainability — plus the
    tracked vault catalog. Research and information, not investment advice.
servers:
  - url: https://api.atlasyield.club/v1
security:
  - apiKey: []
paths:
  /catalog:
    get:
      summary: Vault catalog
      description: >-
        The tracked vault universe — every vault Atlas scores, with its live APY
        and TVL. Use it to discover vaultIds before querying /scores.
      operationId: getCatalog
      parameters:
        - name: chainId
          in: query
          required: false
          schema:
            type: integer
          description: Filter to one EVM chain id.
          example: 8453
        - name: protocolId
          in: query
          required: false
          schema:
            type: string
          description: Filter to one protocol slug.
          example: morpho
      responses:
        '200':
          description: The tracked vault universe.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  count:
                    type: integer
                    example: 835
                  disclaimer:
                    type: string
                    example: Research and information, not investment advice.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CatalogEntry'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    CatalogEntry:
      type: object
      properties:
        id:
          type: string
          description: Vault identifier (same as vaultId in /scores).
          example: aave-v3:8453:0x4e65fe4dba92790696d040ac24aa414708f5c0ab
        chainId:
          type: integer
          example: 8453
        protocolId:
          type: string
          example: aave-v3
        protocol:
          type: string
          description: Human-readable protocol name.
          example: Aave V3
        asset:
          type: string
          example: USDC
        name:
          type: string
          description: Display name (protocol + asset).
          example: Aave V3 USDC
        tvl:
          type: number
          description: Total value locked, USD.
          example: 1250400
        apy:
          type: number
          description: Current APY in percentage points.
          example: 5.21
  responses:
    Unauthorized:
      description: Missing or invalid API key.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Per-partner API key. The API fails closed — a missing or invalid key is
        rejected with 401.

````