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

# Token ratings

> Every token the scored vaults hold or lend against, with its band, total, five dimension scores, active live caps and our exposure, largest first. band=unrated and reviewDue=true are the review queue. The rubric is published at docs/research/TOKEN_RISK_RUBRIC.md in the AtlasYield repository.



## OpenAPI

````yaml api-reference/openapi.yaml GET /tokens
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:
  /tokens:
    get:
      summary: Risk ratings of every token the vaults hold
      description: >-
        Every token the scored vaults hold or lend against, with its band,
        total, five dimension scores, active live caps and our exposure, largest
        first. band=unrated and reviewDue=true are the review queue. The rubric
        is published at docs/research/TOKEN_RISK_RUBRIC.md in the AtlasYield
        repository.
      operationId: listTokens
      parameters:
        - $ref: '#/components/parameters/PartnerKey'
        - name: band
          in: query
          required: false
          schema:
            type: string
            enum:
              - strong
              - sound
              - watch
              - weak
              - unrated
        - name: family
          in: query
          required: false
          schema:
            type: string
          description: e.g. fiat-stable, eth-lst, pt
        - name: chainId
          in: query
          required: false
          schema:
            type: integer
        - name: reviewDue
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: Token ratings.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  disclaimer:
                    type: string
                    example: Research and information, not investment advice.
                  count:
                    type: integer
                  censusAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: >-
                      When the score tick that produced this list ran. The list
                      is exactly the tokens that tick's vault compositions
                      reached, so a token no vault holds any more drops out at
                      the next tick. Null only in the minutes after an API
                      restart, before the first tick, when the list is the
                      newest stored rating per token from the last two days.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TokenSummary'
        '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:
    TokenSummary:
      type: object
      description: >-
        One token the scored vaults hold or lend against (scorer 2.4.0). Rated
        on five dimensions from sourced research (rubric anchors 95, 85, 70, 55,
        40, 25, 10; 40 = unknown): backing 30%, redemption and exit 20%, peg and
        price stability 20%, control 15%, track record 15%. Bands: strong >= 85,
        sound 70-84, watch 55-69, weak < 55, unrated = no registry entry yet
        (the review queue). Live signals can only lower a rating; each cap is
        listed with its reading.
      properties:
        chainId:
          type: integer
        address:
          type: string
        assetId:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        symbol:
          type: string
          nullable: true
        family:
          type: string
          nullable: true
        band:
          type: string
          enum:
            - strong
            - sound
            - watch
            - weak
            - unrated
        total:
          type: number
          nullable: true
        dimensions:
          type: object
          nullable: true
          properties:
            backing:
              type: number
            redemption:
              type: number
            peg:
              type: number
            control:
              type: number
            track:
              type: number
        caps:
          type: array
          items:
            $ref: '#/components/schemas/TokenCap'
        reviewDue:
          type: boolean
          description: >-
            The research entry is past its quarterly review date (score
            unchanged).
        exposureUsd:
          type: number
          description: USD of this token held or lent against across the scored vaults.
        computedAt:
          type: string
          format: date-time
    TokenCap:
      type: object
      properties:
        kind:
          type: string
          enum:
            - peg
            - no-price
            - volatility
            - exit
        reason:
          type: string
          example: off peg by 1.50% across the last 24 h
  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.