Skip to content

Commit 1e3c173

Browse files
authored
docs: add page for API_GetGameProgression (#83)
1 parent 3bf299a commit 1e3c173

3 files changed

Lines changed: 91 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Click the function names to open their complete docs on the docs site.
5656
- [Achievement IDs](https://api-docs.retroachievements.org/v1/get-achievement-count.html) - Get the list of achievement IDs for a game.
5757
- [Unlocks Distribution](https://api-docs.retroachievements.org/v1/get-achievement-distribution.html) - Get how many players have unlocked how many achievements for a game.
5858
- [High Scores](https://api-docs.retroachievements.org/v1/get-game-rank-and-score.html) - Get a list of either the latest masters or highest hardcore points earners for a game.
59+
- [Progression](https://api-docs.retroachievements.org/v1/get-game-progression.html) - Get information about average time to unlock achievements for a game.
5960

6061
### Leaderboards
6162

docs/.vitepress/config.mts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,10 @@ export default defineConfig({
164164
text: "High Scores",
165165
link: "/v1/get-game-rank-and-score",
166166
},
167+
{
168+
text: "Progression",
169+
link: "/v1/get-game-progression",
170+
},
167171
],
168172
},
169173
{

docs/v1/get-game-progression.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<script setup>
2+
import SampleRequest from '../components/SampleRequest.vue';
3+
</script>
4+
5+
# Game Progression
6+
7+
A call to this endpoint will retrieve information about the average time to unlock achievements in a game, targeted via its unique ID.
8+
9+
[[toc]]
10+
11+
## HTTP Request
12+
13+
<SampleRequest httpVerb="GET">https://retroachievements.org/API/API_GetGameProgression.php?i=228</SampleRequest>
14+
15+
### Query Parameters
16+
17+
| Name | Required? | Description |
18+
| :--- | :-------- | :------------------------------------------------------------------------ |
19+
| `y` | Yes | Your web API key. |
20+
| `i` | Yes | The target game ID. |
21+
| `h` | | 1 to prefer players with more hardcore unlocks than non-hardcore unlocks. |
22+
23+
## Response
24+
25+
::: code-group
26+
27+
```json [HTTP Response]
28+
{
29+
"ID": 228,
30+
"Title": "Super Mario World",
31+
"ConsoleID": 3,
32+
"ConsoleName": "SNES/Super Famicom",
33+
"ImageIcon": "/Images/112443.png",
34+
"NumDistinctPlayers": 79281,
35+
"TimesUsedInBeatMedian": 4493,
36+
"TimesUsedInHardcoreBeatMedian": 8249,
37+
"MedianTimeToBeat": 17878,
38+
"MedianTimeToBeatHardcore": 19224,
39+
"TimesUsedInCompletionMedian": 155,
40+
"TimesUsedInMasteryMedian": 1091,
41+
"MedianTimeToComplete": 67017,
42+
"MedianTimeToMaster": 79744,
43+
"NumAchievements": 89,
44+
"Achievements": [
45+
{
46+
"ID": 342,
47+
"Title": "Giddy Up!",
48+
"Description": "Catch a ride with a friend",
49+
"Points": 1,
50+
"TrueRatio": 1,
51+
"Type": null,
52+
"BadgeName": "46580",
53+
"NumAwarded": 75168,
54+
"NumAwardedHardcore": 37024,
55+
"TimesUsedInUnlockMedian": 63,
56+
"TimesUsedInHardcoreUnlockMedian": 69,
57+
"MedianTimeToUnlock": 274,
58+
"MedianTimeToUnlockHardcore": 323
59+
},
60+
{
61+
"ID": 341,
62+
"Title": "Unleash The Dragon",
63+
"Description": "Collect 5 Dragon Coins in a level",
64+
"Points": 2,
65+
"TrueRatio": 2,
66+
"Type": null,
67+
"BadgeName": "46591",
68+
"NumAwarded": 66647,
69+
"NumAwardedHardcore": 34051,
70+
"TimesUsedInUnlockMedian": 66,
71+
"TimesUsedInHardcoreUnlockMedian": 70,
72+
"MedianTimeToUnlock": 290,
73+
"MedianTimeToUnlockHardcore": 333
74+
}
75+
// ... additional achievements
76+
]
77+
}
78+
```
79+
80+
:::
81+
82+
## Source
83+
84+
| Repo | URL |
85+
| :---- | :------------------------------------------------------------------------------------------- |
86+
| RAWeb | https://github.com/RetroAchievements/RAWeb/blob/master/public/API/API_GetGameProgression.php |

0 commit comments

Comments
 (0)