From ddf7fc559ae29a37b686c26e861ae1f52f72d845 Mon Sep 17 00:00:00 2001 From: iOSLife Date: Sat, 3 Aug 2024 19:41:13 -0400 Subject: [PATCH 1/4] Remove 'z' from Query Parameters sections --- docs/v1/get-achievement-count.md | 1 - docs/v1/get-achievement-distribution.md | 1 - docs/v1/get-achievement-of-the-week.md | 1 - docs/v1/get-achievement-unlocks.md | 1 - docs/v1/get-achievements-earned-between.md | 1 - docs/v1/get-achievements-earned-on-day.md | 1 - docs/v1/get-active-claims.md | 1 - docs/v1/get-claims.md | 1 - docs/v1/get-game.md | 1 - docs/v1/get-recent-game-awards.md | 1 - docs/v1/get-ticket-data/get-achievement-ticket-stats.md | 1 - docs/v1/get-ticket-data/get-developer-ticket-stats.md | 1 - docs/v1/get-ticket-data/get-game-ticket-stats.md | 1 - docs/v1/get-ticket-data/get-most-recent-tickets.md | 1 - docs/v1/get-ticket-data/get-most-ticketed-games.md | 1 - docs/v1/get-ticket-data/get-ticket-by-id.md | 1 - docs/v1/get-top-ten-users.md | 1 - docs/v1/get-user-awards.md | 1 - docs/v1/get-user-claims.md | 1 - docs/v1/get-user-completed-games.md | 1 - docs/v1/get-user-completion-progress.md | 1 - docs/v1/get-user-game-rank-and-score.md | 1 - docs/v1/get-user-points.md | 1 - docs/v1/get-user-profile.md | 1 - docs/v1/get-user-progress.md | 1 - docs/v1/get-user-recent-achievements.md | 1 - docs/v1/get-user-recently-played-games.md | 1 - docs/v1/get-user-summary.md | 1 - 28 files changed, 28 deletions(-) diff --git a/docs/v1/get-achievement-count.md b/docs/v1/get-achievement-count.md index cbd205f..8db5f11 100644 --- a/docs/v1/get-achievement-count.md +++ b/docs/v1/get-achievement-count.md @@ -22,7 +22,6 @@ When browsing a game page, for example, [Sonic the Hedgehog](https://retroachiev | Name | Required? | Description | | :--- | :-------- | :------------------ | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `i` | Yes | The target game ID. | diff --git a/docs/v1/get-achievement-distribution.md b/docs/v1/get-achievement-distribution.md index f134bc1..66805e6 100644 --- a/docs/v1/get-achievement-distribution.md +++ b/docs/v1/get-achievement-distribution.md @@ -22,7 +22,6 @@ When browsing a game page, for example, [Sonic the Hedgehog](https://retroachiev | Name | Required? | Description | | :--- | :-------- | :------------------------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `i` | Yes | The target game ID. | | `h` | | 1 to only query hardcore unlocks. 0 to query all unlocks. Defaults to 0. | diff --git a/docs/v1/get-achievement-of-the-week.md b/docs/v1/get-achievement-of-the-week.md index 8e2445c..3f1b563 100644 --- a/docs/v1/get-achievement-of-the-week.md +++ b/docs/v1/get-achievement-of-the-week.md @@ -22,7 +22,6 @@ The current Achievement of the Week can be found on the site's home page: | Name | Required? | Description | | :--- | :-------- | :---------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | ## Client Library diff --git a/docs/v1/get-achievement-unlocks.md b/docs/v1/get-achievement-unlocks.md index 5b83b2d..9a76817 100644 --- a/docs/v1/get-achievement-unlocks.md +++ b/docs/v1/get-achievement-unlocks.md @@ -16,7 +16,6 @@ A call to this endpoint will retrieve a list of users who have earned an achieve | Name | Required? | Description | | :--- | :-------- | :---------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `a` | Yes | The target achievement ID. | | `c` | | Count, number of records to return (default: 50, max: 500). | diff --git a/docs/v1/get-achievements-earned-between.md b/docs/v1/get-achievements-earned-between.md index dec80ad..e7e8945 100644 --- a/docs/v1/get-achievements-earned-between.md +++ b/docs/v1/get-achievements-earned-between.md @@ -22,7 +22,6 @@ A user's unlocks by a date range can be found manually via the user history: | Name | Required? | Description | | :--- | :-------- | :--------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | | `f` | Yes | Epoch timestamp. Time range start. | diff --git a/docs/v1/get-achievements-earned-on-day.md b/docs/v1/get-achievements-earned-on-day.md index 271108a..97816f7 100644 --- a/docs/v1/get-achievements-earned-on-day.md +++ b/docs/v1/get-achievements-earned-on-day.md @@ -22,7 +22,6 @@ A user's unlocks by date can be found via the user history: | Name | Required? | Description | | :--- | :-------- | :------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | | `d` | Yes | Date in YYYY-MM-DD format. | diff --git a/docs/v1/get-active-claims.md b/docs/v1/get-active-claims.md index 5926501..52e990d 100644 --- a/docs/v1/get-active-claims.md +++ b/docs/v1/get-active-claims.md @@ -16,7 +16,6 @@ A call to this endpoint returns information about all (1000 max) active set clai | Name | Required? | Description | | :--- | :-------- | :---------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | ## Client Library diff --git a/docs/v1/get-claims.md b/docs/v1/get-claims.md index 86699ab..98d3ed9 100644 --- a/docs/v1/get-claims.md +++ b/docs/v1/get-claims.md @@ -16,7 +16,6 @@ A call to this endpoint returns information about all (1000 max) achievement set | Name | Required? | Description | | :--- | :-------- | :--------------------------------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `k` | | The desired claim kind: 1 (completed), 2 (dropped), or 3 (expired). Defaults to 1. | diff --git a/docs/v1/get-game.md b/docs/v1/get-game.md index 25df3e3..e866b85 100644 --- a/docs/v1/get-game.md +++ b/docs/v1/get-game.md @@ -22,7 +22,6 @@ Most of this data can be found on the game page, for example, [Sonic the Hedgeho | Name | Required? | Description | | :--- | :-------- | :------------------ | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `i` | Yes | The target game ID. | diff --git a/docs/v1/get-recent-game-awards.md b/docs/v1/get-recent-game-awards.md index 0309790..24e2e64 100644 --- a/docs/v1/get-recent-game-awards.md +++ b/docs/v1/get-recent-game-awards.md @@ -22,7 +22,6 @@ This data can be found on the Recent Game Awards page, for example: | Name | Required? | Description | | :--- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `d` | | Starting date (YYYY-MM-DD) (default: now). | | `o` | | Offset, number of entries to skip (default: 0). | diff --git a/docs/v1/get-ticket-data/get-achievement-ticket-stats.md b/docs/v1/get-ticket-data/get-achievement-ticket-stats.md index 591d380..e8fece0 100644 --- a/docs/v1/get-ticket-data/get-achievement-ticket-stats.md +++ b/docs/v1/get-ticket-data/get-achievement-ticket-stats.md @@ -16,7 +16,6 @@ A call to `API_GetTicketData` in this manner will retrieve ticket stats for an a | Name | Required? | Description | | :--- | :-------- | :--------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `a` | Yes | The target achievement ID to fetch ticket stats for. | diff --git a/docs/v1/get-ticket-data/get-developer-ticket-stats.md b/docs/v1/get-ticket-data/get-developer-ticket-stats.md index f20162a..a1a1376 100644 --- a/docs/v1/get-ticket-data/get-developer-ticket-stats.md +++ b/docs/v1/get-ticket-data/get-developer-ticket-stats.md @@ -16,7 +16,6 @@ A call to `API_GetTicketData` in this manner will retrieve ticket stats for a de | Name | Required? | Description | | :--- | :-------- | :------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target developer's username. | diff --git a/docs/v1/get-ticket-data/get-game-ticket-stats.md b/docs/v1/get-ticket-data/get-game-ticket-stats.md index bbeea36..1e1d783 100644 --- a/docs/v1/get-ticket-data/get-game-ticket-stats.md +++ b/docs/v1/get-ticket-data/get-game-ticket-stats.md @@ -16,7 +16,6 @@ A call to `API_GetTicketData` in this manner will retrieve ticket stats for a ga | Name | Required? | Description | | :--- | :-------- | :--------------------------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `g` | Yes | The target game ID. | | `f` | | Set to 5 if you want ticket data for unofficial achievements. | diff --git a/docs/v1/get-ticket-data/get-most-recent-tickets.md b/docs/v1/get-ticket-data/get-most-recent-tickets.md index a7127a5..1c96cf1 100644 --- a/docs/v1/get-ticket-data/get-most-recent-tickets.md +++ b/docs/v1/get-ticket-data/get-most-recent-tickets.md @@ -16,7 +16,6 @@ A call to `API_GetTicketData` in this manner will retrieve ticket metadata infor | Name | Required? | Description | | :--- | :-------- | :---------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `c` | | Count, number of records to return (default: 10, max: 100). | | `o` | | Offset, number of entries to skip (default: 0). | diff --git a/docs/v1/get-ticket-data/get-most-ticketed-games.md b/docs/v1/get-ticket-data/get-most-ticketed-games.md index b2f4705..22fc98f 100644 --- a/docs/v1/get-ticket-data/get-most-ticketed-games.md +++ b/docs/v1/get-ticket-data/get-most-ticketed-games.md @@ -16,7 +16,6 @@ A call to `API_GetTicketData` in this manner will retrieve the games on the site | Name | Required? | Description | | :--- | :-------- | :---------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `f` | Yes | Must be set to 1. | | `c` | | Count, number of records to return (default: 10, max: 100). | diff --git a/docs/v1/get-ticket-data/get-ticket-by-id.md b/docs/v1/get-ticket-data/get-ticket-by-id.md index c5eb501..52ad251 100644 --- a/docs/v1/get-ticket-data/get-ticket-by-id.md +++ b/docs/v1/get-ticket-data/get-ticket-by-id.md @@ -16,7 +16,6 @@ A call to `API_GetTicketData` in this manner will retrieve ticket metadata infor | Name | Required? | Description | | :--- | :-------- | :-------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `i` | Yes | The target ticket ID. | diff --git a/docs/v1/get-top-ten-users.md b/docs/v1/get-top-ten-users.md index 831a3de..26d9180 100644 --- a/docs/v1/get-top-ten-users.md +++ b/docs/v1/get-top-ten-users.md @@ -16,7 +16,6 @@ A call to this endpoint will retrieve the current top ten users, ranked by hardc | Name | Required? | Description | | :--- | :-------- | :---------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | ## Client Library diff --git a/docs/v1/get-user-awards.md b/docs/v1/get-user-awards.md index 9a877b4..a60f25e 100644 --- a/docs/v1/get-user-awards.md +++ b/docs/v1/get-user-awards.md @@ -22,7 +22,6 @@ The easiest place to see a summary of user awards in the Progression Status comp | Name | Required? | Description | | :--- | :-------- | :------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | diff --git a/docs/v1/get-user-claims.md b/docs/v1/get-user-claims.md index 6b8de38..7d862d5 100644 --- a/docs/v1/get-user-claims.md +++ b/docs/v1/get-user-claims.md @@ -16,7 +16,6 @@ A call to this endpoint will retrieve a list of achievement set claims made over | Name | Required? | Description | | :--- | :-------- | :------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | diff --git a/docs/v1/get-user-completed-games.md b/docs/v1/get-user-completed-games.md index 8fc5468..fe4cb7e 100644 --- a/docs/v1/get-user-completed-games.md +++ b/docs/v1/get-user-completed-games.md @@ -22,7 +22,6 @@ A call to this endpoint will retrieve completion metadata about the games a give | Name | Required? | Description | | :--- | :-------- | :------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | diff --git a/docs/v1/get-user-completion-progress.md b/docs/v1/get-user-completion-progress.md index e96cb44..5e8385d 100644 --- a/docs/v1/get-user-completion-progress.md +++ b/docs/v1/get-user-completion-progress.md @@ -22,7 +22,6 @@ A user's completion progress can be found in several places, most prolifically o | Name | Required? | Description | | :--- | :-------- | :----------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | | `c` | | Count, number of records to return (default: 100, max: 500). | diff --git a/docs/v1/get-user-game-rank-and-score.md b/docs/v1/get-user-game-rank-and-score.md index f235950..4561a17 100644 --- a/docs/v1/get-user-game-rank-and-score.md +++ b/docs/v1/get-user-game-rank-and-score.md @@ -16,7 +16,6 @@ A call to this endpoint will retrieve metadata about how a given user has perfor | Name | Required? | Description | | :--- | :-------- | :------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | | `g` | Yes | The target game ID. | diff --git a/docs/v1/get-user-points.md b/docs/v1/get-user-points.md index bf2141b..ab34cd5 100644 --- a/docs/v1/get-user-points.md +++ b/docs/v1/get-user-points.md @@ -16,7 +16,6 @@ A call to this endpoint will retrieve a given user's hardcore and softcore point | Name | Required? | Description | | :--- | :-------- | :------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | diff --git a/docs/v1/get-user-profile.md b/docs/v1/get-user-profile.md index ebca9a6..eaac218 100644 --- a/docs/v1/get-user-profile.md +++ b/docs/v1/get-user-profile.md @@ -22,7 +22,6 @@ This information can be found near the top of [any user page](https://retroachie | Name | Required? | Description | | :--- | :-------- | :------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | diff --git a/docs/v1/get-user-progress.md b/docs/v1/get-user-progress.md index 72d069a..5e1082e 100644 --- a/docs/v1/get-user-progress.md +++ b/docs/v1/get-user-progress.md @@ -22,7 +22,6 @@ Unless you are explicitly wanting summary progress details for specific game IDs | Name | Required? | Description | | :--- | :-------- | :----------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | | `i` | Yes | The target game IDs, as a comma-separated value. | diff --git a/docs/v1/get-user-recent-achievements.md b/docs/v1/get-user-recent-achievements.md index c4e60dd..1837161 100644 --- a/docs/v1/get-user-recent-achievements.md +++ b/docs/v1/get-user-recent-achievements.md @@ -26,7 +26,6 @@ The recent unlocks can also be found on the "Unlocked Achievements" page: | Name | Required? | Description | | :--- | :-------- | :------------------------------------ | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | | `m` | | Minutes to look back. Defaults to 60. | diff --git a/docs/v1/get-user-recently-played-games.md b/docs/v1/get-user-recently-played-games.md index 5b19863..61bbdf5 100644 --- a/docs/v1/get-user-recently-played-games.md +++ b/docs/v1/get-user-recently-played-games.md @@ -16,7 +16,6 @@ A call to this endpoint will retrieve a list of a target user's recently played | Name | Required? | Description | | :--- | :-------- | :--------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | | `c` | | Count, number of records to return (default: 10, max: 50). | diff --git a/docs/v1/get-user-summary.md b/docs/v1/get-user-summary.md index 35c8057..e2af9e4 100644 --- a/docs/v1/get-user-summary.md +++ b/docs/v1/get-user-summary.md @@ -22,7 +22,6 @@ This endpoint is known to be slow, and often results in over-fetching. For basic | Name | Required? | Description | | :--- | :-------- | :-------------------------------------------------------- | -| `z` | Yes | Your username. | | `y` | Yes | Your web API key. | | `u` | Yes | The target username. | | `g` | | The number of recent games to return (default: 0). | From 78b3d9195d42fcd946b158aa51abe1827b75d2af Mon Sep 17 00:00:00 2001 From: iOSLife Date: Sat, 3 Aug 2024 19:45:07 -0400 Subject: [PATCH 2/4] Remove username details from quick start section --- docs/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 42e07e0..a9c9f43 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -19,10 +19,10 @@ Store your API key as though it is a secret, like a password. Avoid checking in ## Quick Start (HTTP Requests) -With your username and web API key, you now have all you need to call any endpoint in the API. +With web API key, you now have all you need to call any endpoint in the API. ```bash -curl https://retroachievements.org/API/API_GetTopTenUsers.php?z=[your_username]&y=[your_key] +curl https://retroachievements.org/API/API_GetTopTenUsers.php?&y=[your_key] ``` ## Quick Start (Client Library) From 67220a6fcba50abf179d5ed2f2b4cdaaf8555dc5 Mon Sep 17 00:00:00 2001 From: iOSLife Date: Sat, 3 Aug 2024 19:45:26 -0400 Subject: [PATCH 3/4] Remove username from welcome doc --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 82a5530..31cdac5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -40,10 +40,10 @@ If your individual rate limit is not enough for your use case, then please reach ### Using your key -Provide your username to the `z` query param and your API key to the `y` query param. +Provide your API key to the `y` query param. ``` -https://retroachievements.org/API/API_GetAchievementOfTheWeek.php?z=[your_username]&y=[your_key] +https://retroachievements.org/API/API_GetAchievementOfTheWeek.php?&y=[your_key] ``` ## Client Libraries From 0ca7376b681bec7332658c37e47f20155c601955 Mon Sep 17 00:00:00 2001 From: iOSLife Date: Tue, 6 Aug 2024 14:39:02 +0000 Subject: [PATCH 4/4] Update docs/getting-started.md Co-authored-by: Wes Copeland --- docs/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index a9c9f43..8973c61 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -19,7 +19,7 @@ Store your API key as though it is a secret, like a password. Avoid checking in ## Quick Start (HTTP Requests) -With web API key, you now have all you need to call any endpoint in the API. +With your web API key, you now have all you need to call any endpoint in the API. ```bash curl https://retroachievements.org/API/API_GetTopTenUsers.php?&y=[your_key]