Skip to content

Supported Game Files

A call to this endpoint will retrieve the hashes linked to a game, targeted via its unique ID.

On-site Representation

This data can be found on the Supported Game Files page, for example, Sonic the Hedgehog:

Game Hashes

HTTP Request

GET

https://retroachievements.org/API/API_GetGameHashes.php?i=1

Query Parameters

NameRequired?Description
yYesYour web API key.
iYesThe target game ID.

Client Library

Kotlin
val credentials = RetroCredentials("<username>", "<web api key>")
val api: RetroInterface = RetroClient(credentials).api

val response: NetworkResponse<GetGameHashes.Response, ErrorResponse> = api.getGameHashes(
    gameId = 14402
)

if (response is NetworkResponse.Success) {
    // handle the data
    val gameHashes: GetGameHashes.Response = response.body

} else if (response is NetworkResponse.Error) {
    // if the server returns an error it be found here
    val errorResponse: ErrorResponse? = response.body

    // if the api (locally) had an internal error, it'll be found here
    val internalError: Throwable? = response.error
}

Response

json
{
  "Results": [
    {
      "MD5": "1b1d9ac862c387367e904036114c4825",
      "Name": "Sonic The Hedgehog (USA, Europe) (Ru) (NewGame).md",
      "Labels": ["nointro", "rapatches"],
      "PatchUrl": "https://github.com/RetroAchievements/RAPatches/raw/main/MD/Translation/Russian/1-Sonic1-Russian.zip"
    },
    {
      "MD5": "1bc674be034e43c96b86487ac69d9293",
      "Name": "Sonic The Hedgehog (USA, Europe).md",
      "Labels": ["nointro"],
      "PatchUrl": null
    }
  ]
}

Source

RepoURL
RAWebhttps://github.com/RetroAchievements/RAWeb/blob/master/public/API/API_GetGameHashes.php
api-kotlinhttps://github.com/RetroAchievements/api-kotlin/blob/main/src/main/kotlin/org/retroachivements/api/RetroInterface.kt

Released under the MIT license.