RetroAchievements API Demo (PHP)
This page will visually demonstrate some of the functionality of the RetroAchievements PHP API. Click
here to download the necessary PHP file you will need
to add to your server. Once added, you will be able to create a RetroAchievements
object and call functions on it, as demonstrated below. Note all highlighted code refers to a line of code in PHP.
Please note, this is a beta offering and only supports read-only access to data that can already be found on the site. No personal/user
data can be accessed using this API beyond what is already publically accessible for every user (username, avatar, motto and activity).
Index:
- Initialize RetroAchievements object
- General
- Game
- GetGameList( consoleID )
- GetGameInfo( gameID )
- GetGameInfoExtended( gameID )
- GetGameInfoAndUserProgress( user, gameID )
- User
- GetUserRankAndScore( user )
- GetUserRecentlyPlayedGames( user, numGames )
- GetUserProgress( user, gamesCSV )
- GetUserSummary( user, numRecentGames )
- GetFeedFor( user, numRecentActivities )
- Achievement
Initialize Connection to RetroAchievements:
First, you must take a copy of the RA_API.php file, store it on your server, and in the file you wish to use, create an instance of the RetroAchievements object. This only needs to be done once per pageload.
require_once( "RA_API.php" );$RAConn = new RetroAchievements('TestUser' '' );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0005s...
Get Top Ten Users by Points:
Next, simply call one of the available functions to use it. Here we fetch the top 10 users on the global leaderboards:
$data = $RAConn->GetTopTenUsers();And here is the contents of that call. Note you are free to interpret this data, I am simply dumping it here so you can see what's in this object:
Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0075s...Get Console IDs:
$data = $RAConn->GetConsoleIDs();Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0053s...
Get List of all Registered Original Gameboy Games (Console ID 4):
$data = $RAConn->GetGameList( 4 );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0057s...Basic game information for Super Mario Land (GB) (Game ID 504):
$data = $RAConn->GetGameInfo( 504 );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0058s...Full game information for Super Mario Land (GB) (Game ID 504):
$data = $RAConn->GetGameInfoExtended( 504 );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0057s...Complete summary of Scott's progress in game ID 3:
$data = $RAConn->GetGameInfoAndUserProgress( 'Scott', 3 );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0060s...Scott's global rank and score:
$data = $RAConn->GetUserRankAndScore( 'Scott' );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0060s...Scott's 10 most recently played games:
$data = $RAConn->GetUserRecentlyPlayedGames( 'Scott' );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0054s...Scott's progress on games with IDs 2, 3 and 75:
$data = $RAConn->GetUserProgress( 'Scott', '2, 3, 75' );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0058s...User summary of Scott, and 3 most recently played games:
$data = $RAConn->GetUserSummary( 'Scott', 3 );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0055s...Get Achievements Earned by Scott on January 4th 2014:
$data = $RAConn->GetAchievementsEarnedOnDay( 'Scott', '2014-01-04' );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0048s...Get Achievements Earned by Scott overnight on New Years Eve:
$data = $RAConn->GetAchievementsEarnedBetween( 'Scott', '2013-12-31 20:00:00', '2014-01-01 04:00:00' );Back to topPROFILE - https://retroachievements.org:443/APIDemo.php - took 0.0051s...