Experience
Read the leaderboard
Workspaces that chose to be listed, most XP first.
GET
/v1/leaderboardTL;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. |
| 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. |
What it does
Workspaces that chose to be listed, most XP first. A workspace is listed only after PUT /v1/leaderboard/entry.
Example
bash
curl -X GET 'https://api.flung.dev/v1/leaderboard' \ --header "Authorization: Bearer $FLUNG_API_KEY"ts
import { Flung } from '@flung.dev/sdk'
const flung = new Flung({ apiKey: process.env.FLUNG_API_KEY! })const result = await flung.experience.leaderboard()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 |
| 401 | Missing, unknown, revoked or expired API key. | Error |
| 422 | The request failed validation. | Error |
| 429 | Too many requests for this credential; wait for retry-after seconds. | Error |
Response body
A 200 answer has the type 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 | Every endpoint |
| Schemas | Every request and response type |
| Errors | Every error code and what to do about it |