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

# Introduction

> The judgment layer for on-chain yield, as an API. Two endpoints, one header, JSON out.

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. Two
endpoints, one header, JSON out. A stranger should be able to integrate in under 30
minutes.

## Authentication

Every request must send your key in the `x-api-key` header. Keys are issued per partner.
There is no public/anonymous tier — the API **fails closed**: a request with a missing or
invalid key is rejected.

```bash theme={null}
curl https://api.atlasyield.club/v1/scores \
  -H "x-api-key: YOUR_API_KEY"
```

| Status | Meaning                          |
| ------ | -------------------------------- |
| `401`  | Missing or invalid key.          |
| `429`  | Rate limit exceeded (see below). |

## Rate limits

**60 requests / minute** per API key. Exceeding it returns `429` with standard
`RateLimit-*` headers. The dataset refreshes on a scoring cadence of hours, not seconds —
cache responses and poll sparingly.

## Versioning

Everything lives under the `/v1` prefix. Breaking changes ship under a new prefix; `/v1`
stays stable. Every score row also carries `scorerVersion` so you can pin to a scoring
engine revision.

## Disclaimer

Atlas Scores are **research and information, not investment advice**. The same line ships
on every response — as a `disclaimer` field and an `X-Atlas-Disclaimer` header. Scores are
neutral, model-driven signals; you are responsible for your own listing and allocation
decisions. See [Limitations](/limitations).

## Request an API key

The API is in private beta for design partners. To get a key, email
[hello@atlasyield.club](mailto:hello@atlasyield.club) or DM
[@atlasyieldclub](https://x.com/atlasyieldclub) on X. Tell us the surface you're building
and the chains you care about.