Heroes Index (1.0.0)

Download OpenAPI specification:Download

Istastech support: support@istastech.com License: Apache 2.0

The HeroesIndex api provides access to JSON data output from heroes-parser. heroes-parser extacts Hero and Mount data from Heroes of the Storm game data and converts it to JSON.

Assets

All images referenced by JSON output are converted to the PNG image format and are accessable at assets.heroesindex.com. They are organized by version build number assets.heroesindex.com/{buildNumber}/{assetPath}.png

Source XML and Text

The source xml and text used by heroes-parser are stored in a zip file accessable at assets.heroesindex.com. They are also organized by version build number assets.heroesindex.com/{buildNumber}/source.zip

List realms

Returns a list of available realms

header Parameters

Origin

required

string

Provides the origin of the request. Required to support CORS.

Responses

200

List of available realms

get /

Production server

api.heroesindex.com/v1/

Response samples

application/json

Copy

Expand all Collapse all

{

"realms":
[
- "string"
]

}

List versions for realm

Returns a list of versions for this realm

path Parameters

realm

required

string

Heroes of the Storm realm. Either 'live' or 'ptr'

header Parameters

Origin

required

string

Provides the origin of the request. Required to support CORS.

Responses

200

List of versions

404

404 not found error

get /{realm}

Production server

api.heroesindex.com/v1/{realm}

Response samples

application/json

Copy

Expand all Collapse all

{

"versions":
{
- "buildNumber": 0,
- "name": "string",
- "versionNumber": "string",
- "releaseDate": "2018-07-09",
- "realm": "string"
}

}

Get version details

Returns detailed information about the specifed version. Includes a lists of available heroes and mounts

path Parameters

realm required	string Heroes of the Storm realm. Either 'live' or 'ptr'
buildNumber required	string Build number of the desired version

header Parameters

Origin

required

string

Provides the origin of the request. Required to support CORS.

Responses

200

Version detail

404

404 not found error

get /{realm}/{buildNumber}

Production server

api.heroesindex.com/v1/{realm}/{buildNumber}

Response samples

application/json

Copy

Expand all Collapse all

{

"buildNumber": 0,
"name": "string",
"versionNumber": "string",
"releaseDate": "2018-07-09",
"realm": "string",
"heroes":
[
- {
  - "id": "string",
  - "name": "string",
  - "icon": "string",
  - "universe": "string",
  - "role": "string",
  - "title": "string",
  - "description": "string"
  }
],
"mounts":
[
- {
  - "id": "string",
  - "name": "string",
  - "description": "string",
  - "rarity": "string",
  - "category": "string"
  }
]

}

List heroes for version

Returns a list of heroes in the specifed version

path Parameters

realm required	string Heroes of the Storm realm. Either 'live' or 'ptr'
buildNumber required	string Build number of the desired version

header Parameters

Origin

required

string

Provides the origin of the request. Required to support CORS.

Responses

200

List of Heroes

404

404 not found error

get /{realm}/{buildNumber}/heroes

Production server

api.heroesindex.com/v1/{realm}/{buildNumber}/heroes

Response samples

application/json

Copy

Expand all Collapse all

{

"profiles":
[
- "string"
],
"heroes":
[
- {
  - "id": "string",
  - "name": "string",
  - "icon": "string",
  - "universe": "string",
  - "role": "string",
  - "title": "string",
  - "description": "string"
  }
]

}

Basic hero JSON

Returns hero JSON for 'basic' profile

path Parameters

realm required	string Heroes of the Storm realm. Either 'live' or 'ptr'
buildNumber required	string Build number of the desired version
id required	string

header Parameters

Origin

required

string

Provides the origin of the request. Required to support CORS.

Responses

200

Hero JSON

404

404 not found error

get /{realm}/{buildNumber}/heroes/{id}

Production server

api.heroesindex.com/v1/{realm}/{buildNumber}/heroes/{id}

Response samples

application/json

Copy

Expand all Collapse all

{ }

Hero JSON for profile

Returns hero JSON for profile

path Parameters

realm required	string Heroes of the Storm realm. Either 'live' or 'ptr'
buildNumber required	string Build number of the desired version
id required	string
profile required	string JSON profile type. Currently allowed values are 'basic', 'skins', 'vo', and 'detailed'

header Parameters

Origin

required

string

Provides the origin of the request. Required to support CORS.

Responses

200

Hero JSON

404

404 not found error

get /{realm}/{buildNumber}/heroes/{id}/{profile}

Production server

api.heroesindex.com/v1/{realm}/{buildNumber}/heroes/{id}/{profile}

Response samples

application/json

Copy

Expand all Collapse all

{ }

List mounts for version

Returns a list of mounts in the specifed version

path Parameters

realm required	string Heroes of the Storm realm. Either 'live' or 'ptr'
buildNumber required	string Build number of the desired version

header Parameters

Origin

required

string

Provides the origin of the request. Required to support CORS.

Responses

200

List of Mounts

404

404 not found error

get /{realm}/{buildNumber}/mounts/

Production server

api.heroesindex.com/v1/{realm}/{buildNumber}/mounts/

Response samples

application/json

Copy

Expand all Collapse all

{

"profiles":
[
- "string"
],
"heroes":
[
- {
  - "id": "string",
  - "name": "string",
  - "description": "string",
  - "rarity": "string",
  - "category": "string"
  }
]

}

Basic mount JSON

Returns mount JSON for 'basic' profile

path Parameters

realm required	string Heroes of the Storm realm. Either 'live' or 'ptr'
buildNumber required	string Build number of the desired version
id required	string

header Parameters

Origin

required

string

Provides the origin of the request. Required to support CORS.

Responses

200

Mount JSON

404

404 not found error

get /{realm}/{buildNumber}/mounts/{id}

Production server

api.heroesindex.com/v1/{realm}/{buildNumber}/mounts/{id}

Response samples

application/json

Copy

Expand all Collapse all

{ }

Mount JSON for profile

Returns mount JSON for profile

path Parameters

realm required	string Heroes of the Storm realm. Either 'live' or 'ptr'
buildNumber required	string Build number of the desired version
id required	string
profile required	string JSON profile type. Currently allowed values are 'basic', 'skins', 'vo', and 'detailed'

header Parameters

Origin

required

string

Provides the origin of the request. Required to support CORS.

Responses

200

Mount JSON

404

404 not found error

get /{realm}/{buildNumber}/mounts/{id}/{profile}

Production server

api.heroesindex.com/v1/{realm}/{buildNumber}/mounts/{id}/{profile}

Response samples

application/json

Copy

Expand all Collapse all

{ }