> For the complete documentation index, see [llms.txt](https://docs.decentraland.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.decentraland.org/apis/apis/exploration-games/progress.md).

# Progress

Player progress tracking and leaderboards

## Get game leaderboard

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

```json
{"openapi":"3.0.3","info":{"title":"Exploration Games API","version":"1.0.0"},"tags":[{"name":"Progress","description":"Player progress tracking and leaderboards"}],"servers":[{"url":"https://exploration-games.decentraland.org","description":"Production server"},{"url":"https://exploration-games.decentraland.zone","description":"Development server"}],"security":[],"paths":{"/api/games/{id}/leaderboard":{"get":{"tags":["Progress"],"summary":"Get game leaderboard","description":"Retrieve leaderboard rankings for a specific game with optional filtering and sorting","operationId":"getProgressLeaderboard","parameters":[{"name":"id","in":"path","description":"Game ID (UUID)","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"level","in":"query","description":"Filter by specific level","required":false,"schema":{"type":"integer","minimum":1}},{"name":"sort","in":"query","description":"Sort field (cannot be 'level')","required":false,"schema":{"type":"string","enum":["score","updated_at","time","moves"],"default":"score"}},{"name":"direction","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"default":"DESC"}},{"name":"limit","in":"query","description":"Number of results to return","required":false,"schema":{"type":"integer","minimum":1,"maximum":10,"default":10}}],"responses":{"200":{"description":"Leaderboard data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"score":{"type":"number","description":"Game score"},"level":{"type":"integer","minimum":1,"description":"Current level achieved"},"time":{"type":"number","description":"Time taken (seconds/milliseconds)"},"moves":{"type":"number","description":"Number of moves made"}}},{"type":"object","properties":{"name":{"type":"string","description":"Game name"},"parcel":{"type":"string","description":"Decentraland parcel coordinates"},"user_address":{"type":"string","description":"User's wallet address"},"data":{"type":"object","description":"Custom game-specific data","additionalProperties":true}},"required":["name","parcel","user_address"]}]}}}}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"message":{"type":"string","description":"Detailed error description"}}}}}}}}}}}
```

## Get user progress in game

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

```json
{"openapi":"3.0.3","info":{"title":"Exploration Games API","version":"1.0.0"},"tags":[{"name":"Progress","description":"Player progress tracking and leaderboards"}],"servers":[{"url":"https://exploration-games.decentraland.org","description":"Production server"},{"url":"https://exploration-games.decentraland.zone","description":"Development server"}],"security":[],"paths":{"/api/games/{id}/progress":{"get":{"tags":["Progress"],"summary":"Get user progress in game","description":"Retrieve the authenticated user's progress history in a specific game","operationId":"getProgressInGame","parameters":[{"name":"id","in":"path","description":"Game ID (UUID)","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"sort","in":"query","description":"Sort field","required":false,"schema":{"type":"string","enum":["score","updated_at","level","time","moves"],"default":"updated_at"}},{"name":"direction","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"default":"DESC"}},{"name":"limit","in":"query","description":"Number of results to return","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":10}}],"responses":{"200":{"description":"User progress data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"score":{"type":"number","description":"Game score"},"level":{"type":"integer","minimum":1,"description":"Current level achieved"},"time":{"type":"number","description":"Time taken (seconds/milliseconds)"},"moves":{"type":"number","description":"Number of moves made"}}},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Progress entry ID"},"game_id":{"type":"string","format":"uuid","description":"Game ID"},"user_address":{"type":"string","description":"User's wallet address"},"user_name":{"type":"string","description":"User's display name"},"data":{"type":"object","description":"Custom game-specific data","additionalProperties":true},"updated_at":{"type":"string","description":"Last update timestamp (ISO 8601)"}},"required":["id","game_id","user_address","user_name","updated_at"]}]}}}}}}},"400":{"description":"Invalid UUID","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"message":{"type":"string","description":"Detailed error description"}}}}}}}}}}}
```

## Submit new progress in game

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

```json
{"openapi":"3.0.3","info":{"title":"Exploration Games API","version":"1.0.0"},"tags":[{"name":"Progress","description":"Player progress tracking and leaderboards"}],"servers":[{"url":"https://exploration-games.decentraland.org","description":"Production server"},{"url":"https://exploration-games.decentraland.zone","description":"Development server"}],"security":[],"paths":{"/api/games/{id}/progress":{"post":{"tags":["Progress"],"summary":"Submit new progress in game","description":"Submit new game progress for the authenticated user. Automatically checks for challenge completion and mission completion.","operationId":"newProgressInGame","parameters":[{"name":"id","in":"path","description":"Game ID (UUID)","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"score":{"type":"number","description":"Game score"},"level":{"type":"integer","minimum":1,"description":"Current level achieved"},"time":{"type":"number","description":"Time taken (seconds/milliseconds)"},"moves":{"type":"number","description":"Number of moves made"}}},{"type":"object","properties":{"user_name":{"type":"string","description":"User's display name"},"data":{"type":"object","description":"Custom game-specific data","additionalProperties":true}},"required":["user_name","level"]}]}}}},"responses":{"201":{"description":"Progress submitted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"score":{"type":"number","description":"Game score"},"level":{"type":"integer","minimum":1,"description":"Current level achieved"},"time":{"type":"number","description":"Time taken (seconds/milliseconds)"},"moves":{"type":"number","description":"Number of moves made"}}},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Progress entry ID"},"game_id":{"type":"string","format":"uuid","description":"Game ID"},"user_address":{"type":"string","description":"User's wallet address"},"user_name":{"type":"string","description":"User's display name"},"data":{"type":"object","description":"Custom game-specific data","additionalProperties":true},"updated_at":{"type":"string","description":"Last update timestamp (ISO 8601)"}},"required":["id","game_id","user_address","user_name","updated_at"]}]}}}}}},"400":{"description":"Invalid request payload or UUID","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"message":{"type":"string","description":"Detailed error description"}}}}}}}}}}}
```

## Get all progress in game

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

```json
{"openapi":"3.0.3","info":{"title":"Exploration Games API","version":"1.0.0"},"tags":[{"name":"Progress","description":"Player progress tracking and leaderboards"}],"servers":[{"url":"https://exploration-games.decentraland.org","description":"Production server"},{"url":"https://exploration-games.decentraland.zone","description":"Development server"}],"security":[],"paths":{"/api/games/{id}/progress/all":{"get":{"tags":["Progress"],"summary":"Get all progress in game","description":"Retrieve all user progress entries for a specific game with pagination (Admin only)","operationId":"getAllProgressInGame","parameters":[{"name":"id","in":"path","description":"Game ID (UUID)","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"level","in":"query","description":"Filter by specific level","required":false,"schema":{"type":"integer","minimum":1}},{"name":"sort","in":"query","description":"Sort field","required":false,"schema":{"type":"string","enum":["score","updated_at","level","time","moves"],"default":"updated_at"}},{"name":"direction","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","enum":["ASC","DESC"],"default":"DESC"}},{"name":"limit","in":"query","description":"Number of results per page","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":10}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":1}}],"responses":{"200":{"description":"All progress data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"score":{"type":"number","description":"Game score"},"level":{"type":"integer","minimum":1,"description":"Current level achieved"},"time":{"type":"number","description":"Time taken (seconds/milliseconds)"},"moves":{"type":"number","description":"Number of moves made"}}},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Progress entry ID"},"game_id":{"type":"string","format":"uuid","description":"Game ID"},"user_address":{"type":"string","description":"User's wallet address"},"user_name":{"type":"string","description":"User's display name"},"data":{"type":"object","description":"Custom game-specific data","additionalProperties":true},"updated_at":{"type":"string","description":"Last update timestamp (ISO 8601)"}},"required":["id","game_id","user_address","user_name","updated_at"]}]}}}}}}},"400":{"description":"Invalid UUID","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"message":{"type":"string","description":"Detailed error description"}}}}}}}}}}}
```

## Get all user progress

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

```json
{"openapi":"3.0.3","info":{"title":"Exploration Games API","version":"1.0.0"},"tags":[{"name":"Progress","description":"Player progress tracking and leaderboards"}],"servers":[{"url":"https://exploration-games.decentraland.org","description":"Production server"},{"url":"https://exploration-games.decentraland.zone","description":"Development server"}],"security":[],"paths":{"/api/games/progress":{"get":{"tags":["Progress"],"summary":"Get all user progress","description":"Retrieve all games being played by the authenticated user with their latest progress","operationId":"getAllUserProgressInGames","responses":{"200":{"description":"List of games played by user","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"score":{"type":"number","description":"Game score"},"level":{"type":"integer","minimum":1,"description":"Current level achieved"},"time":{"type":"number","description":"Time taken (seconds/milliseconds)"},"moves":{"type":"number","description":"Number of moves made"}}},{"type":"object","properties":{"name":{"type":"string","description":"Game name"},"parcel":{"type":"string","description":"Decentraland parcel coordinates"},"data":{"type":"object","description":"Custom game-specific data","additionalProperties":true}},"required":["name","parcel"]}]}}}}}}}}}}}}
```

## Set progress status

> Enable or disable specific progress entries (Admin only)

```json
{"openapi":"3.0.3","info":{"title":"Exploration Games API","version":"1.0.0"},"tags":[{"name":"Progress","description":"Player progress tracking and leaderboards"}],"servers":[{"url":"https://exploration-games.decentraland.org","description":"Production server"},{"url":"https://exploration-games.decentraland.zone","description":"Development server"}],"security":[],"paths":{"/api/games/progress/status":{"patch":{"tags":["Progress"],"summary":"Set progress status","description":"Enable or disable specific progress entries (Admin only)","operationId":"setProgressStatus","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","description":"Array of progress entry IDs","items":{"type":"string","format":"uuid"}},"disabled":{"type":"boolean","description":"Whether to disable (true) or enable (false) the progress entries"}},"required":["ids","disabled"]}}}},"responses":{"200":{"description":"Progress status updated","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","description":"Updated progress entries"}}}}}}},"400":{"description":"Invalid request payload","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"message":{"type":"string","description":"Detailed error description"}}}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.decentraland.org/apis/apis/exploration-games/progress.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
