PlayHive API Updates

Technical updates for the PlayHive REST API

PlayHive API Updates

SkyWars Classic API

SkyWars Classic shares XP (level progression) with SkyWars, but has separate statistics for games played, victories, kills, et cetera. These will be available on the API in the near future.

Parkour Worlds API endpoint

Parkour Worlds data is available under the all-time PARKOUR endpoint:

v0/game/all/parkour/username

The 'parkours' array exists for players that have played at least one course in any world. The structure is world name -> course name -> data.

Worlds will only exist if the player has played at least one course in that world. Once a player has played one course, all courses will be initialized: the 'best_run_time' can be null if a player has never played or finished the individual course. The arrays can be empty.

Note that 'best_checkpoint_times' is updated outside of the context of a run: that is, the times can be from different runs. 'best_run_time' is the best overall run, so not equal to the combined values of 'best_checkpoint_times'.

All (run) times are stored in server ticks. Hive runs at 20TPS, so one tick is 50MS.

Star counts are provided at course, world and global level.

Stale maps data, all-time leaderboard parity, additional SG statistics, equipped hat

We fixed an issue where the maps endpoints was returning stale (outdated) information.

The returned amount of entries for all-time leaderboards is now 100, to match in-game.

Added 'teleporters_used', 'launchpads_used' and 'flares_used' to Survival Games. These fields will fill correctly for single-user requests, but will return 0 when part of a leaderboard lookup, until that player has played at least one game since this change.

The hat a player has equipped is now listed as equipped_hat on the 'main' endpoint.

Dynamic hub titles additions and fixes

Meta-reference hub titles now correctly resolve when hub titles are returned as a map.

For multi-key stat-track hub titles, where the operation is divide, the style is now declared. For now, this is one of: percent or dot. Additionally, hub titles with the percent style now resolve correctly like this, as they do in-game.

Meta-Reference hub titles, seasonal leaderboards

Meta-reference hub titles (hub titles that use a player-specific, but immutable piece of data) are now resolved correctly by the API. As these titles are static per-player, they show up as normal titles on the API (and are always fully resolved).

As we work towards a unified codebase, the code expanding dynamic hub titles differs between the API and in-game. Because of this, at times there might be a difference in display values: we do consider these bugs, and will fix them as they are discovered.

Leaderboards for seasons are now available. They are very similar to monthly ones, both whole leaderboard and specific entry endpoints are available. As seasons run longer than monthly leaderboards, you can request more data than monthly ones: up to 1000 in (at most) 100 increments.

In the future, as more seasons are released, we will add an endpoint to get the season information for games: for now, only 'bed' season '1' exists.

Changes to Hub Titles now available

The previously announced changes to hub titles are now available, by opting in using the specified headers.

As we keep expanding hub titles, the header to fully resolve hub titles has been formally renamed to:

X-Hive-Resolve-Dynamic-Hub-Titles

That said, the previously announced X-Hive-Resolve-Stat-Track functions identically.

Minor adjustments to WARS special leaderboard

Before Treasure Wars rewards are given out, we are removing a small set of players that are ineligible for rewards given their account status.

This will lead to a small adjustment of the final position of players, and in some cases, place them in a different (better) tier.

Great! You’ve successfully signed up.

Welcome back! You've successfully signed in.

You've successfully subscribed to PlayHive API Updates.

Success! Check your email for magic link to sign-in.

Success! Your billing info has been updated.

Your billing was not updated.