Skip to content

Commit e2a9dc8

Browse files
wescopelandwescopeland
authored
docs: add ULID notes for every applicable endpoint (#76)
1 parent 10b9921 commit e2a9dc8

32 files changed

+133
-45
lines changed

‎docs/v1/get-achievement-of-the-week.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ if (response is NetworkResponse.Success) {
7979
"TrueRatio": 11,
8080
"Type": null,
8181
"Author": "StingX2",
82+
"AuthorULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
8283
"DateCreated": "2021-10-16",
8384
"DateModified": "2021-10-17"
8485
},
@@ -98,6 +99,7 @@ if (response is NetworkResponse.Success) {
9899
"Unlocks": [
99100
{
100101
"User": "Agnam",
102+
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
101103
"RAPoints": 56120,
102104
"RASoftcorePoints": 1267,
103105
"DateAwarded": "2023-10-26T22:13:34.000000Z",
@@ -119,6 +121,7 @@ if (response is NetworkResponse.Success) {
119121
"points": "10",
120122
"trueRatio": "22",
121123
"author": "BigWeedSmokerMan",
124+
"authorUlid": "00003EMFWR7XB8SDPEHB3K56ZQ",
122125
"dateCreated": "2021-08-08 17:47:46",
123126
"dateModified": "2021-08-09 12:20:05"
124127
},
@@ -130,6 +133,7 @@ if (response is NetworkResponse.Success) {
130133
"unlocks": [
131134
{
132135
"user": "Tirbaba2",
136+
"ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
133137
"rAPoints": "72",
134138
"rASoftcorePoints": "150",
135139
"dateAwarded": "2022-10-10 01:42:19",

‎docs/v1/get-achievement-unlocks.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ if (response is NetworkResponse.Success) {
7979
"Points": 4,
8080
"TrueRatio": 4,
8181
"Author": "Scott",
82+
"AuthorULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
8283
"DateCreated": "2012-11-02 00:03:12",
8384
"DateModified": "2023-08-08 00:36:59",
8485
"Type": "progression"
@@ -97,6 +98,7 @@ if (response is NetworkResponse.Success) {
9798
"Unlocks": [
9899
{
99100
"User": "vipotaenko02",
101+
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
100102
"RAPoints": 0,
101103
"RASoftcorePoints": 0,
102104
"DateAwarded": "2023-10-27T00:19:05.000000Z",
@@ -116,6 +118,7 @@ if (response is NetworkResponse.Success) {
116118
"points": 4,
117119
"trueRatio": 4,
118120
"author": "Scott",
121+
"authorUlid": "00003EMFWR7XB8SDPEHB3K56ZQ",
119122
"dateCreated": "2012-11-02 00:03:12",
120123
"dateModified": "2023-08-08 00:36:59",
121124
"type": "progression"
@@ -128,6 +131,7 @@ if (response is NetworkResponse.Success) {
128131
"unlocks": [
129132
{
130133
"user": "vipotaenko02",
134+
"ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
131135
"raPoints": 0,
132136
"raSoftcorePoints": 0,
133137
"dateAwarded": "2023-10-27T00:19:05.000000Z",

‎docs/v1/get-achievements-earned-between.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ A user's unlocks by a date range can be found manually via the user history:
2020

2121
### Query Parameters
2222

23+
You must query the user by either their username or their ULID. Please note the username is not considered a stable value. As of 2025, users can change their usernames. Initially querying by username is a good way to fetch a ULID.
24+
2325
| Name | Required? | Description |
2426
| :--- | :-------- | :--------------------------------- |
2527
| `y` | Yes | Your web API key. |
26-
| `u` | Yes | The target username. |
28+
| `u` | | The target username or ULID. |
2729
| `f` | Yes | Epoch timestamp. Time range start. |
2830
| `t` | Yes | Epoch timestamp. Time range end. |
2931

@@ -98,6 +100,7 @@ if (response is NetworkResponse.Success) {
98100
"TrueRatio": 25,
99101
"Type": "missable",
100102
"Author": "Altomar",
103+
"AuthorULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
101104
"GameTitle": "Persona 3 Portable",
102105
"GameIcon": "/Images/065205.png",
103106
"GameID": 3164,
@@ -123,6 +126,7 @@ if (response is NetworkResponse.Success) {
123126
"trueRatio": 25,
124127
"type": null,
125128
"author": "pinguupinguu",
129+
"authorUlid": "00003EMFWR7XB8SDPEHB3K56ZQ",
126130
"gameTitle": "SpongeBob SquarePants: The Movie",
127131
"gameIcon": "/Images/059007.png",
128132
"gameId": 19018,

‎docs/v1/get-achievements-earned-on-day.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,13 @@ A user's unlocks by date can be found via the user history:
2020

2121
### Query Parameters
2222

23-
| Name | Required? | Description |
24-
| :--- | :-------- | :------------------------- |
25-
| `y` | Yes | Your web API key. |
26-
| `u` | Yes | The target username. |
27-
| `d` | Yes | Date in YYYY-MM-DD format. |
23+
You must query the user by either their username or their ULID. Please note the username is not considered a stable value. As of 2025, users can change their usernames. Initially querying by username is a good way to fetch a ULID.
24+
25+
| Name | Required? | Description |
26+
| :--- | :-------- | :--------------------------- |
27+
| `y` | Yes | Your web API key. |
28+
| `u` | | The target username or ULID. |
29+
| `d` | Yes | Date in YYYY-MM-DD format. |
2830

2931
## Client Library
3032

@@ -93,6 +95,7 @@ if (response is NetworkResponse.Success) {
9395
"Points": 5,
9496
"Type": null,
9597
"Author": "TheMysticalOne",
98+
"AuthorULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
9699
"GameTitle": "Dragon Quest VIII: Journey of the Cursed King",
97100
"GameIcon": "/Images/038649.png",
98101
"GameID": 2721,
@@ -117,6 +120,7 @@ if (response is NetworkResponse.Success) {
117120
"points": 5,
118121
"type": null,
119122
"author": "pinguupinguu",
123+
"authorUlid": "00003EMFWR7XB8SDPEHB3K56ZQ",
120124
"gameTitle": "SpongeBob SquarePants: The Movie",
121125
"gameIcon": "/Images/059007.png",
122126
"gameId": 19018,

‎docs/v1/get-active-claims.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ if (response is NetworkResponse.Success) {
6565
{
6666
"ID": 11246,
6767
"User": "WanderingHeiho",
68+
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
6869
"GameID": 26971,
6970
"GameTitle": "~Homebrew~ No Place To Hide",
7071
"GameIcon": "/Images/084916.png",
@@ -90,6 +91,7 @@ if (response is NetworkResponse.Success) {
9091
{
9192
"id": 11246,
9293
"user": "WanderingHeiho",
94+
"ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
9395
"gameId": 26971,
9496
"gameTitle": "~Homebrew~ No Place To Hide",
9597
"gameIcon": "/Images/084916.png",

‎docs/v1/get-claims.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ if (response is NetworkResponse.Success) {
6868
{
6969
"ID": 11245,
7070
"User": "kmpers",
71+
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
7172
"GameID": 24541,
7273
"GameTitle": "GP World",
7374
"GameIcon": "/Images/076324.png",
@@ -93,6 +94,7 @@ if (response is NetworkResponse.Success) {
9394
{
9495
"id": 11245,
9596
"user": "kmpers",
97+
"ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
9698
"gameId": 24541,
9799
"gameTitle": "GP World",
98100
"gameIcon": "/Images/076324.png",

‎docs/v1/get-comments.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ A call to this endpoint returns comments of a specified kind: game, achievement,
1414

1515
### Query Parameters
1616

17-
| Name | Required? | Description |
18-
| :--- | :-------- | :------------------------------------------------------------------------------------------- |
19-
| `y` | Yes | Your web API key. |
20-
| `i` | Yes | The target game or achievement ID (if type is 1 or 2). The target username (if type is 3). |
21-
| `t` | Sometimes | The target comment kind: 1 (game), 2 (achievement), or 3 (user). Required if type is 1 or 2. |
22-
| `c` | | Count, number of records to return (default: 100, max: 500). |
23-
| `o` | | Offset, number of entries to skip (default: 0). |
17+
| Name | Required? | Description |
18+
| :--- | :-------- | :------------------------------------------------------------------------------------------------------ |
19+
| `y` | Yes | Your web API key. |
20+
| `i` | Yes | The target game or achievement ID (if type is 1 or 2). The target username or user ULID (if type is 3). |
21+
| `t` | Sometimes | The target comment kind: 1 (game), 2 (achievement), or 3 (user). Required if type is 1 or 2. |
22+
| `c` | | Count, number of records to return (default: 100, max: 500). |
23+
| `o` | | Offset, number of entries to skip (default: 0). |
2424

2525
## Client Library
2626

@@ -102,6 +102,7 @@ if (response is NetworkResponse.Success) {
102102
"Results": [
103103
{
104104
"User": "PlayTester",
105+
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
105106
"Submitted": "2024-07-31T11:22:23.000000Z",
106107
"CommentText": "Comment 1"
107108
},

‎docs/v1/get-game-extended.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ if (response is NetworkResponse.Success) {
106106
"Points": 3,
107107
"TrueRatio": 3,
108108
"Author": "Scott",
109+
"AuthorULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
109110
"DateModified": "2023-08-08 00:36:59",
110111
"DateCreated": "2012-11-02 00:03:12",
111112
"BadgeName": "250336",
@@ -154,6 +155,7 @@ if (response is NetworkResponse.Success) {
154155
"points": 1,
155156
"trueRatio": 1,
156157
"author": "Boldewin",
158+
"authorUlid": "00003EMFWR7XB8SDPEHB3K56ZQ",
157159
"dateModified": "2019-08-01 19:03:46",
158160
"dateCreated": "2019-07-31 18:49:57",
159161
"badgeName": "85541",

‎docs/v1/get-game-info-and-user-progress.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,12 @@ A call to this endpoint will retrieve extended metadata about a game, in additio
1414

1515
### Query Parameters
1616

17+
You must query the user by either their username or their ULID. Please note the username is not considered a stable value. As of 2025, users can change their usernames. Initially querying by username is a good way to fetch a ULID.
18+
1719
| Name | Required? | Description |
1820
| :--- | :-------- | :----------------------------------------------------------------- |
1921
| `y` | Yes | Your web API key. |
20-
| `u` | Yes | The target username. |
22+
| `u` | | The target username or ULID. |
2123
| `g` | Yes | The target game ID. |
2224
| `a` | | Set to "1" if user award metadata should be included (default: 0). |
2325

@@ -108,6 +110,7 @@ if (response is NetworkResponse.Success) {
108110
"Points": 3,
109111
"TrueRatio": 3,
110112
"Author": "Scott",
113+
"AuthorULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
111114
"DateModified": "2023-08-08 00:36:59",
112115
"DateCreated": "2012-11-02 00:03:12",
113116
"BadgeName": "250336",
@@ -162,6 +165,7 @@ if (response is NetworkResponse.Success) {
162165
"points": 1,
163166
"trueRatio": 1,
164167
"author": "Boldewin",
168+
"authorUlid": "00003EMFWR7XB8SDPEHB3K56ZQ",
165169
"dateModified": "2019-08-01 19:03:46",
166170
"dateCreated": "2019-07-31 18:49:57",
167171
"badgeName": "85541",

‎docs/v1/get-game-leaderboards.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ if (response is NetworkResponse.Success) {
7171
"Format": "VALUE",
7272
"TopEntry": {
7373
"User": "vani11a",
74+
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
7475
"Score": "390490",
7576
"FormattedScore": "390,490"
7677
}

0 commit comments

Comments
 (0)