Skip to content

RetroAchievements/api-docs

Repository files navigation

RetroAchievements Logo

RetroAchievements API

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

Documentation: Get Started


Documentation

Learn how to authenticate and start pulling data from RetroAchievements on our documentation website.

API

Click the function names to open their complete docs on the docs site.

User

Game

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

System

Achievement

  • All Unlocks - Get a list of users who have earned an achievement, targeted by achievement ID.

Comment

  • Comments - Get comments of a specified kind: game, achievement, or user.

Feed

Event

Ticket

How to Contribute

First, fork this repository and clone your fork. Then, in a terminal, cd into the repo directory on your local machine.

Installation

pnpm install

Dev Server

pnpm dev

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

Projects Using the RetroAchievements API

Let us know about yours by opening an issue!