> ## Documentation Index
> Fetch the complete documentation index at: https://docs.frozi.lol/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> frozi.lol API Reference — profile data, leaderboard, and links

<Note>
  The frozi.lol API lets developers access **profile data**, **leaderboard**, and **profile-related content** (e.g. links) via a REST API. All endpoints are protected by API keys (managed in the dashboard).
</Note>

## What is the frozi.lol API?

The [frozi.lol](https://frozi.lol) API is a REST API that provides:

* **Leaderboard** — top profiles by view count
* **Lookup** — profile by username, UID, or auth ID
* **Profile links** — public links for a profile by username

Every request must include a valid API key. Keys are created and managed in the frozi.lol dashboard and are assigned permissions (`api.leaderboard`, `api.lookup`). Rate limiting applies.

## Base URL

All endpoints are relative to:

```
https://frozi.lol/api
```

Example: the leaderboard endpoint is `GET https://frozi.lol/api/leaderboard`.

## Next steps

1. [Get an API key](/api-reference/api-keys) — request a key in the dashboard and use it in your requests.
2. [Authentication](/api-reference/authentication) — how to send the API key (Bearer) and which permissions are required.
3. Browse [Leaderboard](/api-reference/endpoint/leaderboard) and [Lookup](/api-reference/endpoint/lookup-username) endpoints in the sidebar.