@datafire/haloapi_profile

Client library for Profile

Installation and Usage

npm install --save @datafire/haloapi_profile

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

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

Description

API that provides Profile information about Players.

Actions

h5.profiles.player.appearance.get

haloapi_profile.h5.profiles.player.appearance.get({
  "player": ""
}, context)

Input

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

Output

Output schema unknown

h5.profiles.player.emblem.get

haloapi_profile.h5.profiles.player.emblem.get({
  "player": ""
}, context)

Input

• input object
  • player required string: The Player's Gamertag.
  • size number: An optional size (specified in pixels) of the image requested. When specified, this value must be one of the following values: 95, 128, 190, 256, 512. If a value is specified that is not in this list, the API returns HTTP 400 ("Bad Request"). If the size is empty or missing, the API will use 256.

Output

Output schema unknown

h5.profiles.player.spartan.get

haloapi_profile.h5.profiles.player.spartan.get({
  "player": ""
}, context)

Input

• input object
  • player required string: The Player's Gamertag.
  • size number: An optional size (specified in pixels) of the image requested. When specified, this value must be one of the following values: 95, 128, 190, 256, 512. If a value is specified that is not in this list, the API returns HTTP 400 ("Bad Request"). If the size is empty or missing, the API will use 256.
  • crop string: An optional crop that will be used to determine what portion of the Spartan is returned in the image. The value must be either "full" or "portrait". If no value is specified "full" is used. If an unsupported value is provided, the API returns HTTP 400 ("Bad Request").

Output

Output schema unknown

Definitions

This integration has no definitions