v1
latestSwagger 2.02026-07-14307.8 KBHalo 5 - Player Spartan Image
This Endpoint returns an HTTP Redirect (302 Found) response to the caller with the URL of an image of the Player's Spartan's appearance. The initial request to this API that returns the HTTP Redirect is throttled and requires a Subscription Key. However, the image itself (at hostname "image.halocdn.com") is not throttled and does not require a Subscription Key. Note that if the Player later changes their Spartan's appearance, the image itself is not refreshed and will need to be refreshed via a new request to this API.
Changelog
August 12, 2019:
- Expanded documentation for the HTTP 400 response code to cover unsupported armor component(s).
July 14, 2017:
- Renamed Endpoint from "Halo 5 - Spartan Image" to "Halo 5 - Player Spartan Image".
February 21, 2017:
- Renamed Endpoint from "Spartan Image" to "Halo 5 - Spartan Image".
- Removed "{title}" Request Parameter.
Path parameters
The Player's Gamertag.
Query parameters
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.
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").