Skip to content

docs: add ULID notes to API_GetUserProfile #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wescopeland merged 1 commit into from
Feb 6, 2025
Merged

docs: add ULID notes to API_GetUserProfile #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/v1/get-user-profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@ This information can be found near the top of [any user page](https://retroachie

### Query Parameters

| Name | Required? | Description |
| :--- | :-------- | :------------------- |
| `y` | Yes | Your web API key. |
| `u` | Yes | The target username. |
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.

| Name | Required? | Description |
| :--- | :-------- | :---------------------- |
| `y` | Yes | Your web API key. |
| `u` | | The target username. |
| `i` | | The target user's ULID. |

## Client Library

Expand Down Expand Up @@ -74,6 +77,7 @@ if (response is NetworkResponse.Success) {
```json [HTTP Response]
{
"User": "MaxMilyin",
"ULID": "00003EMFWR7XB8SDPEHB3K56ZQ",
"UserPic": "/UserPic/MaxMilyin.png",
"MemberSince": "2016-01-02 00:43:04",
"RichPresenceMsg": "Playing ~Hack~ 11th Annual Vanilla Level Design Contest, The",
Expand All @@ -94,6 +98,7 @@ if (response is NetworkResponse.Success) {
```json [NodeJS]
{
"user": "MaxMilyin",
"ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
"userPic": "/UserPic/MaxMilyin.png",
"memberSince": "2016-01-02 00:43:04",
"richPresenceMsg": "Playing ~Hack~ 11th Annual Vanilla Level Design Contest, The",
Expand Down