Skip to content

Commit 241e495

Browse files
authored
docs: add ULID notes to API_GetUserProfile (#74)
1 parent e3471e1 commit 241e495

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/v1/get-user-profile.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,13 @@ This information can be found near the top of [any user page](https://retroachie
2020

2121
### Query Parameters
2222

23-
| Name | Required? | Description |
24-
| :--- | :-------- | :------------------- |
25-
| `y` | Yes | Your web API key. |
26-
| `u` | Yes | The target username. |
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. |
29+
| `i` | | The target user's ULID. |
2730

2831
## Client Library
2932

@@ -74,6 +77,7 @@ if (response is NetworkResponse.Success) {
7477
```json [HTTP Response]
7578
{
7679
"User": "MaxMilyin",
80+
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
7781
"UserPic": "/UserPic/MaxMilyin.png",
7882
"MemberSince": "2016-01-02 00:43:04",
7983
"RichPresenceMsg": "Playing ~Hack~ 11th Annual Vanilla Level Design Contest, The",
@@ -94,6 +98,7 @@ if (response is NetworkResponse.Success) {
9498
```json [NodeJS]
9599
{
96100
"user": "MaxMilyin",
101+
"ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
97102
"userPic": "/UserPic/MaxMilyin.png",
98103
"memberSince": "2016-01-02 00:43:04",
99104
"richPresenceMsg": "Playing ~Hack~ 11th Annual Vanilla Level Design Contest, The",

0 commit comments

Comments
 (0)