View Source API Reference srex v0.1.0

Modules

Documentation for an unofficial speedrun.com REST API client.

Categories are the different rulesets for speedruns. Categories are either per-game or per-level (if the game uses individual levels), both can be accessed via this resource.

Developers are the persons and/of studios responsible for developing games, for example Acclaim Entertainment, Bethesda Softworks, Edmund McMillen etc.

Most resources are related to others in some form. A run is related to the category it is done in, as well as the users that have executed it.

Engines are software frameworks used in the creation of games, for example the DOOM engine, Unreal Engine, Geo-Mod etc.

Games are the things users do speedruns in. Games are associated with regions (US, Europe, ...), platforms (consoles, handhelds, ...), genres, engines, developers, game types, publishers, categories, levels and custom variables (like speed=50/100/150cc in Mario Kart games).

Game types are classifications for unofficial games, for example ROM Hack, Fangame, Modification etc.

Genres are classifications for games, for example Action, JRPG, Rogue-like etc.

Sometimes, speedrun.com has runs done by players that have no account on the site yet. These runners are called "guests" in the API. Except for a name, there is nothing we know about them.

Leaderboards contain non-obsolete runs, sorted by time descending. In contrast to raw runs, leaderboards are automatically grouped according to the game/category/level rules that the moderators have defined.

Levels are the stages/worlds/maps within a game. Not all games have levels.

Notifications are system-generated messages sent to users when certain events concerning them happen on the site, like somebody liking a post or a run being verified.

Platforms are hardware devices that run games, for example PC, NES, PS2 etc.

The profile is the user resource of the currently authenticated user. This is useful to see what user a given API key belongs to.

Publishers are companies that publish games, for example Capcom, SEGA, Midway Games etc.

Regions represent the different distribution zones in which games are published, for example the US, Europe or Japan.

Runs are the meat of our business at speedrun.com. A run is a finished attempt to play a game, adhering to that game's ruleset. Invalid attempts (use of cheats etc) or obsolete runs (the ones superseded by a better time by the same player(s) in the same ruleset) still count as runs and are available via API.

Series are collections of games that have been released in context to each other, for example the "GTA" series contains all the games of this franchise. As a series is most often formed after a number of games have been published, many games do not belong to a specific series and are therefore categorized in the "Other" series. As time progresses, games can be moved in their own series, so be prepared for the series-game relationship to change.

Users are the individuals who have registered an account on speedrun.com. Users submit (their) runs and moderate games, besides other things that are not covered by this API (like writing posts in the forums).

Variables are custom criteria to distinguish between runs done in the same category or level. The speed in Mario Kart games (which can be 50cc, 100cc or 150cc) is an example for a variable that has 3 possible values.