Nexus Compendium API
With great data comes great responsibility... or something like that. In either case, I felt it was a good idea to have the option open for a different approach, to use for other projects, like in Replay- and other data-analysis. So far, the following is available:
Currently in the Nexus
Inspired by the Currently in the Nexus page, this will give the exact same content, with the ability to pull specific subsets, via the following options, separated with +:
weekly - Returns Hero Rotation and Sales
sales - Returns Sales
herorotation - Returns Hero Rotations
bgrotation - Returns Battleground Rotations
rotations - Returns Hero and Battleground Rotations
event - Returns Event
ranked - Returns Ranked Season
The request https://nexuscompendium.com/api/currently[/DELIMITORS] yields the following:
- RotationHero
- Heroes[]
- ID, Name, ReqLevel, URL, ImageURL
- StartDate, EndDate, Timespan, AllHeroesFree, URL
- RotationBattleground
- Ranked
- Battlegrounds[]
- LastChanged, URL
- Unranked
- Battlegrounds[]
- LastChanged, URL
- ARAM
- Battlegrounds[]
- LastChanged, URL
- Sale
- Heroes[]
- ID, Name, GemPrice, GemPriceNormal, URL, ImageURL
- Skins[]
- ID, TintID, Name, URL, ImageURL
- Mounts[]
- ID, TintID, Name, URL, ImageURL
- SkinsLimited[]
- ID, TintID, Name, StartDate, EndDate, GoldPrice, GemPrice, URL, ImageURL
- MountsLimited[]
- ID, TintID, Name, StartDate, EndDate, GoldPrice, GemPrice, URL, ImageURL
- StartDate, EndDate, Timespan, BoostDiscount, URL
- Event
- ID, Name, Description, Type, StartDate, EndDate, Timespan, ChestName, URL, ImageURL
- Seasonal[]
- Ranked
- ID, Name, StartDate, EndDate, Timespan, URL
List One / List All
A handy way of listing a single instance of a data type - or all of them! The request requires the following parameter(s), and always yields a list:
TYPE - Type of the request: events, heroes, heroprices or ranked (more to come)
ID - ID for the given TYPE (for LISTONE ) or LISTALL
- For events, use the respectful EventID - single element list for
LISTONE
- For heroes, use the respectful HeroID - single element list for
LISTONE
- For heroprices, use the respectful HeroID - list limited by ID (HeroID) for
LISTONE
- For ranked, use the respectful SeasonID - single element list for
LISTONE
The requests https://nexuscompendium.com/api/TYPE/ID yields the following:
- Events[]
- ID, Name, Description, Type, StartDate, EndDate, Timespan, ChestName, URL, ImageURL
- Seasonal[]
- HeroPrices[]
- ID, Name, URL, ImageURL
- Prices[]
- WeekDate, GoldPrice, GoldPricePrev, GemPrice, GemPricePrev, URL
- Ranked[]
- ID, Name, StartDate, EndDate, Timespan, URL
Internal IDs
This gives a way to extract some of the Skin-, Mount- and Banner-data based on the client's Internal IDs, primarily used in Replays. The request requires two parameters:
TYPE - Type of the item: skin, mount or banner
ID - The Internal ID of the item, found on the page in the format LiLiShadowpawVar2
The request https://nexuscompendium.com/api/internalid/TYPE/ID yields the following:
- ID
- ItemID, TintID, InternalID
- Name
- URL
- ImageURL
- Description
- Details
- Rarity
- Type
- Released
- Event
- Seasonal
- URL
- ImageURL
Any Requests?
If there's any specific data you could use, feel free to reach out on Reddit (Gnueless).
|