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

> One token's rating with each dimension's reason, the sourced research evidence, the latest live signals and the rating history. A token without a registry entry, or not held by any scored vault, returns rated false with the reason, never an invented rating.



## OpenAPI

````yaml api-reference/openapi.yaml GET /tokens/{chainId}/{address}
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/{chainId}/{address}:
    get:
      summary: One token with its evidence
      description: >-
        One token's rating with each dimension's reason, the sourced research
        evidence, the latest live signals and the rating history. A token
        without a registry entry, or not held by any scored vault, returns rated
        false with the reason, never an invented rating.
      operationId: getToken
      parameters:
        - $ref: '#/components/parameters/PartnerKey'
        - name: chainId
          in: path
          required: true
          schema:
            type: integer
          example: 1
        - name: address
          in: path
          required: true
          schema:
            type: string
          example: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
      responses:
        '200':
          description: The token's rating and evidence, or the not-rated 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/TokenDetail'
        '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:
    TokenDetail:
      type: object
      properties:
        rated:
          type: boolean
        reason:
          type: string
          description: Why the token is not rated (only when rated is false).
        chainId:
          type: integer
        address:
          type: string
        assetId:
          type: string
          nullable: true
        rating:
          type: object
          nullable: true
          properties:
            band:
              type: string
              enum:
                - strong
                - sound
                - watch
                - weak
            total:
              type: number
            dimensions:
              type: object
              description: >-
                Each dimension's score and reason; cappedFrom is present when a
                live cap lowered it.
              additionalProperties:
                type: object
                properties:
                  score:
                    type: number
                  reason:
                    type: string
                  cappedFrom:
                    type: number
            caps:
              type: array
              items:
                $ref: '#/components/schemas/TokenCap'
            reviewDue:
              type: boolean
            computedAt:
              type: string
              format: date-time
            exposureUsd:
              type: number
        evidence:
          type: object
          nullable: true
          description: >-
            The registry entry: issuer, family, peg target, every chain
            deployment (native, bridged or wrapped, with the on-chain control
            facts), the five dimensions with their sources (URL, access date,
            quote), incidents and the review dates.
        signals:
          type: object
          description: >-
            Latest live readings by kind (peg, volatility, exit, age), each with
            value, source and observedAt.
        history:
          type: array
          description: Stored rating changes, newest first (up to 90).
          items:
            type: object
            properties:
              computedAt:
                type: string
                format: date-time
              band:
                type: string
              total:
                type: number
                nullable: true
              caps:
                type: array
                items:
                  $ref: '#/components/schemas/TokenCap'
    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.