Easily retrieve achievement, user, and game data from RetroAchievements.
Learn how to authenticate and start pulling data from RetroAchievements on our documentation website.
- Get started
- Get a user's profile information
- Look up games a user has completed
- Get a game's metadata
Click the function names to open their complete docs on the docs site.
- Profile - Get a user's basic profile information.
- Unlocks (most recent) - Get a list of achievements recently earned by the user.
- Unlocks (by date range) - Get a list of achievements earned by a user between two dates.
- Unlocks (on date) - Get a list of achievements earned by a user on a given date.
- Game Progress - Get metadata about a game as well as a user's progress on that game.
- All Completion Progress - Get metadata about all the user's played games and any awards associated with them.
- Awards / Badges - Get a list of a user's site awards/badges.
- Set Development Claims - Get a list of set development claims made over the lifetime of a user.
- Game Rank and Score - Get metadata about how a user has performed on a given game.
- Point Totals - Get a user's total hardcore and softcore points.
- Specific Games Progress - Get a user's progress on a list of specified games.
- Recently Played Games - Get a list of games a user has recently played.
- Summary - Get a user's profile metadata.
- Completed Games - Legacy endpoint. Get hardcore and softcore completion metadata about games a user has played.
- Want to Play Games List - Get a user's list of Want to Play Games.
- Users I Follow - Get the caller's list of followed users.
- Users Following Me - Get the caller's list of followers users.
- User Set Requests - Get a user's list of set requests.
- Summary - Get basic metadata about a game.
- Extended Details - Get extended metadata about a game.
- Hashes - Get Supported Game Files for a game.
- Achievement IDs - Get the list of achievement IDs for a game.
- Unlocks Distribution - Get how many players have unlocked how many achievements for a game.
- High Scores - Get a list of either the latest masters or highest hardcore points earners for a game.
- Leaderboards (by gameID) - Get a given games's list of leaderboards.
- Entries - Get a given leadboard's entries.
- User Game Leaderboards - Get a given user's leaderboard entries for a game.
- Get All Systems - Get the complete list of system ID and name pairs on the site.
- Get All Games and Hashes - Get the complete list of games for a console, including their hashes.
- All Unlocks - Get a list of users who have earned an achievement, targeted by achievement ID.
- Comments - Get comments of a specified kind: game, achievement, or user.
- All Recent Game Awards - Retrieve all recent game awards granted to players.
- Active Claims - Retrieve active achievement set development claims.
- Inactive Claims - Retrieve achievement set development claims that have been completed, dropped, or are expired.
- Top Ten Ranked Users - Get the list of top ten points earners.
- Achievement of the Week - Get comprehensive metadata about the current Achievement of the Week.
- Get Ticket by ID
- Get Most Ticketed Games
- Get Most Recent Tickets
- Get Game Ticket Stats
- Get Developer Ticket Stats
- Get Achievement Ticket Stats
First, fork this repository and clone your fork. Then, in a terminal, cd into the repo directory on your local machine.
pnpm installpnpm devYou can now open your local docs site in your browser. By default, this can done by visiting http://localhost:5173/.
Put your work on a branch and push it to your fork. When you are ready to contribute to this repository, open a PR with your branch targeting this repo's main.
Let us know about yours by opening an issue!
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
