v1

latestSwagger 2.02026-07-14307.8 KB

Halo 5 - Player Emblem Image

This Endpoint returns an HTTP Redirect (302 Found) response to the caller with the URL of an image of the Player's Emblem. 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 Emblem, 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 emblem component(s).

July 14, 2017:

  • Renamed Endpoint from "Halo 5 - Emblem Image" to "Halo 5 - Player Emblem Image".

February 21, 2017:

  • Renamed Endpoint from "Emblem Image" to "Halo 5 - Emblem Image".
  • Removed "{title}" Request Parameter.
get/h5/profiles/{player}/emblem

Path parameters

playerstring required

The Player's Gamertag.

Query parameters

sizenumber

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.