Progress

Player progress tracking and leaderboards

Get game leaderboard

get

https://exploration-games.decentraland.orghttps://exploration-games.decentraland.zone

/api/games/{id}/leaderboard

Retrieve leaderboard rankings for a specific game with optional filtering and sorting

Path parameters

idstring · uuidRequired

Game ID (UUID)

Query parameters

levelinteger · min: 1Optional

Filter by specific level

sortstring · enumOptional

Sort field (cannot be 'level')

Default: scorePossible values:

directionstring · enumOptional

Sort direction

Default: DESCPossible values:

limitinteger · min: 1 · max: 10Optional

Number of results to return

Default: 10

Responses

200

Leaderboard data

application/json

400

Invalid parameters

application/json

get

/api/games/{id}/leaderboard

HTTPcURLJavaScriptPython

GET /api/games/{id}/leaderboard HTTP/1.1
Host: exploration-games.decentraland.org
Accept: */*

{
  "data": [
    {
      "score": 1500,
      "level": 5,
      "time": 120.5,
      "moves": 45,
      "name": "Puzzle Master",
      "parcel": "10,20",
      "user_address": "0x1234567890123456789012345678901234567890",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Get user progress in game

get

https://exploration-games.decentraland.orghttps://exploration-games.decentraland.zone

/api/games/{id}/progress

Retrieve the authenticated user's progress history in a specific game

Path parameters

idstring · uuidRequired

Game ID (UUID)

Query parameters

sortstring · enumOptional

Sort field

Default: updated_atPossible values:

directionstring · enumOptional

Sort direction

Default: DESCPossible values:

limitinteger · min: 1 · max: 500Optional

Number of results to return

Default: 10

Responses

200

User progress data

application/json

400

Invalid UUID

application/json

get

/api/games/{id}/progress

HTTPcURLJavaScriptPython

GET /api/games/{id}/progress HTTP/1.1
Host: exploration-games.decentraland.org
Accept: */*

{
  "data": [
    {
      "score": 1500,
      "level": 5,
      "time": 120.5,
      "moves": 45,
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "game_id": "550e8400-e29b-41d4-a716-446655440000",
      "user_address": "0x1234567890123456789012345678901234567890",
      "user_name": "Player123",
      "data": {
        "powerUpsUsed": 3,
        "enemiesDefeated": 10
      },
      "updated_at": "2024-10-30T12:34:56.789Z"
    }
  ]
}

Submit new progress in game

post

https://exploration-games.decentraland.orghttps://exploration-games.decentraland.zone

/api/games/{id}/progress

Submit new game progress for the authenticated user. Automatically checks for challenge completion and mission completion.

Path parameters

idstring · uuidRequired

Game ID (UUID)

Body

application/json

scorenumberOptional

Game score

Example: 1500

levelinteger · min: 1Required

Current level achieved

Example: 5

timenumberOptional

Time taken (seconds/milliseconds)

Example: 120.5

movesnumberOptional

Number of moves made

Example: 45

user_namestringRequired

User's display name

Example: Player123

Responses

201

Progress submitted successfully

application/json

400

Invalid request payload or UUID

application/json

post

/api/games/{id}/progress

HTTPcURLJavaScriptPython

POST /api/games/{id}/progress HTTP/1.1
Host: exploration-games.decentraland.org
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "score": 1500,
  "level": 5,
  "time": 120.5,
  "moves": 45,
  "user_name": "Player123",
  "data": {
    "powerUpsUsed": 3
  }
}

{
  "data": {
    "score": 1500,
    "level": 5,
    "time": 120.5,
    "moves": 45,
    "id": "550e8400-e29b-41d4-a716-446655440004",
    "game_id": "550e8400-e29b-41d4-a716-446655440000",
    "user_address": "0x1234567890123456789012345678901234567890",
    "user_name": "Player123",
    "data": {
      "powerUpsUsed": 3,
      "enemiesDefeated": 10
    },
    "updated_at": "2024-10-30T12:34:56.789Z"
  }
}

Get all progress in game

get

https://exploration-games.decentraland.orghttps://exploration-games.decentraland.zone

/api/games/{id}/progress/all

Retrieve all user progress entries for a specific game with pagination (Admin only)

Path parameters

idstring · uuidRequired

Game ID (UUID)

Query parameters

levelinteger · min: 1Optional

Filter by specific level

sortstring · enumOptional

Sort field

Default: updated_atPossible values:

directionstring · enumOptional

Sort direction

Default: DESCPossible values:

limitinteger · min: 1 · max: 1000Optional

Number of results per page

Default: 10

pageinteger · min: 1 · max: 1000Optional

Page number

Default: 1

Responses

200

All progress data

application/json

400

Invalid UUID

application/json

get

/api/games/{id}/progress/all

HTTPcURLJavaScriptPython

GET /api/games/{id}/progress/all HTTP/1.1
Host: exploration-games.decentraland.org
Accept: */*

{
  "data": [
    {
      "score": 1500,
      "level": 5,
      "time": 120.5,
      "moves": 45,
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "game_id": "550e8400-e29b-41d4-a716-446655440000",
      "user_address": "0x1234567890123456789012345678901234567890",
      "user_name": "Player123",
      "data": {
        "powerUpsUsed": 3,
        "enemiesDefeated": 10
      },
      "updated_at": "2024-10-30T12:34:56.789Z"
    }
  ]
}

Get all user progress

get

https://exploration-games.decentraland.orghttps://exploration-games.decentraland.zone

/api/games/progress

Retrieve all games being played by the authenticated user with their latest progress

Responses

200

List of games played by user

application/json

get

/api/games/progress

HTTPcURLJavaScriptPython

GET /api/games/progress HTTP/1.1
Host: exploration-games.decentraland.org
Accept: */*

200

List of games played by user

{
  "data": [
    {
      "score": 1500,
      "level": 5,
      "time": 120.5,
      "moves": 45,
      "name": "Puzzle Master",
      "parcel": "10,20",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Set progress status

patch

https://exploration-games.decentraland.orghttps://exploration-games.decentraland.zone

/api/games/progress/status

Enable or disable specific progress entries (Admin only)

Body

application/json

idsstring · uuid[]Required

Array of progress entry IDs

Example: ["550e8400-e29b-41d4-a716-446655440004"]

disabledbooleanRequired

Whether to disable (true) or enable (false) the progress entries

Example: false

Responses

200

Progress status updated

application/json

dataobject[]Optional

Updated progress entries

400

Invalid request payload

application/json

patch

/api/games/progress/status

HTTPcURLJavaScriptPython

PATCH /api/games/progress/status HTTP/1.1
Host: exploration-games.decentraland.org
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "ids": [
    "550e8400-e29b-41d4-a716-446655440004"
  ],
  "disabled": false
}

{
  "data": [
    {}
  ]
}