Skip to content

Methods & parameters

Jump to bottom Edit New page
Luís Gustavo edited this page Jul 4, 2018 · 112 revisions

Calling API Methods

BaseURLEndpoint/MethodPattern[ResponseFormat]/Params
The url format for calling a method from the api

Name Description Example
BaseURLEndpoint The Endpoint that you want to use http://api.realmroyale.com/realmapi.svc
MethodPattern The pattern for the method above, where [ResponseFormat] is replaced by the formatting that you want returned (either JSON or XML). /CreateSessionJSON
Params The method params /{devID}/{signature}/{timestamp}
URI example: http://api.realmroyale.com/realmapi.svc/CreateSessionJSON/{devID}/{signature}/{timestamp}

Connectivity

Create Session

/CreateSession[ResponseFormat]/{devID}/{signature}/{timestamp}
A required step to Authenticate the developerId/signature for further API use.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "CreateSession" method de9a8114c56e02abd057a0f2d9671b7d
timestamp The current Timestamp 20180628012612

The Session is contained in an element called “session_id”. This parameter is needed to call the other methods.



Requesting JSON: http://api.realmroyale.com/realmapi.svc/CreateSessionJSON/1004/de9a8114c56e02abd057a0f2d9671b7d/20180628012612

Response: JSON

{
	"ret_msg": "Approved",
	"session_id": "1465AFCA32DBDB800CEF8C72F296C52C",
	"timestamp": "6/28/2018 1:26:12 AM"
}

Requesting XML: http://api.realmroyale.com/realmapi.svc/CreateSessionXML/1004/de9a8114c56e02abd057a0f2d9671b7d/20180628012612

Response: XML

<Session>
	<ret_msg>Approved</ret_msg>
	<session_id>1465AFCA32DBDB800CEF8C72F296C52C</session_id>
	<timestamp>6/28/2018 1:26:12 AM</timestamp>
</Session>

Get Data Used

/GetDataUsed[ResponseFormat]/{devID}/{signature}/{session_Id}/{timestamp}
Returns API Developer daily usage limits and the current status against those limits.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetDataUsed" method 373607841571123d501d6febfb43d5e7
session_id A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612



Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetDataUsedJSON/1004/373607841571123d501d6febfb43d5e7/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612

Response: JSON

{
	"Active_Sessions": 9,
	"Concurrent_Sessions": 50,
	"Request_Limit_Daily": 7500,
	"Session_Cap": 500,
	"Session_Time_Limit": 15,
	"Total_Requests_Today": 51,
	"Total_Sessions_Today": 29,
	"ret_msg": null
}

Get Hi-Rez Server Status

/GetHiRezServerStatus[ResponseFormat]/{devID}/{signature}/{session}/{timestamp}
Returns UP/DOWN status for the primary game/platform environments.

DATA IS CACHED ONCE A MINUTE.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetHiRezServerStatus" method f44fe20c2678a76d0eb861b071cacc2f
session A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612



Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetHiRezServerStatusJSON/1004/f44fe20c2678a76d0eb861b071cacc2f/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612

Response: JSON

{
	"entry_datetime": "2018-06-28 01:26:12.315",
	"status": "UP",
	"version": "0.4.232.2",
	"ret_msg": null
}

Get Patch Info

/GetPatchInfo[ResponseFormat]/{devID}/{signature}/{session}/{timestamp}
Returns information about current deployed patch.

CURRENTLY, THIS INFORMATION ONLY INCLUDES PATCH VERSION.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetPatchInfo" method a4b47cbe1a5f9488c2ba760c50f30cf1
session A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612



Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetPatchInfoJSON/1004/a4b47cbe1a5f9488c2ba760c50f30cf1/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612

Response: JSON

{
	"version": "0.4.232.2",
	"version_id": 262376,
	"version_code":  "OB4",
	"ret_msg": null
}

Ping

/Ping[ResponseFormat]
A quick way of validating availabiltiy of the Realm Royale API.

Parameter Description Example
ResponseFormat JSON or XML json


Requesting JSON: http://api.realmroyale.com/realmapi.svc/PingJSON

Response: TEXT PLAIN

RealmAPI (ver 1.0.0.0) [PATCH - 0.4.232.2] - Ping successful. Server Date:6/28/2018 1:26:12 AM

Test Session

/TestSession[ResponseFormat]/{devId}/{signature}/{session_id}/{timestamp}
A means of validating that a session is established.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "TestSession" method 776593aeca54002ea815a1b6ea4c7c7e
session_id A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612


Requesting JSON: http://api.realmroyale.com/realmapi.svc/TestSessionJSON/1004/776593aeca54002ea815a1b6ea4c7c7e/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612

Response: TEXT PLAIN

This was a successful test with the following parameters added: developer: 1004 time: 6/28/2018 1:26:12 AM signature: 776593aeca54002ea815a1b6ea4c7c7e session: 1465AFCA32DBDB800CEF8C72F296C52C

General informations

Get Leaderboard

/GetLeaderboard[ResponseFormat]/{devId}/{signature}/{session_id}/{timestamp}/{queue}/{ranking_criteria}
Returns leaderboard information for a particular queue.

DON'T SPAM THE CALLS!
EXPECT THIS DATA TO BE CACHED ON AN HOURLY BASIS BECAUSE THE QUERY TO ACQUIRE THE DATA WILL BE EXPENSIVE

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetLeaderboard" method ed37a2923b453df1d90f3c3b821da12d
session_id A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612
queue A valid Queue ID 476
ranking_criteria A valid Ranking Criteria 1

Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetLeaderboardJSON/1004/ed37a2923b453df1d90f3c3b821da12d/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612/476/1

Response: JSON

{
	"queue_id": 476,
	"queue": "Quad",
	"last_updated": "3\/18\/2018 5:14:27 PM",
	"leaderboard": [{
		"rank": 1,
		"player_name": "BestPlayer",
		"player_id": 1242243,
		"matches": 234,
		"team_wins": 15,
		"team_avg_placement": 5
	},
	{
		"rank": 2,
		"player_name": "2ndBestPlayer",
		"player_id": 1242244,
		"matches": 423,
		"team_wins": 16,
		"team_avg_placement": 5.1
	}],
}

Get Match Details

/GetMatchDetails[ResponseFormat]/{devId}/{signature}/{session_id}/{timestamp}/{matchId}
Returns end of match stats for a particular match.

INTRA-MATCH STATS AREN'T AVAILABLE.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetMatchDetails" method 5a20182894eff801b627cfe89681f6ac
session_id A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612
matchId A valid Match ID 1793874

Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetMatchDetailsJSON/1004/5a20182894eff801b627cfe89681f6ac/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612/1793874

Response: JSON

{
	"match_id": 1793874,
	"region": "Europe",
	"queue_id": 476,
	"queue": "Quad",
	"duration_secs": 1805,
	"teams": [{
		"id": 383773,
		"placement": 1,
		"players": [{
			"name": "1stPlayer",
			"id": 3987123,
			"level": 22,
			"kills_player": 2,
			"kills_bot": 1,
			"assists": 1,
			"deaths": 1,
			"damage_player": 3361,
			"healing_player": 249.999985,
			"duration_secs": 1422,
			"damage_taken": 344,
			"killing_spree_max": 11,
			"dropped_out_flag": 0,
			"healing_player_self": 284,
			"damage_mitigated": 450,
			"class_name": "Warrior",
			"class_id": 2594,
			"damage_done_in_hand": 1231,
			"mines_wards_placed": 96,
			"earned_xp": 27100,
			"earned_tokens": 177
		}],
	}],
}

Get Match IDs By Queue

/GetMatchIDsByQueue[ResponseFormat]/{devId}/{signature}/{session_id}/{timestamp}/{queue}/{date}/{hour}
Returns all matchID values for a queue for a particular timeframe.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetMatchIdsByQueue" method f5710889f18d346e6a8924fba9866074
session_id A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612
queue A valid Queue ID 476
date A valid Date
hour A valid Hour

Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetMatchIDsByQueueJSON/1004/f5710889f18d346e6a8924fba9866074/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612/{queue}/{date}/{hour}

Response: JSON

{
	"active_flag": "n",
	"match": 1793874
}

Get Player

/GetPlayer[ResponseFormat]/{devId}/{signature}/{session_id}/{timestamp}/{player}/{platform}
Returns basic player information.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetPlayer" method b2dbe06013c94040b739775776c780a6
session_id A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612
player A valid Player RealmHero
platform HIREZ or STEAM hirez

Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetPlayerJSON/1004/b2dbe06013c94040b739775776c780a6/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612/RealmHero/hirez

Response: JSON

{
	"created_datetime": "3\/18\/2018 5:14:27 PM",
	"id": 123,
	"last_login_datetime": "6\/12\/2018 7:51:11 PM",
	"level": 22,
	"name": "RealmHero",
	"region": "Europe",
	"ret_msg": null,
	"steam_id": 76561198199559770
}

Get Player Match History

/GetPlayerMatchHistory[ResponseFormat]/{devId}/{signature}/{session_id}/{timestamp}/{player}
Returns high level data regarding matches played in the past 30 days.

LIMITED TO THE 50 MOST RECENT MATCHES.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetPlayerMatchHistory" method 0eae1e63636000af32bf350606d8f0cf
session_id A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612
player A valid Player 123

Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetPlayerMatchHistoryJSON/1004/0eae1e63636000af32bf350606d8f0cf/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612/123

Response: JSON

{
	"name": "RealmHero",
	"id": 123,
	"matches": [{
		"match_id": 526153,
		"match_datetime": "6\/14\/2018 5:14:27 PM",
		"match_duration_secs": 1243,
		"map_game": "LIVE Royale Map",
		"match_queue_name": "Duo",
		"match_queue_id": 475,
		"class_name": "Mage",
		"class_id": 2285,
		"team_id": 123828,
		"region": "Brazil",
		"gold": 0,
		"kills": 1,
		"creeps": 1,
		"assists": 0,
		"deaths": 1,
		"minutes": 8,
		"time_in_match_seconds": 513,
		"placement": 17,
		"damage": 2295,
		"damage_taken": 1949,
		"healing_player": 325,
		"healing_player_self": 308,
		"healing_bot": 0,
		"killing_spree_max": 1,
		"damage_mitigated": 1500,
		"damage_done_in_hand": 300,
		"wards_mines_placed": 94
	}]
}

Get Player Stats

/GetPlayerStats[ResponseFormat]/{devId}/{signature}/{session_id}/{timestamp}/{player}
Returns player stats for each Queue Id and Class combination.

Average_placement and placements are TBD based on query performance and will likely be that for only the past 30 days due to purging of the source table.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetPlayerStats" method f7bd9ee8e379d848bee953f64e3848c3
session_id A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612
player A valid Player 123

Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetPlayerStatsJSON/1004/f7bd9ee8e379d848bee953f64e3848c3/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612/123

Response: JSON

{
	"id": 123,
	"aggregate_stats": {
		"games_played": 2521,
		"kills_player": 1371,
		"kills_bot": 46,
		"killing_spree_max": 25,
		"deaths": 2479,
		"assists": 1214,
		"duration_secs": 5210000,
		"damage_player": 220190,
		"damage_taken": 43790,
		"damage_mitigated": 5942,
		"healing_player": 249.999985,
		"healing_player_self": 6635,
		"wins": 8,
		"losses": 1519,
		"wards_mines_placed": 11098,
		"earned_xp": 1575850,
		"earned_tokens": 1442,
		"average_placement": 23,
		"placements": {"1": 8, "2": 7, "3": 13, "4": 12, "... 28": 0, "29": 3}
	},
	"queue_class_stats": [{
		"match_queue_name": "Solo",
		"match_queue_id": 474,
		"class_name": "Warrior",
		"class_id": 2594,
		"stats": {
			"games_played": 521,
			"kills_player": 371,
			"kills_bot": 6,
			"killing_spree_max": 5,
			"deaths": 479,
			"assists": 214,
			"duration_secs": 52100,
			"damage_player": 22019,
			"damage_taken": 4379,
			"damage_mitigated": 942,
			"healing_player": 249.999985,
			"healing_player_self": 663,
			"wins": 2,
			"losses": 519,
			"wards_mines_placed": 1098,
			"earned_xp": 157850,
			"earned_tokens": 442,
			"average_placement": 17,
			"placements": {"1": 2, "2": 4, "3": 3, "4": 3, "... 26": 0, "27": 1}
		}
	},
	{
		"match_queue_name": "Duo",
		"match_queue_id": 475,
		"class_name": "Warrior",
		"class_id": 2594,
		"stats": {
			"games_played": 521,
			"kills_player": 371,
			"kills_bot": 6,
			"killing_spree_max": 5,
			"deaths": 479,
			"assists": 214,
			"duration_secs": 52100,
			"damage_player": 22019,
			"damage_taken": 4379,
			"damage_mitigated": 942,
			"healing_player": 249.999985,
			"healing_player_self": 663,
			"wins": 2,
			"losses": 519,
			"wards_mines_placed": 1098,
			"earned_xp": 157850,
			"earned_tokens": 442,
			"average_placement": 17,
			"placements": {"1": 2, "2": 4, "3": 3, "4": 3, "... 26": 0, "27": 1}
		}
	}]
}

Get Player Status

/GetPlayerStatus[ResponseFormat]/{devId}/{signature}/{session_id}/{timestamp}/{player}
Returns player online/offline status.

Parameter Description Example
ResponseFormat JSON or XML json
devID The devID from your Credentials 1004
signature The Signature of "GetPlayerStatus" method 7eb731fd427f950cd89b5a993decd9cb
session_id A valid Session 1465AFCA32DBDB800CEF8C72F296C52C
timestamp The current Timestamp 20180628012612
player A valid Player RealmHero

Requesting JSON: http://api.realmroyale.com/realmapi.svc/GetPlayerStatusJSON/1004/7eb731fd427f950cd89b5a993decd9cb/1465AFCA32DBDB800CEF8C72F296C52C/20180628012612/RealmHero

Response: JSON

{
	"match_id": 1181882,
	"personal_status_message": null,
	"status_id": 3,
	"status": "In Game",
	"ret_msg": null
}

API Parameters Details

Classes

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.

There are currently 5 playable classes:

ID Name In-Game Name Image
2285 Male Tank Warrior
2493 Female Damage Hunter
2494 Female Support Mage
2495 Male Utility Engineer
2496 Male Flank Assassin

Date

Date - a string in the format “20171231” (for Dec 31, 2017, as an example)

Hour

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.

Language

The language Id that you want results returned in. Default is 1. 1 - English, 2 - German, 3 - French, 5 - Chinese, 7 - Spanish, 9 - Spanish (Latin America), 10 - Portuguese, 11 - Russian, 12 - Polish, 13 - Turkish

Match ID

match_id - The id of the match. Can be obtained from /GetMatchHistory & /GetMatchidsByQueue.

Player

This may either be a,) the Player Name, or b.) the Hirez internally stored player_id (available to API developers via the /getplayer API method). PlayerId (int)- This is the Player ID. Player Name (string) - This is the Player Name. SteamID (int) - This is the Player Steam ID.

Player Status

Returns Player Status as follows:

ID 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)

Queue

The id of the game mode (last updated 2018-06-30):

ID Name In-game name
474 Solo LIVE Solo
475 Duo LIVE Duo
476 Quad LIVE Quad

Rank tier & division

Ranking is based on the player's placement in their top 50 matches (even if they haven't played 50 matches, they will still receive a rank based on the placement in all of the current matches).

Players can only work their way up the ranks by placing higher and higher in matches, and can't fall over time.
Once a player has reached 50 wins, the game will also track the total number of eliminations they have made within those top 50 games.

Each queue (solo, duo and squad) has its own separate ranking.

Tier

Ranked has several tiers that players can be placed in, from Bronze to Grandmaster. Players without a tier will be set as Unranked.

ID Name Image
0 Unranked
1-5 Bronze
6-10 Silver
11-15 Gold
15-20 Platinum
20-25 Diamond
26 Master
27 Grandmaster

Division

Each tier except for Master and Grandmaster is divided in 5 divisions.

ID Name Image
1 Bronze V
2 Bronze IV
3 Bronze III
4 Bronze II
5 Bronze I
6 Silver V
7 Silver IV
8 Silver III
9 Silver II
10 Silver I
11 Gold V
12 Gold IV
13 Gold III
14 Gold II
15 Gold I
16 Platinum V
17 Platinum IV
18 Platinum III
19 Platinum II
20 Platinum I
21 Diamond V
22 Diamond IV
23 Diamond III
24 Diamond II
25 Diamond I

Ranking Criteria

ID Description
1 Team Wins
2 Team Average Placement (shown below)
3 Individual Average Kills
4 Winrate

Terms of service

Contact the developer

Realm Royale

Home

Getting started

Methods & parameters

Codes examples

Clone this wiki locally