API Parameter Details

date - a string in the format “20141231” (for Dec 31, 2014, as an example)
queue - the id of the game mode
- Conquest5v5 = 423,
- NoviceQueue = 424,
- Conquest = 426,
- Practice = 427,
- ConquestChallenge = 429,
- ConquestRanked = 430,
- Domination = 433,
- MOTD = 434 (use with 465 to get all MOTD matches),
- Arena = 435,
- ArenaChallenge = 438,
- DominationChallenge = 439,
- Joust Ranked (1v1) / Ranked Duel = 440,
- JoustChallenge = 441,
- Assault = 445,
- AssaultChallenge = 446,
- Joust3v3 = 448,
- Joust Ranked (3v3) = 450,
- Conquest Ranked = 451,
- Arena Ranked = 452
- MOTD = 465 (Supports “closing” the Queue by our platform; use with 434)
- Clash = 466
- Clash Challenge = 467
languageCode - the language Id that you want results returned in. Default is 1.
- 1 - English
- 2 - German
- 3 - French
- 7 - Spanish
- 9 - Spanish (Latin America)
- 10 - Portuguese
- 11 - Russian
- 12 - Polish
- 13 - Turkish
match_id - The id of the match. Can be obtained from getmatchHistory, gettopmatches & getmatchidsbyqueue.
season - The season of a league. Starts at 1 and increases by 1 for each calendar month
tier - League tier
- Bronze V = 1, Bronze IV = 2, Bronze III = 3, Bronze II = 4, Bronze I = 5
- Silver V = 6, Silver IV = 7, Silver III = 8, Silver II = 9, Silver I = 10
- Gold V = 11, Gold IV = 12, Gold III = 13, Gold II = 14, Gold I = 15
- Platinum V = 16, Platinum IV = 17, Platinum III = 18, Platinum II = 19, Platinum I = 20
- Diamond V = 21, Diamond IV = 22, Diamond III = 23, Diamond II = 24, Diamond I = 25
- Masters I = 26
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).
Player Name - This is the Player Name.
clanId - id of the clan. Can be obtained from searchteams
searchTeam - name of clan for whom to search

APIs - Connectivity

Ping

/ping[ResponseFormat]

A quick way of validating access to the Hi-Rez API.

Create session

/createsession[ResponseFormat]/{developerId}/{signature}/{timestamp}

A required step to Authenticate the developerId/signature for further API use.

Test Session

/testsession[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}

A means of validating that a session is established.

APIs - SMITE Data

Get data used

/getdataused[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}

Returns API Developer daily usage limits and the current status against those limits.

Get demo details

/getdemodetails[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{match_id}

Returns information regarding a particular match. Rarely used in lieu of getmatchdetails().

Get sports pro league details

/getesportsproleaguedetails[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}

Returns the matchup information for each matchup for the current eSports Pro League season. An important return value is “match_status” which represents a match being scheduled (1), in-progress (2), or complete (3)

Get friends

/getfriends[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}

Returns the Smite User names of each of the player’s friends.

Get god ranks

/getgodranks[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}

Returns the Rank and Worshippers value for each God a player has played.

Get champions ranks

/getchampionranks[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}

Returns the Rank and Worshippers value for each Champion a player has played.[PaladinsAPI only]

Get gods

/getgods[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{languageCode}

Returns all Gods and their various attributes.

Get champions

/getchampions[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{languageCode}

Returns all Champions and their various attributes.[PaladinsAPI only]

Get god skins

/getgodskins[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{godId}/{languageCode}

Returns all available skins for a particular God.

Get champion skins

/getchampionskins[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{godId}/{languageCode}

Returns all available skins for a particular Champion.[PaladinsAPI only]

Get god recommended items

/getgodrecommendeditems[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{godid}/{languageCode}

Returns the Recommended Items for a particular God.

Get champion recommended items

/getchampionecommendeditems[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{godid}/{languageCode}

Returns the Recommended Items for a particular Champion.[PaladinsAPI only]

Get items

/getitems[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{languagecode}

Returns all Items and their various attributes.

Get match details

/getmatchdetails[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{match_id}

Returns the statistics for a particular completed match.

Get match player details

/getmatchplayerdetails[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{match_id}

Returns player information for a live match.

Get match ids by queue

/getmatchidsbyqueue[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{queue}/

{date}/{hour}

Lists all Match IDs for a particular Match Queue; useful for API developers interested in constructing data by Queue. To limit the data returned, an {hour} parameter was added (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. Also, a returned “active_flag” means that there is no match information/stats for the corresponding match. Usually due to a match being in-progress, though there could be other reasons.

NOTE- 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.

Get league leader board

/getleagueleaderboard[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{queue}/{tier}/{season}

Returns the top players for a particular league (as indicated by the queue/tier/season parameters).

Get league seasons

/getleagueseasons[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{queue}

Provides a list of seasons (including the single active season) for a match queue.

Get match history

/getmatchhistory[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}

Gets recent matches and high level match statistics for a particular player.

Get most recent

/getmotd[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}

Returns information about the 20 most recent Match-of-the-Days.

Get player

/getplayer[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}

Returns league and other high level data for a particular player.

Get player status

/getplayerstatus[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}

Returns player status as follows:

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)

Get queue status

/getqueuestats[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}/{queue}

Returns match summary statistics for a (player, queue) combination grouped by gods played.

Get team details

/getteamdetails[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{clanid}

Lists the number of players and other high level details for a particular clan.

Get team match history

/getteammatchhistory[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{clanid}

Gets recent matches and high level match statistics for a particular clan/team.

*DEPRECATED* - As of 2.14 Patch, /getteammatchhistory is no longer supported and will return a NULL dataset.

Get team players

/getteamplayers[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{clanid}

Lists the players for a particular clan.

Get top matches

/gettopmatches[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}

Lists the 50 most watched / most recent recorded matches.

Get search teams

/searchteams[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{searchTeam}

Returns high level information for Team names containing the “searchTeam” string.

Get player achievements

/getplayerachievements[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{playerId}

Returns select achievement totals (Double kills, Tower Kills, First Bloods, etc) for the specified playerId.

Get patch info

/getpatchinfo[ResponseFormat]/{developerId}/{signature}/{timestamp}

Function returns information about current deployed patch. Currently, this information only includes patch version.

API methods & Parameteres