> ## 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 composition

> The vault's holdings, recursively: the markets, pools, strategies and tokens it sits in, how much of each, and for lending positions the collateral behind the loans. Every holding names the contract call or API request it was read from, so anyone can re-check it. Rebuilt every 4-hour scoring run; stored when it changes and once a day.

A vault without a stored composition returns `composed: false` with every field `null`, never an invented one.



## OpenAPI

````yaml api-reference/openapi.yaml GET /vaults/{chainId}/{address}/composition
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 and the Atlas Engine, which turns those scores into a
    risk-adjusted allocation. Research and information, not investment advice.

    Every endpoint in this spec is public and keyless, limited to 60 requests
    per minute per IP. An optional partner key sent in the `x-api-key` header
    moves the caller to its own bucket of 100 requests per minute and unlocks
    two endpoints that are not part of this spec (every vault's factor breakdown
    in one call, and score history). A key is never required: an unknown or
    retired key sent to a public endpoint is ignored, and only the two partner
    endpoints reject it, with a 401. How to get one:
    https://docs.atlasyield.club/partner-access
servers:
  - url: https://api.atlasyield.club/v1
security: []
paths:
  /vaults/{chainId}/{address}/composition:
    get:
      summary: What a vault holds, with sources
      description: >-
        The vault's holdings, recursively: the markets, pools, strategies and
        tokens it sits in, how much of each, and for lending positions the
        collateral behind the loans. Every holding names the contract call or
        API request it was read from, so anyone can re-check it. Rebuilt every
        4-hour scoring run; stored when it changes and once a day.


        A vault without a stored composition returns `composed: false` with
        every field `null`, never an invented one.
      operationId: getVaultComposition
      parameters:
        - $ref: '#/components/parameters/PartnerKey'
        - name: chainId
          in: path
          required: true
          schema:
            type: integer
          description: Chain id the vault lives on (792703809 for Solana).
          example: 1
        - name: address
          in: path
          required: true
          schema:
            type: string
          description: Vault address. Case-insensitive.
          example: '0xBEEF01735c132Ada46AA9aA4c54623cAA92A64CB'
        - name: history
          in: query
          required: false
          description: true adds the stored change points (up to 90).
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: The latest composition for the vault, or the not-composed shape.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  disclaimer:
                    type: string
                    example: Research and information, not investment advice.
                  data:
                    $ref: '#/components/schemas/VaultComposition'
        '400':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    PartnerKey:
      name: x-api-key
      in: header
      required: false
      schema:
        type: string
      description: >-
        Optional. Not needed for any endpoint in this spec. Unlocks the
        partner-only endpoints and a 100 requests per minute bucket (public
        limit is 60 per IP).
  schemas:
    VaultComposition:
      type: object
      properties:
        composed:
          type: boolean
          description: >-
            false when no composition has been stored for this vault (every
            other field null).
        vaultId:
          type: string
          nullable: true
        chainId:
          type: integer
        address:
          type: string
        computedAt:
          type: string
          format: date-time
          nullable: true
        coverage:
          type: number
          nullable: true
          description: Share of the vault's USD traced to known tokens.
        fingerprint:
          type: string
          nullable: true
          description: >-
            Changes when the holdings or any share of 1 percentage point or more
            changes.
        top:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/TopHolding'
        root:
          allOf:
            - $ref: '#/components/schemas/Holding'
          nullable: true
        history:
          type: array
          description: >-
            Only with history=true. Stored change points, newest first (a row
            per material change plus one per day, up to 90).
          items:
            type: object
            properties:
              computedAt:
                type: string
                format: date-time
              fingerprint:
                type: string
              coverage:
                type: number
              top:
                type: array
                items:
                  $ref: '#/components/schemas/TopHolding'
    TopHolding:
      type: object
      properties:
        label:
          type: string
          example: USDC
        symbol:
          type: string
          nullable: true
          example: USDC
        weight:
          type: number
          description: Share of the vault
          0 to 1.: null
          example: 0.42
    Holding:
      type: object
      description: >-
        One holding in a vault's composition. `kind` is vault, lending, lp,
        wrapper, pt, token or unknown (named but not readable; the reason is in
        `label`). `usd` is this holding's value inside the vault and `weight`
        its share of the parent. `source` names where the holding was read:
        `via` onchain (contract and call) or api (endpoint and query), so it can
        be re-checked. `opaque` marks a wrapper whose venue was not resolved
        (the token is known, where it sits is not). `backing` (lending only) is
        the collateral behind the loans: scope `market` for a single Morpho
        market, `pool` for pooled lending (Aave, Euler, Kamino), with LTV, LLTV
        or liquidation threshold, the oracle where known, and collateral USD per
        borrowed USD.
      properties:
        kind:
          type: string
          enum:
            - vault
            - lending
            - lp
            - wrapper
            - pt
            - token
            - unknown
        chainId:
          type: integer
        address:
          type: string
        symbol:
          type: string
          nullable: true
        label:
          type: string
        usd:
          type: number
        weight:
          type: number
        opaque:
          type: boolean
        source:
          type: object
          properties:
            via:
              type: string
              enum:
                - onchain
                - api
            ref:
              type: string
              example: 0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c.POOL()
            at:
              type: string
              format: date-time
        children:
          type: array
          items:
            $ref: '#/components/schemas/Holding'
        backing:
          type: array
          items:
            allOf:
              - $ref: '#/components/schemas/Holding'
              - type: object
                properties:
                  scope:
                    type: string
                    enum:
                      - market
                      - pool
                  share:
                    type: number
                  ltv:
                    type: number
                  lltv:
                    type: number
                  liquidationThreshold:
                    type: number
                  oracle:
                    type: string
                  collateralRatio:
                    type: number
  responses:
    ValidationError:
      description: >-
        A query parameter is missing or out of range. The body carries per-field
        detail under `details.fieldErrors`.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              error:
                type: string
                example: Validation error
              details:
                type: object
                description: Zod field errors, keyed by parameter name.

````

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