Documentation

Class: h5/stats

h5/stats

new h5/stats()

Creates a metadata object

Members

_http

Initializes a new HttpWrapper with API Key

Methods

matchEvents(matchID)

Returns Match Events.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Match-Events?
Parameters:
Name Type Description
matchID string Match ID
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.matchEvents("matchID").then( (results) => {
  //Do code here
});

matchResultArena(matchID)

Returns Match Result Arena.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Match-Result-Arena?
Parameters:
Name Type Description
matchID string Match ID
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.matchResultArena("matchID").then( (results) => {
  //Do code here
});

matchResultCampaign(matchID)

Returns Match Result Campaign.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Match-Result-Campaign?
Parameters:
Name Type Description
matchID string Match ID
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.matchResultCampaign("matchID").then( (results) => {
  //Do code here
});

matchResultCustom(matchID)

Returns Match Result Custom.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Match-Result-Custom?
Parameters:
Name Type Description
matchID string Match ID
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.matchResultCustom("matchID").then( (results) => {
  //Do code here
});

matchResultCustomPC(matchID)

Returns PC - Match Result - Custom.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-PC-Match-Result-Custom?
Parameters:
Name Type Description
matchID string Match ID
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.matchResultCustomPC("matchID").then( (records) => {
  //Do code here
});

matchResultWarzone(matchID)

Returns Match Result Warzone.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Match-Result-Warzone?
Parameters:
Name Type Description
matchID string Match ID
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.matchResultWarzone("matchID").then( (results) => {
  //Do code here
});

playerCSR(seasonID, playlistID, count)

Returns Leaderboard for Player CSR.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Leaderboard-Player-CSR?
Parameters:
Name Type Description
seasonID string Season ID
playlistID string Playlist ID
count number Count (default 200)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.playerCSR("seasonID", "playlistID").then( (results) => {
  //Do code here
});

playerMatchHistory(player, modes, start, count)

Returns Player Match History.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Player-Match-History?
Parameters:
Name Type Description
player string Gamertag of Player
modes string Modes (arena, campaign, custom, or warzone) Comma separated. (default all)
start number Start index (default 0)
count number Count (default 25)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.playerMatchHistory ("matchID").then( (results) => {
  //Do code here
});

playerMatchHistoryPC(player, modes, start, count)

Returns PC - Player Match History.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-PC-Player-Match-History?
Parameters:
Name Type Description
player string Players Gamertags
modes string Modes (arena, campaign, custom, or warzone) (default all) Comma separated
start number Start index (default 0)
count number Count (default 25)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.playerMatchHistoryPC("MAX1MUM D3ATH").then( (matches) => {
  //Do code here
});

playerServiceRecordsArena(player, seasonID)

Returns Player Service Records - Arena.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Player-Service-Records-Arena?
Parameters:
Name Type Description
player string Gamertags of players (comma separated)
seasonID string Season ID (default current season)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.playerServiceRecordsArena("MAX1MUM D3ATH").then( (records) => {
  //Do code here
});

playerServiceRecordsCampaign(player)

Returns Player Service Records - Campaign.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Player-Service-Records-Campaign?
Parameters:
Name Type Description
player string Gamertags of players (comma separated)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.playerServiceRecordsCampaign("MAX1MUM D3ATH").then( (records) => {
  //Do code here
});

playerServiceRecordsCustom(player)

Returns Player Service Records - Custom.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Player-Service-Records-Custom?
Parameters:
Name Type Description
player string Gamertags of players (comma separated)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.playerServiceRecordsCustom("MAX1MUM D3ATH").then( (records) => {
  //Do code here
});

playerServiceRecordsPC(players)

Returns PC - Player Service Records - Custom.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-PC-Player-Service-Records-Custom?
Parameters:
Name Type Description
players string Players Gamertags (comma separated)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.playerServiceRecordsPC("MAX1MUM D3ATH").then( (matches) => {
  //Do code here
});

playerServiceRecordsWarzone(player)

Returns Player Service Records - Warzone.
https://developer.haloapi.com/docs/services/58acdf27e2f7f71ad0dad84b/operations/Halo-5-Player-Service-Records-Warzone?
Parameters:
Name Type Description
player string Gamertags of players (comma separated)
Returns:
Promise of JSON from API
Type
Promise
Example
halo.h5.stats.playerServiceRecordsWarzone("MAX1MUM D3ATH").then( (records) => {
  //Do code here
});