RetroAchievements.Raw

This class exposes the RetroAchievements’ raw API for any advanced use cases.

Note

This API wraps the RetroAchievements’ official API endpoints. You should refer to it for details on each API call and arguments.

Note

Almost all requests require you to supply an authentication Dictionary, which can be obtained through RetroAchievements.build_auth.

Methods

Type

Name

Raw.Response

get_achievement_of_the_week

Raw.Response

get_claims

Raw.Response

get_active_claims

Raw.Response

get_top_ten_users

Raw.Response

get_user_recent_achievements

Raw.Response

get_achievements_earned_between

Raw.Response

get_achievements_earned_on_day

Raw.Response

get_game_info_and_user_progress

Raw.Response

get_user_awards

Raw.Response

get_user_claims

Raw.Response

get_user_completed_games

Raw.Response

get_user_game_rank_and_score

Raw.Response

get_user_points

Raw.Response

get_user_progress

Raw.Response

get_user_recently_played_games

Raw.Response

get_user_summary

Raw.Response

get_achievement_count

Raw.Response

get_achievement_distribution

Raw.Response

get_game

Raw.Response

get_game_extended

Raw.Response

get_game_rank_and_score

Raw.Response

get_console_ids

Raw.Response

get_game_list

Raw.Response

get_achievement_unlocks

Raw.Response get_achievement_of_the_week (Dictionary auth)

API_GetAchievementOfTheWeek.php

Raw.Response get_claims (Dictionary auth, String kind)

API_GetClaims.php

Raw.Response get_active_claims (Dictionary auth)

API_GetActiveClaims.php

Raw.Response get_top_ten_users (Dictionary auth)

API_GetTopTenUsers.php

Raw.Response get_user_recent_achievements (Dictionary auth, String username, int recent_minutes = 60)

API_GetUserRecentAchievements.php

Raw.Response get_achievements_earned_between (Dictionary auth, String username, int from_date, int to_date)

API_GetAchievementsEarnedBetween.php

Raw.Response get_achievements_earned_on_day (Dictionary auth, String username, String on_date)

API_GetAchievementsEarnedOnDay.php

Raw.Response get_game_info_and_user_progress (Dictionary auth, String username, int game_id)

API_GetGameInfoAndUserProgress.php

Raw.Response get_user_awards (Dictionary auth, String username)

API_GetUserAwards.php

Raw.Response get_user_claims (Dictionary auth, String username)

API_GetUserClaims.php

Raw.Response get_user_completed_games (Dictionary auth, String username)

API_GetUserCompletedGames.php

Raw.Response get_user_game_rank_and_score (Dictionary auth, String username, int game_id)

API_GetUserGameRankAndScore.php

Raw.Response get_user_points (Dictionary auth, String username)

API_GetUserPoints.php

Raw.Response get_user_progress (Dictionary auth, String username, Array [ int ] game_ids)

API_GetUserProgress.php

Raw.Response get_user_recently_played_games (Dictionary auth, String username, int count = 10, int offset = 0)

API_GetUserRecentlyPlayedGames.php

Raw.Response get_user_summary (Dictionary auth, String username, int recent_games_count = 0, int recent_achievements_count = 5)

API_GetUserSummary.php

Raw.Response get_achievement_count (Dictionary auth, int game_id)

API_GetAchievementCount.php

Raw.Response get_achievement_distribution (Dictionary auth, int game_id)

API_GetAchievementDistribution.php

Raw.Response get_game (Dictionary auth, int game_id)

API_GetGame.php

Raw.Response get_game_extended (Dictionary auth, int game_id)

API_GetGameExtended.php

Raw.Response get_game_rank_and_score (Dictionary auth, int game_id, String type)

API_GetGameRankAndScore.php

Raw.Response get_console_ids (Dictionary auth)

API_GetConsoleIDs.php

Raw.Response get_game_list (Dictionary auth, int console_id, bool should_only_retrieve_games_with_achievements = false, bool should_retrieve_game_hashes = false)

API_GetGameList.php

Raw.Response get_achievement_unlocks (Dictionary auth, int achievement_id, int count = 50, int offset = 0)

API_GetAchievementUnlocks.php