string
The API supports both JSON and XML responses. However, we strongly suggest only using JSON when requesting resources.
int
Avatars
Valid values are:
int
The God ID is an unique id for each playable character in a game.
Can be obtained from:
GetChampions
- Returns a list of all playable characters in Paladins.GetGods
- Returns a list of all playable characters in Paladins & Smite.
int
Champions are the playable characters in Paladins.
Each one has their own unique abilities and fighting style. Champions use Cards to increase their performance and enhance their skills, and Items to help them adapt to specific situations in every match.
Champions
Champions are organized into 4 different classes:
- Damage: These champions can consistently deal high amounts of damage. Damage champions gain 100% more [Credits][credits] for dealing damage to enemy champions.
- Flank: These champions excel in both damage and mobility to help them in combat as well as chase and confirm kills from the enemy's rear. However, their low health makes them vulnerable to getting overwhelmed by multiple enemies. Flank champions gain 30% more [Credits][credits] from landing killing blows on enemies.
- Front Line: These champions are the best at maintaining control of objectives and protecting their teammates through shields, personal force fields, or just by taking fire. Front Line champions gain 100% more [Credits][credits] for standing near an objective.
- Support: These champions offer a wide range of utility, both offensive and defensive. However, they specialize in healing and causing chaos in enemy attacks. Support champions gain 100% more [Credits][credits] for healing allies, and eliminations from healing a target that gets the killing blow on an enemy. Support champions also gain ultimate charge from healing done to teammates besides themselves. Healing that restores 0 Health (for example, healing someone who is at full health) won't provide ultimate charge.
There are currently 57 playable champions in the game (Updated in 11/08/2022 05:17:32):
int
There are multiple Classes in Realm Royale.
Each one has its own unique abilities and fighting style. Each class has a unique passive bonus, movement ability, and 4 special abilities.
Additionally each class can craft a unique weapon at the forge.
Classes
There are currently 4 playable classes in the game:
ID | Name | In-Game Name | Image |
---|---|---|---|
2285 | Male Tank | Warrior | |
2493 | Female Damage | Hunter | |
2494 | Female Support | Mage | |
2496 | Male Flank | Assassin |
int
Gods are the playable characters in Smite.
Each god is unique, with different strengths and weaknesses, and their own playstyle. The statistics of certain gods are geared for offense, while others are better suited for defense.
Gods
Gods are organized in 5 different classes:
- Assassins (mostly melee junglers and gankers).
- Guardians (mostly melee supports, tanks and initiators).
- Hunters (mostly ranged carries and fighters).
- Mages (mostly ranged spellcasters).
- Warriors (mostly melee bruisers).
There are currently 123 playable gods in the game (Updated in 11/08/2022 05:18:26):
string
A DateTime in the following format: yyyyMMdd
- “20191210” (for Dec 10, 2019, as an example)
string
Valid values: 0 - 23. An hour parameter of -1 represents the entire day, but be warned that this may be more data than we can return for certain queues.
To avoid HTTP timeouts in the GetMatchIdsByQueue method, you can now specify a 10-minute window within the specified {hour} field to lessen the size of data returned by appending a “,mm” value to the end of {hour}. For example, to get the match Ids for the first 10 minutes of hour 3, you would specify {hour} as “3,00”. This would only return the Ids between the time 3:00 to 3:09. Rules below:
- Only valid values for mm are “00”, “10”, “20”, “30”, “40”, “50”
- To get the entire third hour worth of Match Ids, call GetMatchIdsByQueue 6 times, specifying the following values for {hour}: “3,00”, “3,10”, “3,20”, “3,30”, “3,40”, “3,50”.
- The standard, full hour format of {hour} = “hh” is still supported.
int
The queue_id is an unique id for each playable game mode in a game (last updated 2019-12-10).
int
Game Modes
ID | Name | Description | Image |
---|---|---|---|
423 | Custom Siege - Stone Keep | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
424 | LIVE Siege | Siege is a round based game mode where each team works to earn Objective Points to win the match, the first team to achieve 4 Objective Points wins. Players can change their Cards loadout at the start of the match. These points are earned by taking control of a Capture Point, escorting the Payload into the enemy team's base and Stalling the enemy team's Payload until the time runs out. |
|
425 | LIVE Siege Pratice | This version of Siege is Co-op vs AI. | |
426 | Custom Siege - Bazaar | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
428 | LIVE Competitive Gamepad | This version of Ranked is reserved for consoles players. | |
430 | Custom Siege - Timber Mill | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
431 | Custom Siege - Fish Market | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
432 | Custom Siege - Frozen Guard | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
433 | Custom Siege - Frog Isle | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
434 | Shooting Range | The Shooting Range, a special map designed to test out champions. | |
438 | Custom Siege - Jaguar Falls | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
439 | Custom Siege - Ice Mines | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
440 | Custom Siege - Serpent Beach | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
444 | Basic Tutorial | The Basic Tutorial explains the controls of Paladins to the player. | |
445 | LIVE Test Maps | This version of Siege allows players to test maps that are still in early development and can give feedback. | |
452 | LIVE Onslaught - King of the Hill | Onslaught is a queue, that features a classic King of the Hill gameplay and a variant thereof. To win, players must earn tickets by either killing players or controlling a Capture Point. The first team to reach 400 tickets, or the team with the most tickets until time runs out, wins. |
|
453 | LIVE Onslaught Pratice | This version of Onslaught is Co-op vs AI. | |
454 | Custom Onslaught - Snowfall Junction | This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
455 | Custom Onslaught - Primal Court | This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
458 | Custom Siege - Brightmarsh | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
459 | Custom Siege - Splitstone Quarry | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
462 | Custom Onslaught - Foreman's Rise | This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
464 | Custom Onslaught - Magistrate's Archives | This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
468 | Custom Team Deathmatch - Trade District | This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
469 | LIVE Team Deathmatch | Team Deathmatch is a classic deathmatch game mode, the first team to achieve 40 kills wins. | |
470 | LIVE Team Deathmatch Pratice | This version of Team Deathmatch is Co-op vs AI. | |
471 | Custom Team Deathmatch - Foreman's Rise | This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
472 | Custom Team Deathmatch - Magistrate's Archives | This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
473 | Custom Siege - Ascension Peak | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
479 | Custom Team Deathmatch - Abyss | This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
480 | Custom Team Deathmatch - Throne | This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
483 | Custom Onslaught - Marauders Port | This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
484 | Custom Team Deathmatch - Dragon Arena | This version of Custom Team Deathmatch allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
485 | Custom Siege - Warders Gate | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
486 | LIVE Competitive KBM | Ranked is a system in Paladins designed to provide higher quality matches for competitive players. The current Season of competitive play is 3. | |
487 | Custom Siege - Shattered Desert | This version of Custom Siege allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
10200 | Custom King of the Hill - Magistrate's Archives | This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
10201 | Custom King of the Hill - Snowfall Junction | This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
10202 | Custom King of the Hill - Marauders Port | This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. | |
10203 | Custom King of the Hill - Trade District | This version of Custom Onslaught allows players to open up own matches - with own game settings. But no game progress can be achieved in these matches. |
int
Game Modes
ID | Name | Description |
---|---|---|
474 | LIVE Solo | A mode where you fly solo. No teammates, just you and your gun against 99 other solos. |
475 | LIVE Duo | A mode where teams of two play to the end with 49 other duos. |
476 | LIVE Quad | A mode where teams of four battle it out against 24 other squads. |
477 | Live Wars | |
478 | Live Tutorial | |
479 | Live Solo Mid Level | |
480 | Live Solo Low Level | |
481 | Live Squad Mid Level | |
482 | Live Squad Low Level | |
483 | Live Duo Mid Level | |
484 | Live Duo Low Level | |
10188 | Custom Game Solo | |
10189 | Custom Game Duo | |
10190 | Custom Game Quad | |
10205 | Custom Game Trio |
int
The language Id that you want results returned in. Default is 1.
Languages
Valid values are:
ID | Language | Name | Flag | |
---|---|---|---|---|
1 | English | en_US | 🇺🇸 | |
2 | German | Deutsch | de_DE | 🇩🇪 |
3 | French | Français | fr_FR | 🇫🇷 |
5 | Chinese | zh_CN | 🇨🇳 | |
7 | Spanish | es_ES | 🇪🇸 | |
9 | Spanish (Latin America) | Español | es_LA | 🇦🇷 |
10 | Portuguese | Português do Brasil | pt_BR | 🇧🇷 |
11 | Russian | Русский | ru_RU | 🇷🇺 |
12 | Polish | Polski | pl_PL | 🇵🇱 |
13 | Turkish | Türkçe | tr_TR | 🇹🇷 |
int: The id of a match.
The Match ID is an unique id for each map that’s created by the server for a set of players.
The “match_id” can be obtained from:
GetMatchHistory
GetMatchIdsByQueue
GetPlayerMatchHistory
GetPlayerMatchHistoryAfterDateTime
GetPlayerStatus
GetPlayerMatchHistoryAfterDateTime
GetTopMatches
.
This may either be:
string
This is the Player Name.
int
The Player ID is an unique id for each player that's is created and internally stored by Hi-Rez.
The “player_id” can be obtained from:
GetPlayer
Get Champion Leaderboard
Get Friends
Get God Leaderboard
Get Leaderboard
Get League Leaderboard
Get Match Details
Get Player Batch From Match
Get Player Id By Name
Get Player Id By Portal User Id
Get Player Id Info For Xbox And Switch
Get Player Ids By Gamer Tag
Get Team Players
Search players
The (usually) 3rd-Party identifier for a Portal. Examples: Steam ID, PS4 GamerTag, Xbox GamerTag, Switch GamerTag.
int
This is the Player Steam ID.
string
Typically an alphanumeric descriptor of an individual on a Portal. This value might not be unique depending on Portal.
int
A “Portal” is a gateway into our games via an identifier. In the past it would have been synonymous with a hardware platform... but because of gateways such as “Steam” it is more than just a hardware platform.
Represents Platform as follows:
ID | Platform | Image |
---|---|---|
1 | Hi-Rez | |
5 | Steam | |
9 | Play Station | |
10 | Xbox | |
14 | Mixer | |
22 | Nintendo Switch | |
25 | Discord | |
28 | Epic Games |
int
The season of a league. Starts at 1 and increases by 1 for each calendar year.
- Paladins: As of 2019-12-09 we are currently on season 3.
- Smite: As of 2019-12-09 we are currently on season 6.
int
Tiers
Valid values are:
int
Represents Player Status as follows:
ID | Type | Description |
---|---|---|
0 | Offline | |
1 | In Lobby | Basically anywhere except god selection or in game. |
2 | God Selection | Player has accepted match and is selecting god before start of game. |
3 | In Game | Match has started. |
4 | Online | Player is logged in, but may be blocking broadcast of player state. |
5 | Unknown | Player not found. |
string
The Signature is created by concatenating several fields and then hashing the result with an MD5 algorithm.
A distinct signature is required for each API method called.
The components of this hash are (in order):
Name | Description | Example |
---|---|---|
dev_id | “1004” | |
method | Which “method” means the resource you want to retrieve data This will not include the Response Type, just the name of the method. |
“createsession” |
auth_key | “23DF3C7E9BD14D84BF892AD206B6755C” | |
timestamp | Current UTC Timestamp | “20191128030916” |
C# Sample
private static string generate_signature(int dev_id, string method, string auth_key, string timestamp) {
using (var md5 = System.Security.Cryptography.MD5.Create()) {
var bytes = md5.ComputeHash(System.Text.Encoding.UTF8.GetBytes(dev_id + method + auth_key.ToLower() + timestamp));
var string_builder = new System.Text.StringBuilder();
foreach (byte b in bytes)
string_builder.Append(b.ToString("x2").ToLower());
return string_builder.ToString();
}
}
var signature = generate_signature(1004, "createsession", "23DF3C7E9BD14D84BF892AD206B6755C", get_timestamp());
Java Sample
private static String generate_signature(int dev_id, String auth_key, String method, String timestamp) {
String template_signature = dev_id + method + auth_key + timestamp;
StringBuilder string_builder = new StringBuilder();
try {
MessageDigest md = MessageDigest.getInstance("MD5");
md.update (template_signature.getBytes());
byte [] bytes = md.digest();
for (byte b : bytes) {
String hex = Integer.toHexString(0xff & b);
if (hex.length () == 1)
string_builder.append("0");
string_builder.append(hex);
}
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
}
return string_builder.toString();
}
public final String signature = generate_signature(1004, "createsession", "23DF3C7E9BD14D84BF892AD206B6755C", get_timestamp());
Javascript Sample
const md5 = require("md5");
function generate_signature(dev_id, method, auth_key, timestamp) {
return md5(`${dev_id}${method}${auth_key}${timestamp}`);
}
var signature = generate_signature(1004, "createsession", "23DF3C7E9BD14D84BF892AD206B6755C", get_timestamp());
PHP Sample
private function generate_signature($dev_id, $method, $auth_key, $timestamp) {
return md5($dev_id . $method . $auth_key . $timestamp);
}
Python Sample
from hashlib import md5
def generate_signature(dev_id, method, auth_key, timestamp):
return md5(f'{dev_id}{method.lower()}{auth_key}{timestamp}'.encode('utf-8')).hexdigest()
signature = generate_signature(1004, 'createsession', '23DF3C7E9BD14D84BF892AD206B6755C', get_timestamp())
string
Current UTC time (GMT+0) in the following format: “yyyyMMddHHmmss
”.
Timestamps are used by Signatures and embedded into URLs when sending requests, they have to be formatted properly to ensure the request completes without error.
C# Sample
public static string get_timestamp(string _format="yyyyMMddHHmmss") {
return System.DateTime.UtcNow.ToString(_format);
}
var timestamp = get_timestamp();
Java Sample
private static String get_timestamp() {
SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddHHmmss");
sdf.setTimeZone(new SimpleTimeZone(SimpleTimeZone.UTC_TIME, "UTC"));
return sdf.format(new Date());
}
public final String timestamp = get_timestamp();
Javascript Sample
const moment = require("moment");
function get_timestamp() {
return moment.utc().format("yyyyMMddHHmmss");
}
var timestamp = get_timestamp();
PHP Sample
private function get_timestamp() {
return Carbon::now()->format('Ymdhis');
}
Python Sample
from datetime import datetime
def get_timestamp(_format='%Y%m%d%H%M%S'):
return datetime.utcnow().strftime(_format)
timestamp = get_timestamp()