Easily retrieve achievement, user, and game data from RetroAchievements.

Documentation: Get Started

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.
• GetUserClaims - Get a list of set claims made over the lifetime of a user.
• GetUserGameRankAndScore - Get metadata about how a user has performed on a given game.
• GetUserPoints - Get a user's total hardcore and softcore points.
• GetUserProgress - Get a user's progress on a list of specified games.
• GetUserRecentlyPlayedGames - Get a list of games a user has recently played.
• GetUserSummary - Get a user's profile metadata.
• Completed Games - Legacy endpoint. Get hardcore and softcore completion metadata about games a user has played.

• Summary - Get basic metadata about a game.
• Extended Details - Get extended metadata about 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.

• GetAchievementUnlocks - Get a list of users who have earned an achievement.

• 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.

• GetActiveClaims - Get all active set claims on the site.
• GetClaims - Get all claims of other kinds on the site.
• GetTopTenUsers - 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

TODO

Let us know about yours by opening an issue!