# Read the leaderboard

> Page: https://docs.flung.dev/reference/api/get-v1-leaderboard. Index of every page: https://docs.flung.dev/llms.txt

Workspaces that chose to be listed, most XP first.

`GET /v1/leaderboard`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Read the leaderboard. |
| What does it need? | An API key or an OAuth access token. |
| What does it take? | `limit` in the query string. |
| What does it return? | Status 200 with a body of type [`Leaderboard`](https://docs.flung.dev/reference/api/schemas.md#leaderboard). |
| In the SDK? | `flung.experience.leaderboard()` |
| What can go wrong? | `401` Missing, unknown, revoked or expired API key; `422` The request failed validation; `429` Too many requests for this credential; wait for `retry-after` seconds. Every failure has the same [error shape](https://docs.flung.dev/reference/api/errors.md). |

## What it does

Workspaces that chose to be listed, most XP first. A workspace is listed only after PUT /v1/leaderboard/entry.

## Example

**curl**

```bash
curl -X GET 'https://api.flung.dev/v1/leaderboard' \
  --header "Authorization: Bearer $FLUNG_API_KEY"
```

**TypeScript**

```ts
import { Flung } from '@flung.dev/sdk'

const flung = new Flung({ apiKey: process.env.FLUNG_API_KEY! })
const result = await flung.experience.leaderboard()
```

**fetch**

```js
const response = await fetch('https://api.flung.dev/v1/leaderboard', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.FLUNG_API_KEY}`,
  },
})
if (!response.ok) throw new Error((await response.json()).error.message)
const result = await response.json()
```

A successful answer looks like this:

```json
{
  "data": [
    {
      "rank": 1,
      "name": "string",
      "level": 1,
      "xp": 1,
      "you": true
    }
  ]
}
```

## Query parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `limit` | `integer` | no |  |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | The top workspaces. | [`Leaderboard`](https://docs.flung.dev/reference/api/schemas.md#leaderboard) |
| 401 | Missing, unknown, revoked or expired API key. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 422 | The request failed validation. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 429 | Too many requests for this credential; wait for `retry-after` seconds. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |

## Response body

A 200 answer has the type [`Leaderboard`](https://docs.flung.dev/reference/api/schemas.md#leaderboard).

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | `object[]` | yes |  |
| `data[].rank` | `integer` | yes |  |
| `data[].name` | `string` | yes |  |
| `data[].level` | `integer` | yes |  |
| `data[].xp` | `integer` | yes |  |
| `data[].you` | `boolean` | yes |  |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.flung.dev/reference/api.md) | Every endpoint |
| [Schemas](https://docs.flung.dev/reference/api/schemas.md) | Every request and response type |
| [Errors](https://docs.flung.dev/reference/api/errors.md) | Every error code and what to do about it |