❤
npm
Sign UpSign In

@datafire/haloapi_stats

5.0.0 • Public • Published

@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

Retrieves detailed statistics for a Match with the Arena Game Mode.


Changelog

December 12, 2018:

  • Updated the documentation for "PlayerScore".

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.

February 21, 2017:

  • Renamed Endpoint from "Post-Game Carnage Report: Arena" to "Halo 5 - Match Result - Arena".
  • Removed "{title}" Request Parameter.
  • Updated the documentation for "GameVariantResourceId" and "MapVariantResourceId" to reference the UGC API.

May 16, 2016:

  • Documented HTTP 503 Response Code.
  • Added documentation for the "MatchSpeedWinAmount", "ObjectivesCompletedAmount", and "BoostData" fields.

April 20, 2016:

  • Added documentation for the "GameVariantResourceId", "MapVariantResourceId", and "PlayerScore" fields.
  • Updated the documentation for the "MapVariantId" and "GameVariantId" fields with the recommendation of using the "MapVariantResourceId" and "GameVariantResourceId" fields, respectively.
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

Retrieves detailed statistics for a Match with the Campaign Game Mode.

Every time a player plays a portion of a Campaign Mission, a Match will be generated whether the player finishes the Mission or not. If the "Match" ends because the Mission was completed, this will be indicated in the response.


Changelog

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.

February 21, 2017:

  • Renamed Endpoint from "Post-Game Carnage Report: Campaign" to "Halo 5 - Match Result - Campaign".
  • Removed "{title}" Request Parameter.

May 16, 2016:

  • Documented HTTP 503 Response Code.

April 20, 2016:

  • Added documentation for the "GameVariantResourceId", "MapVariantResourceId", and "PlayerScore" fields.
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

Retrieves information about the Company. The response will contain the Company's name, status, and members.


Changelog

July 14, 2017:

  • Added Endpoint.
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

Retrieves the commendation state for a Company.


Changelog

July 14, 2017:

  • Added Endpoint.
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

Retrieves detailed statistics for a Match with the Custom Game Mode. Games with the Custom Game Mode are played on Xbox Live Servers. For games played on Local Servers, use the "Halo 5 - Match Result - Custom Local" Endpoint.


Changelog

December 12, 2018:

  • Updated the documentation for "PlayerScore".

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.
  • Added documentation for "PresentInMatch".

February 21, 2017:

  • Renamed Endpoint from "Post-Game Carnage Report: Custom" to "Halo 5 - Match Result - Custom".
  • Removed "{title}" Request Parameter.
  • Updated the documentation for "GameVariantResourceId" and "MapVariantResourceId" to reference the UGC API.

May 16, 2016:

  • Documented HTTP 503 Response Code.

April 20, 2016:

  • Added documentation for the "GameVariantResourceId", "MapVariantResourceId", and "PlayerScore" fields.
  • Updated the documentation for the "MapVariantId" and "GameVariantId" fields with the recommendation of using the "MapVariantResourceId" and "GameVariantResourceId" fields, respectively.
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

Retrieves detailed statistics for a Match with the Custom Local Game Mode. Games with the Custom Local Game Mode are played on Local Servers. For games played on Xbox Live Servers, use the "Halo 5 - Match Result - Custom" Endpoint.


Changelog

December 12, 2018:

  • Updated the documentation for "PlayerScore".

December 22, 2017:

  • Added Endpoint.
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

Retrieves a set of Events related to the Match specified. Events are only available once the Match has completed.

The set of Events may grow over time as data becomes available.

This Endpoint does not have the accuracy guarantees of other Endpoints have, so please use with caution. This endpoint may not return Matches before December 1, 2015.


Changelog

February 21, 2017:

  • Renamed Endpoint from "Events for Match" to "Halo 5 - Match Events".
  • Removed "{title}" Request Parameter.

May 20, 2016:

  • The Endpoint now correctly reports the "Content-Type" Response Header as "application/json".

May 16, 2016:

  • Documented HTTP 503 Response Code.

April 20, 2016:

  • Added new types of events to the Endpoint: Impulses, Medals, Player Spawns, Round Stats, Round Ends, Weapon Drops, Weapon Pickups, and Weapon Pickup Pads.
  • Fixed an issue that caused the API to consistently return HTTP 500's for matches where a player left and rejoined the match.
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

Retrieves the Leaderboard for Player CSRs. The Leaderboard consists of the top Players with a CSR of 1800 or above for a given Playlist in a Season.


Changelog

March 6, 2018:

  • Fixed documentation typos for the names of the "Player" and "Gamertag" properties.

July 31, 2017:

  • Clarified documentation for which players are included in the leaderboard.

February 21, 2017:

  • Renamed Endpoint from "Player Leaderboard" to "Halo 5 - Leaderboard Player CSR".
  • Removed "{title}" Request Parameter.

April 20, 2016:

  • Added Endpoint.
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

Retrieves the commendation state for a Player.


Changelog

July 14, 2017:

  • Added Endpoint.
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

Retrieves a list of Matches that the Player has participated in and which have completed processing. If the Player is currently in a match, it is not returned in this API.

This endpoint will include games played on Local Servers with the Custom Local Game Mode for games that occurred or after December 22, 2017.


Changelog

February 1, 2019:

  • Enabled support for viewing the time component of the "MatchCompletedDate" via the "{include-times}" Request Parameter.

December 22, 2017:

  • Added support for the Custom Local Game mode.

February 21, 2017:

  • Renamed Endpoint from "Matches for Player" to "Halo 5 - Player Match History".
  • Removed "{title}" Request Parameter.

April 20, 2016:

  • Clarified documentation for the "MapVariant" and "GameVariant" fields.
  • Corrected "OwnerType" values for the "MapVariant" and "GameVariant" fields.
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

Retrieves Service Records for the Arena Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode.


Changelog

June 29, 2018:

  • Added support for Social (Unranked) Playlists.

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.

February 21, 2017:

  • Renamed Endpoint from "Service Record: Arena" to "Halo 5 - Player Service Records - Arena".
  • Removed "{title}" Request Parameter.

April 20, 2016:

  • Added documentation for the "CsrPercentile" field.
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

Retrieves Service Records for the Campaign Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode.


Changelog

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.

February 21, 2017:

  • Renamed Endpoint from "Service Record: Campaign" to "Halo 5 - Player Service Records - Campaign".
  • Removed "{title}" Request Parameter.
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

Retrieves Service Records for the Custom Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode. Games with the Custom Game Mode are played on Xbox Live Servers. For games played on Local Servers, use the "Halo 5 - Player Service Records - Custom Local" Endpoint.


Changelog

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.

February 21, 2017:

  • Renamed Endpoint from "Service Record: Custom" to "Halo 5 - Player Service Records - Custom".
  • Removed "{title}" Request Parameter.
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

Retrieves Service Records for the Custom Local Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode. Games with the Custom Local Game Mode are played on Local Servers. For games played on Xbox Live Servers, use the "Halo 5 - Player Service Records - Custom" Endpoint. A player's Custom Local Service Record summarizes games played on or after December 22, 2017.


Changelog

December 22, 2017:

  • Added Endpoint.
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

Retrieves Service Records for the Warzone Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode.


Changelog

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.

February 21, 2017:

  • Renamed Endpoint from "Service Record: Warzone" to "Halo 5 - Player Service Records - Warzone".
  • Removed "{title}" Request Parameter.
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

Retrieves detailed statistics for a Match with the Warzone Game Mode.


Changelog

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.

February 21, 2017:

  • Renamed Endpoint from "Post-Game Carnage Report: Warzone" to "Halo 5 - Match Result - Warzone".
  • Removed "{title}" Request Parameter.
  • Updated the documentation for "GameVariantResourceId" and "MapVariantResourceId" to reference the UGC API.

May 16, 2016:

  • Documented HTTP 503 Response Code.
  • Added documentation for the "MatchSpeedWinAmount", "ObjectivesCompletedAmount", and "BoostData" fields.

April 20, 2016:

  • Added documentation for the "GameVariantResourceId", "MapVariantResourceId", and "PlayerScore" fields.
  • Updated the documentation for the "MapVariantId" and "GameVariantId" fields with the recommendation of using the "MapVariantResourceId" and "GameVariantResourceId" fields, respectively.
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

Retrieves detailed statistics for a Match with the Custom Game Mode. Games with the Custom Game Mode are played on Xbox Live Servers. For games played on Local Servers, use the "Halo 5 - Match Result - Custom Local" Endpoint.


Changelog

December 12, 2018:

  • Updated the documentation for "PlayerScore".

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.
  • Added documentation for "PresentInMatch".

February 21, 2017:

  • Renamed Endpoint from "Post-Game Carnage Report: Custom" to "Halo 5 - Match Result - Custom".
  • Removed "{title}" Request Parameter.
  • Updated the documentation for "GameVariantResourceId" and "MapVariantResourceId" to reference the UGC API.

May 16, 2016:

  • Documented HTTP 503 Response Code.

April 20, 2016:

  • Added documentation for the "GameVariantResourceId", "MapVariantResourceId", and "PlayerScore" fields.
  • Updated the documentation for the "MapVariantId" and "GameVariantId" fields with the recommendation of using the "MapVariantResourceId" and "GameVariantResourceId" fields, respectively.
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

Retrieves a list of Matches that the Player has participated in and which have completed processing. If the Player is currently in a match, it is not returned in this API.

This endpoint will include games played on Local Servers with the Custom Local Game Mode for games that occurred or after December 22, 2017.


Changelog

February 1, 2019:

  • Enabled support for viewing the time component of the "MatchCompletedDate" via the "{include-times}" Request Parameter.

December 22, 2017:

  • Added support for the Custom Local Game mode.

February 21, 2017:

  • Renamed Endpoint from "Matches for Player" to "Halo 5 - Player Match History".
  • Removed "{title}" Request Parameter.

April 20, 2016:

  • Clarified documentation for the "MapVariant" and "GameVariant" fields.
  • Corrected "OwnerType" values for the "MapVariant" and "GameVariant" fields.
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

Retrieves Service Records for the Custom Game Mode for one or more players. A Service Record contains a player's lifetime statistics in the Game Mode. Games with the Custom Game Mode are played on Xbox Live Servers. For games played on Local Servers, use the "Halo 5 - Player Service Records - Custom Local" Endpoint.


Changelog

December 22, 2017:

  • Added Game Mode clarifications to the Endpoint description.

February 21, 2017:

  • Renamed Endpoint from "Service Record: Custom" to "Halo 5 - Player Service Records - Custom".
  • Removed "{title}" Request Parameter.
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

Retrieves detailed statistics for a Match. Matches can be retrieved before they are completed; however, the data for in-progress Matches is only updated every few minutes.


Changelog

September 5, 2017:

  • Documented new game mode "Terminus Firefight".

February 21, 2017:

  • Added Endpoint.
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

Retrieves a set of Events related to the Match specified. Events are only available once the Match has completed. Events are not available for Matches played with the Custom Match Type.

The set of Events may grow over time as data becomes available.


Changelog

September 5, 2017:

  • Documented new game mode "Terminus Firefight".

February 21, 2017:

  • Added Endpoint.
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

Retrieves the Leaderboard for Player CSRs. The Leaderboard consists of the top Players with a CSR of 1800 or above for a given Playlist in a Season.


Changelog

March 6, 2018:

  • Fixed documentation typos for the names of the "Player" and "Gamertag" properties.

July 31, 2017:

  • Clarified documentation for which players are included in the leaderboard.

July 14, 2017:

  • Added Endpoint.
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

Retrieves the Campaign Progress state for a Player.


Changelog

February 21, 2017:

  • Added Endpoint.
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

Retrieves a list of Matches that the Player has participated in. If the Player is currently in a Match, it is not returned in this API.


Changelog

September 5, 2017:

  • Documented new game mode "Terminus Firefight".

February 21, 2017:

  • Added Endpoint.
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

Retrieves high-level aggregations across the lifetime of a Player.


Changelog

September 5, 2017:

  • Added additional fields: "GameMode" and "HighestObjectiveScoreByTeamSize".
  • Documented new game mode "Terminus Firefight".

February 21, 2017:

  • Added Endpoint.
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

Retrieves high-level aggregations across a Season for a Player.


Changelog

September 5, 2017:

  • Added additional pivots of data: "CustomModeStats", "SinglePlayerModeStats", "MultiplayerModeStats", "SocialModeStats", and "RankedModeStats".
  • Added additional fields to the "Summary" contract: "GameMode" and "HighestObjectiveScoreByTeamSize".
  • Documented new game mode "Terminus Firefight".

February 21, 2017:

  • Added Endpoint.
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

Retrieves Playlist Ratings in the current season for one or more Players.


Changelog

February 21, 2017:

  • Added Endpoint.
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

Retrieves XP and Rank information for one or more players.


Changelog

February 21, 2017:

  • Added Endpoint.
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

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/haloapi_stats

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

1

Version

5.0.0

License

MIT

Unpacked Size

300 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware