canonical: https://jentic.com/apis/atlasyield.club/atlasyield

# Atlasyield Club AtlasYield API

The AtlasYield API provides read-only access to the Atlas Score Index, a neutral 16-factor scoring of DeFi vaults across four pillars: yield, safety, liquidity, and sustainability. You can read the latest scores across the tracked vault catalog, pull a single vault's full factor breakdown, live risk metrics, and route-survival verdict, score an arbitrary basket of vaults, and build a risk-adjusted portfolio allocation from the index. It also reports per-chain gas regimes with current and trailing percentiles. It is research and information, not investment advice.

## For AI agents

Read neutral 16-factor DeFi vault scores, risk metrics, and route verdicts, score a basket of vaults, and build a risk-adjusted portfolio. Every endpoint is public; an optional partner key raises the rate limit.

## Scope

Does not execute trades, custody funds, or give investment advice. Use for reading DeFi vault scores, metrics, and allocations only.

## Capabilities

- Read the latest Atlas Score Index scores across the tracked vault catalog
- Pull a single vault's 16-factor breakdown, live risk metrics, and route-survival verdict
- Score an arbitrary basket of vaults
- Build a risk-adjusted portfolio allocation from the index
- Check a chain's gas regime with current and trailing percentiles

## Use cases

### Agent Vault Screening

An AI agent connected through Jentic reads the latest Atlas scores and a vault's 16-factor breakdown to screen DeFi vaults by yield, safety, liquidity, and sustainability before a person decides anything. Because the index is read-only and neutral, the agent is surfacing research, not placing trades.

Example prompt: Read the latest scores and return the three safest vaults with their factor breakdowns

### Portfolio Construction

A research workflow scores a custom basket of vaults and asks the engine for a risk-adjusted allocation, so an agent can evaluate a proposed mix instead of one vault at a time. The portfolio and basket endpoints turn the raw scores into an allocation view.

Example prompt: Score this basket of vaults and return a risk-adjusted allocation across them

### Risk and Gas Monitoring

A monitor reads each vault's live risk metrics and route-survival verdict and checks the per-chain gas regime, so an agent can flag when a vault's risk posture or a chain's gas percentiles move. The trailing percentiles give context for whether a reading is unusual.

Example prompt: Report a vault's live risk metrics and route-survival verdict and the current gas regime for its chain

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/scores` | Latest vault scores |
| GET | `/catalog` | Tracked vault catalog |
| POST | `/basket` | Score a basket of vaults |
| GET | `/portfolio` | Build a risk-adjusted portfolio |
| GET | `/vaults/{chainId}/{address}/factors` | 16-factor breakdown for one vault |
| GET | `/gas` | Per-chain gas regime |

## Key resources

- **Scores** — Latest Atlas Score Index values across yield, safety, liquidity, and sustainability
- **Vaults** — Per-vault 16-factor breakdown, live risk metrics, and route-survival verdict
- **Portfolio** — Basket scoring and risk-adjusted allocation built from the index
- **Gas** — Per-chain gas regime with current and trailing percentiles

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 62 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 60 / 100
  - Developer Experience & Jentic Compatibility: 71 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 84 / 100
- **View full report:** https://jentic.com/apis/atlasyield.club/atlasyield/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the AtlasYield API by hand means handling its two rate buckets, deciding whether to send an optional partner key in the x-api-key header, and parsing the 16-factor score payloads. Through Jentic you install once, import AtlasYield from the API Directory, store the partner key once if you have one, and your agent calls it.
- **Permission scoping:** AtlasYield puts the chain id and vault address in the URL path, so a rule can let your agent read scores and factor breakdowns while leaving the portfolio and basket-scoring calls out. The whole API is read-only, so you are choosing which reads the agent may make, not giving it any way to move funds.
- **Credential handling:** Your AtlasYield partner key, if you use one, is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'read vault scores' or 'score a basket of vaults', and Jentic returns the matching AtlasYield operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **Dune API** — On-chain analytics with custom SQL queries over blockchain data
- **CoinGecko API** — Crypto market data: prices, market caps, and token metadata
- **CoinMarketCap API** — Cryptocurrency prices, rankings, and market data

## FAQ

### Is there an AtlasYield MCP server?

You don't need an MCP server to give your agent the AtlasYield API. Jentic connects it directly from the API Directory: import it, store a partner key once if you have one, and your agent can read vault scores and metrics straight away, with no extra server to run and no tool definitions to load into the agent's context.

### Can I limit what my agent is allowed to do with the AtlasYield API?

Yes. Write a rule that allows reading scores, factor breakdowns, and gas regimes but not the portfolio and basket-scoring calls, so the agent can look up vault research without constructing allocations, and every call it makes is logged. The whole API is read-only, so no rule can make it move funds.

### What authentication does the AtlasYield API use?

Every endpoint in the AtlasYield spec is public and keyless. An optional partner key sent in the x-api-key header moves you to a higher rate bucket and unlocks partner-only endpoints, per its OpenAPI spec. Through Jentic the partner key, if you use one, is stored encrypted by your own instance and added at call time, so it never appears in the agent's prompt or logs.

### Can I score a basket of vaults with the AtlasYield API?

Yes. The basket-scoring endpoint takes a set of vaults and returns their combined Atlas scores, and the portfolio endpoint turns the index into a risk-adjusted allocation, so an agent can evaluate a custom mix rather than one vault at a time. Each vault also exposes its full 16-factor breakdown.

### What are the rate limits for the AtlasYield API?

Public endpoints are limited to 60 requests per minute per IP according to the API's own description; an optional partner key raises that to 100 requests per minute in its own bucket. For current limits and partner access, see the AtlasYield documentation at https://docs.atlasyield.club.

### How do I read DeFi vault scores with the AtlasYield API through Jentic?

Import the AtlasYield API from the Jentic API Directory, then have your agent issue a request such as 'read the latest vault scores and show the safest ones'. Jentic matches the intent to the scores and factor-breakdown operations and returns their input schemas so the agent builds the right calls. To run it on your own infrastructure, install Jentic One from its GitHub repo.
