---
title: "Leaderboards Metadata API"
method: GET
path: "/v3/leaderboards-metadata"
---

# Leaderboards Metadata API

`GET /v3/leaderboards-metadata`

Some games may have multiple types of scores. You can use The Leaderboard Metadata API to understand what each of those score values represents in the context of the game.

## Query parameters

- `game-code` string, required

## Response `200`

200 OK. If the game has no leaderboards, the data array will be empty.

- LeaderboardsMetadataResponse
  - `data` LeaderboardMetadata[] — Array of leaderboard metadata objects. May be empty if the game has no leaderboards.
    - `leaderboard_id` string — A unique identifier for the Leaderboard
    - `name` string — English name of the Leaderboard (can be displayed to end-users)
    - `description` string — A short English description of the Leaderboard (can be displayed to end-users)
    - `score_type` 'number' | 'percent' — Type of values that are captured as scores on the Leaderboard.
    - `sorting_order` 'ascending' | 'descending' — Captures how scores for the Leaderboard progress: ascending means higher score is better, descending means lower score is better.
  - `success` boolean

## Other responses

- `400` — Bad Request. Occurs when the `game-code` parameter is not provided, or is invalid
- `401` — Unauthorized. You get a 401 when the Bearer token is missing, invalid, or belongs to an archived Property.

---

[API](https://skmtc.net/gamezop/apis/astrozop-apis.md) · [All operations](https://skmtc.net/gamezop/apis/astrozop-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gamezop/astrozop-apis/revisions/485db86a5145/schema)