> For the complete documentation index, see [llms.txt](https://xerberus.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xerberus.gitbook.io/documentation/readme.md).

# Introduction

The Xerberus Public API gives you programmatic access to the structured datasets behind `app.xerberus.io` — DeFi vaults, registry scores, and gamification accounts. It's a REST-ish JSON API, authenticated with an API key, served from a single base URL. For token risk scores and on-chain risk analytics, see the [MCP servers](/documentation/mcp/xerberus-mcp.md).

```
https://api.xerberus.io/public/v1
```

> The base URL above is the production endpoint. If you need a different environment (staging, custom domain), contact Xerberus support.

## What's in here

* [**Getting started**](/documentation/getting-started.md) — request your API key, make your first call.
* [**Setup**](/documentation/setup.md) — base URL, required headers, response envelope, status codes, rate limits.
* [**API requirements**](/documentation/api-requirements.md) — How to request a key, key lifecycle, and key handling.

## API reference

Not sure where to start? [**What to use for what**](/documentation/api-reference/what-to-use.md) maps each task to the right surface — REST endpoint or MCP server.

| Group                                                               | What it covers                                                          |
| ------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [What to use for what](/documentation/api-reference/what-to-use.md) | Decision guide: which endpoint or MCP server to reach for.              |
| [Vault](/documentation/api-reference/vault.md)                      | DeFi vault list and per-vault dendrogram reports.                       |
| [Registry](/documentation/api-reference/registry.md)                | Dendrogram-based scores across protocols, pools, organisations, assets. |
| [Users](/documentation/api-reference/users.md)                      | Gamification accounts (wallet + username).                              |

> Token risk scores, ratings, and on-chain risk analytics are served through the [MCP servers](/documentation/mcp/xerberus-mcp.md), not the REST API. See [What to use for what](/documentation/api-reference/what-to-use.md).

## Conventions

* All paths in this reference are written **without** the `/public/v1` prefix in the endpoint header — but the prefix is always required when calling. So `GET /registry/scores` means `GET https://api.xerberus.io/public/v1/registry/scores`.
* Every authenticated endpoint requires the `x-api-key` and `x-user-email` headers. See [API requirements](/documentation/api-requirements.md).
* Each route group also exposes an unauthenticated `GET /<group>/healthcheck` that returns plain text and is intended for liveness probes only.

## Support

If you hit a wall or find something off in these docs, reach out to your Xerberus contact.