@datafire/haloapi_stats

Client library for Stats

Installation and Usage

npm install --save @datafire/haloapi_stats

let haloapi_stats = require('@datafire/haloapi_stats').create({
  apiKeyHeader: "",
  apiKeyQuery: ""
});

.then(data => {
  console.log(data);
});

Description

API that provides statistical data about Players and Matches.

Actions

h5.arena.matches.matchId.get

haloapi_stats.h5.arena.matches.matchId.get({
  "matchId": ""
}, context)

Input

• input object
  • matchId required string: An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint.

Output

Output schema unknown

h5.campaign.matches.matchId.get

haloapi_stats.h5.campaign.matches.matchId.get({
  "matchId": ""
}, context)

Input

• input object
  • matchId required string: An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint.

Output

Output schema unknown

h5.companies.companyId.get

haloapi_stats.h5.companies.companyId.get({
  "companyId": ""
}, context)

Input

• input object
  • companyId required string: The ID for the Company. The Company ID for a player can be retrieved from the Profile APIs via the "Halo 5 - Player Apperance" Endpoint.

Output

Output schema unknown

h5.companies.companyId.commendations.get

haloapi_stats.h5.companies.companyId.commendations.get({
  "companyId": ""
}, context)

Input

• input object
  • companyId required string: The ID for the Company. The Company ID for a player can be retrieved from the Profile APIs via the "Halo 5 - Player Apperance" Endpoint.

Output

Output schema unknown

h5.custom.matches.matchId.get

haloapi_stats.h5.custom.matches.matchId.get({
  "matchId": ""
}, context)

Input

• input object
  • matchId required string: An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint.

Output

Output schema unknown

h5.customlocal.matches.matchId.get

haloapi_stats.h5.customlocal.matches.matchId.get({
  "matchId": ""
}, context)

Input

• input object
  • matchId required string: An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint.

Output

Output schema unknown

h5.matches.matchId.events.get

haloapi_stats.h5.matches.matchId.events.get({
  "matchId": ""
}, context)

Input

• input object
  • matchId required string: An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint.

Output

Output schema unknown

h5.player_leaderboards.csr.seasonId.playlistId.get

haloapi_stats.h5.player_leaderboards.csr.seasonId.playlistId.get({
  "seasonId": "",
  "playlistId": ""
}, context)

Input

• input object
  • seasonId required string: The ID for the Season.
  • playlistId required string: The ID for the Playlist.
  • count number: When specified, this indicates the maximum quantity of items the client would like returned in the response.

Output

Output schema unknown

h5.players.player.commendations.get

haloapi_stats.h5.players.player.commendations.get({
  "player": ""
}, context)

Input

• input object
  • player required string: The Player's Gamertag.

Output

Output schema unknown

h5.players.player.matches.get

haloapi_stats.h5.players.player.matches.get({
  "player": ""
}, context)

Input

• input object
  • player required string: The Player's Gamertag.
  • modes string: Indicates what Game Mode(s) the client is interested in getting Matches for (arena, campaign, custom, customlocal, or warzone).
  • start number: When specified, this indicates the starting index (0-based) for which the batch of results will begin at. For example, "start=0" indicates that the first qualifying result will be returned, no items are 'skipped'. Passing "start=10" indicates that the result will begin with the 11th item, the first 10 will be 'skipped'.
  • count number: When specified, this indicates the maximum quantity of items the client would like returned in the response.
  • include-times boolean: When set to "true", this indicates that the time component of the "MatchCompletedDate" field should be populated.

Output

Output schema unknown

h5.servicerecords.arena.get

haloapi_stats.h5.servicerecords.arena.get({
  "players": ""
}, context)

Input

• input object
  • players required string: A comma-separated list of Gamertags. Up to 32 Gamertags may be specified.
  • seasonId string: When specified, this indicates the Season to request the Arena Playlist Stats for. If this is not specified, the default is the current Season. Seasons are available via the Metadata API. Social (Unranked) Arena Playlist Stats can be retrieved by specifying "NonSeasonal".

Output

Output schema unknown

h5.servicerecords.campaign.get

haloapi_stats.h5.servicerecords.campaign.get({
  "players": ""
}, context)

Input

• input object
  • players required string: A comma-separated list of Gamertags. Up to 32 Gamertags may be specified.

Output

Output schema unknown

h5.servicerecords.custom.get

haloapi_stats.h5.servicerecords.custom.get({
  "players": ""
}, context)

Input

• input object
  • players required string: A comma-separated list of Gamertags. Up to 32 Gamertags may be specified.

Output

Output schema unknown

h5.servicerecords.customlocal.get

haloapi_stats.h5.servicerecords.customlocal.get({
  "players": ""
}, context)

Input

• input object
  • players required string: A comma-separated list of Gamertags. Up to 32 Gamertags may be specified.

Output

Output schema unknown

h5.servicerecords.warzone.get

haloapi_stats.h5.servicerecords.warzone.get({
  "players": ""
}, context)

Input

• input object
  • players required string: A comma-separated list of Gamertags. Up to 32 Gamertags may be specified.

Output

Output schema unknown

h5.warzone.matches.matchId.get

haloapi_stats.h5.warzone.matches.matchId.get({
  "matchId": ""
}, context)

Input

• input object
  • matchId required string: An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 - Player Match History" Endpoint.

Output

Output schema unknown

h5pc.custom.matches.matchId.get

haloapi_stats.h5pc.custom.matches.matchId.get({
  "matchId": ""
}, context)

Input

• input object
  • matchId required string: An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo 5 PC - Player Match History" Endpoint.

Output

Output schema unknown

h5pc.players.player.matches.get

haloapi_stats.h5pc.players.player.matches.get({
  "player": ""
}, context)

Input

• input object
  • player required string: The Player's Gamertag.
  • modes string: Indicates what Game Mode(s) the client is interested in getting Matches for (arena, campaign, custom, or warzone).
  • start number: When specified, this indicates the starting index (0-based) for which the batch of results will begin at. For example, "start=0" indicates that the first qualifying result will be returned, no items are 'skipped'. Passing "start=10" indicates that the result will begin with the 11th item, the first 10 will be 'skipped'.
  • count number: When specified, this indicates the maximum quantity of items the client would like returned in the response.
  • include-times boolean: When set to "true", this indicates that the time component of the "MatchCompletedDate" field should be populated.

Output

Output schema unknown

h5pc.servicerecords.custom.get

haloapi_stats.h5pc.servicerecords.custom.get({
  "players": ""
}, context)

Input

• input object
  • players required string: A comma-separated list of Gamertags. Up to 32 Gamertags may be specified.

Output

Output schema unknown

hw2.matches.matchId.get

haloapi_stats.hw2.matches.matchId.get({
  "matchId": ""
}, context)

Input

• input object
  • matchId required string: An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo Wars 2 - Player Match History" Endpoint.

Output

Output schema unknown

hw2.matches.matchId.events.get

haloapi_stats.hw2.matches.matchId.events.get({
  "matchId": ""
}, context)

Input

• input object
  • matchId required string: An ID that uniquely identifies a Match. Match IDs can be retrieved from the "Halo Wars 2 - Player Match History" Endpoint.

Output

Output schema unknown

hw2.player_leaderboards.csr.seasonId.playlistId.get

haloapi_stats.hw2.player_leaderboards.csr.seasonId.playlistId.get({
  "seasonId": "",
  "playlistId": ""
}, context)

Input

• input object
  • seasonId required string: The ID for the Season.
  • playlistId required string: The ID for the Playlist.
  • count number: When specified, this indicates the maximum quantity of items the client would like returned in the response.

Output

Output schema unknown

hw2.players.player.campaign_progress.get

haloapi_stats.hw2.players.player.campaign_progress.get({
  "player": ""
}, context)

Input

• input object
  • player required string: The Player's Gamertag.

Output

Output schema unknown

hw2.players.player.matches.get

haloapi_stats.hw2.players.player.matches.get({
  "player": ""
}, context)

Input

• input object
  • player required string: The Player's Gamertag.
  • matchType string: Indicates what Match Type the client is interested in getting Matches for ("custom" or "matchmaking").
  • start number: When specified, this indicates the starting index (0-based) for which the batch of results will begin at. For example, "start=0" indicates that the first qualifying result will be returned, no items are 'skipped'. Passing "start=10" indicates that the result will begin with the 11th item, the first 10 will be 'skipped'.
  • count number: When specified, this indicates the maximum quantity of items the client would like returned in the response.

Output

Output schema unknown

hw2.players.player.stats.get

haloapi_stats.hw2.players.player.stats.get({
  "player": ""
}, context)

Input

• input object
  • player required string: The Player's Gamertag.

Output

Output schema unknown

hw2.players.player.stats.seasons.seasonId.get

haloapi_stats.hw2.players.player.stats.seasons.seasonId.get({
  "player": "",
  "seasonId": ""
}, context)

Input

• input object
  • player required string: The Player's Gamertag.
  • seasonId required string: A Season ID or "current" for the current Season. Seasons are available via the Metadata API.

Output

Output schema unknown

hw2.playlist.playlistId.rating.get

haloapi_stats.hw2.playlist.playlistId.rating.get({
  "playlistId": "",
  "players": ""
}, context)

Input

• input object
  • playlistId required string: The ID of the Playlist to get Ratings for.
  • players required string: A comma-separated list of Gamertags. Up to 6 Gamertags may be specified.

Output

Output schema unknown

hw2.xp.get

haloapi_stats.hw2.xp.get({
  "players": ""
}, context)

Input

• input object
  • players required string: A comma-separated list of Gamertags. Up to 6 Gamertags may be specified.

Output

Output schema unknown

Definitions

This integration has no definitions