Smite API Developer Guide

SMITE API Developer Guide
TABLE OF CONTENTS
TABLE OF CONTENTS
DOCUMENT CHANGE HISTORY
GETTING STARTED
Introduction
Registration
Credentials
Sessions
API Access Limits
API METHODS & PARAMETERS
APIs Connectivity
APIs SMITE Data
API Parameter Details
CREATING A SESSION
CREATING A SIGNATURE
Sample C# Code to Create a Signature:
EXAMPLE API CALL
The MatchId Parameter
GRAPHICS
APPENDIX A COMPREHENSIVE CODE EXAMPLE
The Form1.Designer.cs file (for the buttons):
The Form1.cs File (For the API Method Calls)

DOCUMENT CHANGE HISTORY

DATE MODIFIED BY CHANGE DESCRIPTION
20131212 AP/JC Initial Version
20140522 AP Added method “ (Request: Cyber)

getmatchidsbyqueue”
20140707 AP Added method “

getgodrecommendeditems”
20140710 AP Added section for API Access Limits
20140722 AP Added brief description of data returned by each API.
20140731 AP Updates to “ added {hour} parameter

getmatchidsbyqueue”;
20140904 AP Added method “

getesportsproleaguedetails”
20150211 AP Added methods “ ” and “

getplayerstatus ”
getmatchplayerdetails
20150304 AP Removed method “ ”

20150403 AP Readded method “ ”

20150520 AP Added queue for MOTD (465)

GETTING STARTED
Introduction
The purpose of this document is to provide SMITE API Developers with the necessary
information to access and utilize the API methods. The JSON data returned from the API
methods is designed to be “self-documenting” and therefore detailed descriptions of each
data field are not included in this SMITE API Developer Guide.

Registration

To register to become developer, go hereto register. If your application is accepted you
will receive custom credentials to access the API.
Credentials

To access the API you'll need your own set of credentials which consist of a developer id
(devId) and an authentication key (authKey). The process of obtaining credentials should
be a one-time activity.
Here are the credentials for a sample account:
● DevId: (eg, 1004)

● AuthKey: (eg, 23DF3C7E9BD14D84BF892AD206B6755C)
Use your personal credentials to access the api via a

Representational State Transfer
(REST) web service hosted at api.smitegame.com.
Sessions
To begin using the API, you will first need to establish a valid Session. To do so you will
start a session (via the
createsession method) and receive a SessionId. Sessions are
used for authentication, security, monitoring, and throttling. Once you obtain a SessionId,
you will pass it to other methods for authentication. Each session only lasts for 15 minutes
and must be recreated afterward.
More details regarding Session creation are provided later in this document.
API Access Limits

To throttle API Developer access various limits have been setup to prevent over use of the
API (either intentional, more likely unintentional “over use”).

Here are the default initial limitations for API Developers:

concurrent_sessions: 50
sessions_per_day: 500
session_time_limit: 15 minutes
request_day_limit: 7500
API METHODS & PARAMETERS
APIs Connectivity

/
ping
[ResponseFormat]
A quick way of validating access to the Hi-Rez API.
/
createsession
[ResponseFormat]/{developerId}/{signature}/{timestamp}
A required step to Authenticate the developerId/signature for further API use.
/
testsession
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}
A means of validating that a session is established.
APIs SMITE Data
/
getdataused
Returns API Developer daily usage limits and the current status against those limits.
/
getdemodetails
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{match_id}
Returns information regarding a particular match. Rarely used in lieu of getmatchdetails().
/
getesportsproleaguedetails
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)
/
getfriends
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}
Returns the Smite User names of each of the player’s friends.
/
getgodranks
Returns the Rank and Worshippers value for each God a player has played.
/
getgods
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{languageCode}
Returns all Gods and their various attributes.
/
getgodrecommendeditems
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{godid}
/{languageCode}
Returns the Recommended Items for a particular God.
/
getitems
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{languagecode}
Returns all Items and their various attributes.
/
getmatchdetails
Returns the statistics for a particular completed match.
/
Returns player information for a live match.
/
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.
/
getleagueleaderboard
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{queue}/{tie
r}/{season}
Returns the top players for a particular league (as indicated by the queue/tier/season parameters).
/
getleagueseasons
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{queue}
Provides a list of seasons (including the single active season) for a match queue.
/
getmatchhistory
Gets recent matches and high level match statistics for a particular player.
/
getplayer
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{playerName}
Returns league and other high level data for a particular player.
/
getplayerstatus
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)
/
getqueuestats
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}/{queue}
Returns match summary statistics for a (player, queue) combination grouped by gods played.
/
getteamdetails
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{clanid}
Lists the number of players and other high level details for a particular clan.
/
getteammatchhistory
Gets recent matches and high level match statistics for a particular clan/team.
/
getteamplayers
Lists the players for a particular clan.
/
gettopmatches
Lists the 50 most watched / most recent recorded matches.
/
searchteams
[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{searchTeam}
Returns high level information for Team names containing the “searchTeam” string.

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,
○ JoustLeague = 440,
○ JoustChallenge = 441,
○ Assault = 445,
○ AssaultChallenge = 446,
○ Joust3v3 = 448,
○ ConquestLeague = 451,
○ ArenaLeague = 452
○ MOTD = 465 (Supports “closing” the Queue by our platform; use with 434)
● 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
CREATING A SESSION

The url format for calling a method from the api is
http://api.smitegame.com/smiteapi.svc/ +
the pattern for the method above, where [ResponseFormat] is replaced by the formatting
that you want returned (either XML or JSON).
To create a session with a JSON response, call the

createsession
method as follows:
http://api.smitegame.com/smiteapi.svc/createsessionJson/1004/8f53249be0922c94720834771ad4
3f0f/20120927183145
which would return JSON data such as:

{
"ret_msg": "Approved",
"session_id": "0ECDF26BC1F04EE4BA4AF10EC3604E04",
"timestamp": "2/14/2013 7:50:20 PM"
}

The sessionId is contained in an element called “session_id”. This parameter is needed to
call the other methods.
You'll see that we passed in a few other variables besides our

devId
and
authKey
.
Actually the authKey is not passed directly, but instead embedded and hashed in another
parameter (signature ).

CREATING A SIGNATURE
A distinct signature is required for each API method called.
The signature is created by concatenating several fields and then hashing the result with
an MD5 algorithm. The components of this hash are (in order):
1. your devId
2. the method name being called (eg, “createsession”)
a. This will not include the ResponseType, just the name of the method.
3. your authKey
4. current utc timestamp (formatted yyyyMMddHHmmss)
Sample C# Code to Create a Signature:
var signature = GetMD5Hash("1004" + "createsession" +
23DF3C7E9BD14D84BF892AD206B6755C
" " + "20120927183145");

private static string GetMD5Hash(string input) {
var md5 = new System.Security.Cryptography.MD5CryptoServiceProvider();
var bytes = System.Text.Encoding.UTF8.GetBytes(input);
bytes = md5.ComputeHash(bytes);
var sb = new System.Text.StringBuilder();
foreach (byte b in bytes) {
sb.Append(b.ToString("x2").ToLower());
}
return sb.ToString();
}

EXAMPLE API CALL
The uri to use for all API calls starts with followed by
http://api.smitegame.com/smiteapi.svc/
a slash + the method + any parameters to complete the call.
For example, to get stats for a given player, call

getplayer
in the following manner:
http://api.smitegame.com/smiteapi.svc/getplayerjson/1004/0abd990b4ca9f86817e087ad68
4515db/83B082E576584DA8B1DB073DECA9E819/20120927193800/HirezPlayer
Again, the complete pattern for this call is:
getplayer[ResponseFormat]/{devId}/{signature}/{sessionId}/{timestamp}/{playe
rName}
A JSON [ResponseFormat] for this call would provide JSON results as follows:
[
{
"Created_Datetime": "5/30/2012 2:34:40 PM",
"Last_Login_Datetime": "8/24/2013 12:02:20 AM",
"Leaves": 0,
"Level": 30,
"Losses": 10,
"MasteryLevel": 0,
"Name": "HirezPlayer",
"Rank_Stat": 0,
"TeamId": 0,
"Team_Name": "",
"Wins": 40,
"ret_msg": null
}
]
The MatchId Parameter
The pattern for getmatchstats is:
getmatchstats[ResponseFormat]/{devId}/{signature}/{sessionId}/{timestamp}/{matchId}
The {matchId} parm is a unique id for each map that’s created by the server for a set of players.
One place you can get this value from will be getmatchhistory.
GRAPHICS
You can find any graphics that we’ve published for use
here
.
APPENDIX A COMPREHENSIVE CODE EXAMPLE

To assist with development & debugging efforts, the following sample Microsoft Visual Studio 2012
WindowsFormApplication is provided. Note that you may have to add a few Assembly References to
your project if some of the System.* classes can’t initially be found.

The application simply consists of:

a.) a button to call the
createsession
API method, and
b.) a button to call the
getgods
API method and some logic to display all gods in a MessageBox.

The values for devKey and authKey are removed for security purposes.

Note that the API calls are synchronous and may take a few seconds before generating a response.
You will probably call the API asynchronously, but for purposes of this exercise (to quickly understand
how to work with the API methods) the synchronous method was used.

The application consists of two primary forms (Form1.cs & Form1.Designer.cs) listed on the following
pages.

Form1.Designer.cs
The file (for the buttons):

namespace WindowsFormsApplication1
{
partial class Form1
{
/// <summary>
/// Required designer variable.
/// </summary>
private System.ComponentModel.IContainer components = null;

/// <summary>
/// Clean up any resources being used.
/// </summary>
/// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
protected override void Dispose(bool disposing)
{
if (disposing && (components != null))
{
components.Dispose();
}
base.Dispose(disposing);
}

#region Windows Form Designer generated code

/// <summary>
/// Required method for Designer support do not modify
/// the contents of this method with the code editor.
/// </summary>
private void InitializeComponent()
{
this.buttonCreateSession = new System.Windows.Forms.Button();
this.buttonGetGods = new System.Windows.Forms.Button();
this.label1 = new System.Windows.Forms.Label();
this.label2 = new System.Windows.Forms.Label();
this.SuspendLayout();
//
// buttonCreateSession
//
this.buttonCreateSession.Location = new System.Drawing.Point(280, 168);
this.buttonCreateSession.Name = "buttonCreateSession";
this.buttonCreateSession.Size = new System.Drawing.Size(205, 23);
this.buttonCreateSession.TabIndex = 1;
this.buttonCreateSession.Text = "Create Session\r\n";
this.buttonCreateSession.UseVisualStyleBackColor = true;
this.buttonCreateSession.Click += new System.EventHandler(this.buttonCreateSession_Click);
//
// buttonGetGods
//
this.buttonGetGods.Location = new System.Drawing.Point(280, 211);
this.buttonGetGods.Name = "buttonGetGods";
this.buttonGetGods.Size = new System.Drawing.Size(205, 23);
this.buttonGetGods.TabIndex = 2;
this.buttonGetGods.Text = "Call GetGods() API Method\r\n";
this.buttonGetGods.UseVisualStyleBackColor = true;
this.buttonGetGods.Click += new System.EventHandler(this.buttonGetGods_Click);
//
// label1
//
this.label1.AutoSize = true;
this.label1.Location = new System.Drawing.Point(229, 173);
this.label1.Name = "label1";
this.label1.Size = new System.Drawing.Size(38, 13);
this.label1.TabIndex = 4;
this.label1.Text = "Step 1";
//
// label2
//
this.label2.AutoSize = true;
this.label2.Location = new System.Drawing.Point(229, 216);
this.label2.Name = "label2";
this.label2.Size = new System.Drawing.Size(38, 13);
this.label2.TabIndex = 5;
this.label2.Text = "Step 2";
//
// Form1
//
this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
this.ClientSize = new System.Drawing.Size(802, 414);
this.Controls.Add(this.label2);
this.Controls.Add(this.label1);
this.Controls.Add(this.buttonGetGods);
this.Controls.Add(this.buttonCreateSession);
this.Name = "Form1";
this.Text = "Form1";
this.ResumeLayout(false);
this.PerformLayout();

}

#endregion

private System.Windows.Forms.Button buttonCreateSession;
private System.Windows.Forms.Button buttonGetGods;
private System.Windows.Forms.Label label1;
private System.Windows.Forms.Label label2;
}
}

Form1.cs
The File (For the API Method Calls)

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.IO;
using System.Threading.Tasks;
using System.Windows.Forms;

using System.Security.Cryptography;
using System.Net;
using System.Runtime.Serialization;
using System.Runtime.Serialization.Json;
using System.Web.Script.Serialization;

namespace WindowsFormsApplication1
{

public partial class Form1 : Form
{
string devKey = "XXXX"; // devKey goes here
string authKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; // authKey goes here
string timestamp = DateTime.UtcNow.ToString("yyyyMMddHHmmss");
string urlPrefix = "http://api.smitegame.com/smiteapi.svc/";

string signature = "";
string session = "";

public Form1()
{
InitializeComponent();
}

private static string GetMD5Hash(string input)
{
var md5 = new System.Security.Cryptography.MD5CryptoServiceProvider();
var bytes = System.Text.Encoding.UTF8.GetBytes(input);
bytes = md5.ComputeHash(bytes);
var sb = new System.Text.StringBuilder();
foreach (byte b in bytes)
{
sb.Append(b.ToString("x2").ToLower());
}
return sb.ToString();
}

private void buttonCreateSession_Click(object sender, EventArgs e)
{
// Get Signature that is specific to "createsession"
//
signature = GetMD5Hash(devKey + "createsession" + authKey + timestamp);

// Call the "createsession" API method & wait for synchronous response
//
WebRequest request = WebRequest.Create(urlPrefix + "createsessionjson/" + devKey + "/" + signature + "/" + timestamp);
WebResponse response = request.GetResponse();

Stream dataStream = response.GetResponseStream();
StreamReader reader = new StreamReader(dataStream);

string responseFromServer = reader.ReadToEnd();

reader.Close();
response.Close();

// Parse returned JSON into "session" data
//
using (var web = new WebClient())
{
web.Encoding = System.Text.Encoding.UTF8;
var jsonString = responseFromServer;
var jss = new JavaScriptSerializer();
var g = jss.Deserialize<SessionInfo>(jsonString);

session = g.session_id;

MessageBox.Show(session);
}
}

private void buttonGetGods_Click(object sender, EventArgs e)
{
// Get Signature that is specific to "getgods"
//
signature = GetMD5Hash(devKey + "getgods" + authKey + timestamp);

// Call the "getgods" API method & wait for synchronous response
//
string languageCode = "1";

WebRequest request = WebRequest.Create(urlPrefix + "getgodsjson/" + devKey + "/" + signature + "/" + session + "/" + timestamp + "/"
+ languageCode);
WebResponse response = request.GetResponse();

Stream dataStream = response.GetResponseStream();
StreamReader reader = new StreamReader(dataStream);

string responseFromServer = reader.ReadToEnd();

reader.Close();
response.Close();

// Parse returned JSON into "gods" data
//
using (var web = new WebClient())
{
web.Encoding = System.Text.Encoding.UTF8;
var jsonString = responseFromServer;
var jss = new JavaScriptSerializer();
var GodsList = jss.Deserialize<List<Gods>>(jsonString);
string GodsListStr = "";

foreach (Gods x in GodsList)
GodsListStr = GodsListStr + ", " + x.Name;

MessageBox.Show("Here are the Gods: " + GodsListStr);
}

}

public class SessionInfo
{
public string ret_msg { get; set; }
public string session_id { get; set; }
public string timestamp { get; set; }

}

public class Menuitem
{
public string description { get; set; }
public string value { get; set; }
}

public class Rankitem
{
public string value { get; set; }
}

public class AbilityDescription
{
public string secondaryDescription { get; set; }
public List<Menuitem> menuitems { get; set; }
public List<Rankitem> rankitems { get; set; }
public string cooldown { get; set; }
public string cost { get; set; }
}

public class AbilityRoot
{
public AbilityDescription itemDescription { get; set; }
}

public class Gods
{
public int abilityId1 { get; set; }
public AbilityRoot abilityDescription1 { get; set; }
public int id { get; set; }
public string Pros { get; set; }
public string Type { get; set; }
public string Roles { get; set; }
public string Name { get; set; }
public string Title { get; set; }
public string OnFreeRotation { get; set; }
public string Lore { get; set; }
public int Health { get; set; }
public Double HealthPerLevel { get; set; }
public Double Speed { get; set; }
public Double HealthPerFive { get; set; }
public Double HP5PerLevel { get; set; }
public Double Mana { get; set; }
public Double ManaPerLevel { get; set; }
public Double ManaPerFive { get; set; }
public Double MP5PerLevel { get; set; }
public Double PhysicalProtection { get; set; }
public Double PhysicalProtectionPerLevel { get; set; }
public Double MagicProtection { get; set; }
public Double MagicProtectionPerLevel { get; set; }
public Double PhysicalPower { get; set; }
public Double PhysicalPowerPerLevel { get; set; }
public Double AttackSpeed { get; set; }
public Double AttackSpeedPerLevel { get; set; }
public string Pantheon { get; set; }
public string Ability1 { get; set; }
public string Item1 { get; set; }
public int ItemId1 { get; set; }
public string ret_msg { get; set; }
}
}
}

Smite API Developer Guide

Uploaded by

Copyright:

Available Formats

Smite API Developer Guide

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Smite API Developer Guide

Uploaded by

Copyright:

Available Formats

SMITE API Developer Guide

2013­12­12 AP/JC Initial Version

2014­05­22 AP Added method “​ (Request: Cyber)

2014­07­07 AP Added method “​

2014­07­10 AP Added section for API Access Limits

2014­07­22 AP Added brief description of data returned by each API.

2014­07­31 AP Updates to “​ added {hour} parameter

2014­09­04 AP Added method “​

2015­02­11 AP Added methods “​ ” and “​

2015­03­04 AP Removed method “​ ”

2015­04­03 AP Re­added method “​ ”

2015­05­20 AP Added queue for MOTD (465)

Here are the credentials for a sample account:

● DevId: (eg, 1004)

Use your personal credentials to access the api via a ​

To create a session with a JSON response, call the ​

which would return JSON data such as:

You'll see that we passed in a few other variables besides our ​

A distinct signature is required for each API method called.

For example, to get stats for a given player, call ​

Again, the complete pattern for this call is:

The pattern for getmatchstats is:

You might also like

20131212 AP/JC Initial Version

20140522 AP Added method “ (Request: Cyber)

20140707 AP Added method “

20140710 AP Added section for API Access Limits

20140722 AP Added brief description of data returned by each API.

20140731 AP Updates to “ added {hour} parameter

20140904 AP Added method “

20150211 AP Added methods “ ” and “

20150304 AP Removed method “ ”

20150403 AP Readded method “ ”

20150520 AP Added queue for MOTD (465)

Use your personal credentials to access the api via a

To create a session with a JSON response, call the

You'll see that we passed in a few other variables besides our

For example, to get stats for a given player, call