NGS Games Upload Endpoint


This endpoint is used for uploading NGS replays to Heroes Profile. Only approved accounts may use this endpoint. The following attributes are returned.

{
  "url": "url",
  "Team 1": {
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>",
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>",
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>",
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>",
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>"
  },
  "Team 2": {
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>",
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>",
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>",
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>",
    "player Profile": "https://www.heroesprofile.com/NGS/Profile/<player>"
  }
}

Example Usage

{warning} All API calls require an api_token as part of the query string and are prefixed by https://api.heroesprofile.com/api

Method URI Headers
POST NGS/Games/Upload/ Default
GET NGS/Games/Upload/ Default

Data Parameters (required)

{
  mode: dev or prod.  dev for development and prod for production.

  season: NGS season the replay was played in.

  division: NGS division for the replay.

  replay_url: AWS, public S3 storage location url for replay.

  round: which NGS round.

  game: Of the round (set) which game.  So if a set went to 3 games. 1, 2, or 3rd game of the set.

  team_one_name: Team name for the first team.

  team_one_player: Battletag for a player in the game for Team one.

  team_one_map_ban_1: Full map name for Team one's first map ban

  team_one_map_ban_2: Full map name for Team one's second map ban

  team_one_image_url: Team one's icon

  team_two_name: Team name for the first team.

  team_two_player: Battletag for a player in the game for Team two.

  team_two_map_ban_1: Full map name for Team two's first map ban

  team_two_map_ban_2: Full map name for Team two's second map ban

  team_two_image_url: Team two's icon
}

Error/Replay Issue Returns

If a replay fails to upload:  String Returned:  "Replay did not save, unknown issue"
If a replay does not contain a player passed as a parameter:  String Returned:  "Invalid parameter. A player provided was not in the game"
If a replay is not game mode Custom:  String Returned:  "Game mode is not custom.  Invalid replay sent"

Example Return

{
  "url": "https://www.heroesprofile.com/NGS/Match/Single/?replayID=2",
  "Team Training Wheels": {
    "chaoticorder#1455 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=5077983&battletag=chaoticorder",
    "DoomElite#1999 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=566669&battletag=DoomElite",
    "WhoDoYoThink#1394 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=13355&battletag=WhoDoYoThink",
    "Riokaii#1935 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=5387400&battletag=Riokaii",
    "Fade#12545 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=5744936&battletag=Fade"
  },
  "RewinD": {
    "Confused#1902 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=2087199&battletag=Confused",
    "TACOCAT#11328 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=6322580&battletag=TACOCAT",
    "LiLKillrPwny#11514 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=1161889&battletag=LiLKillrPwny",
    "Zemill#1940 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=67280&battletag=Zemill",
    "LFTporkcchop#1392 Profile": "https://www.heroesprofile.com/NGS/Profile/?region=1&blizz_id=563970&battletag=LFTporkcchop"
  }
}