Get a player's monthly statistics.
Parameter | Type | Required | Description |
---|---|---|---|
identifier | string |
Required | The player's gamertag or UUID of which to get stats for |
game | Game |
optional | The game identifier - see Game. When not specified, will return all games |
options | object |
optional | Options is an object with the fields below: |
options.year | number |
optional | The year from which to get stats |
options.month | number |
optional | The month from which to get stats |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
Returns a Promise which resolves to the following object:
Field | Type | Description |
---|---|---|
data | Response | null |
The response data |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
import { getMonthlyStatsistics, Game } from "hive-bedrock-api";
// Get player's Treasure Wars stats from June 2023
const { data, error } = await getMonthlyStatsistics(
"player",
Game.TreasureWars,
{
year: 2023,
month: 6,
}
);
Get the monthly leaderboard for a specific month.
Parameter | Type | Required | Description |
---|---|---|---|
game | Game |
Required | The game identifier - see Game. |
options | object |
optional | Options is an object with the fields below: |
options.year | number |
optional | The year from which to get the leaderboard |
options.month | number |
optional | The month from which to get the leaderboard |
options.skip | number |
optional | How many players to skip in the leaderboard |
options.amount | number |
optional | How many players to return in the leaderboard |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
Returns a Promise which resolves to the following object:
Field | Type | Description |
---|---|---|
data | Response | null |
The response data |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
import { getMonthlyLeaderboard, Game } from "hive-bedrock-api";
// Get the top three Skywars players from this month
const { data, error } = await getMonthlyLeaderboard(Game.SkyWars, {
amount: 3,
});
Get a player's all-time statistics.
Parameter | Type | Required | Description |
---|---|---|---|
identifier | string |
Required | The player's gamertag or UUID of which to get stats for |
game | Game |
optional | The game identifier - see GAME. When not specified, will return all games |
options | object |
optional | Options is an object with the fields below: |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
Returns a Promise which resolves to the following object:
Field | Type | Description |
---|---|---|
data | Response | null |
The response data including player infomation if requesting all games |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
import { getAllTimeStatistics, Game } from "hive-bedrock-api";
// Get player's all-time Hide and Seek stats
const { data, error } = await getAllTimeStatistics("player", Game.HideAndSeek);
Get a player's season statistics.
Parameter | Type | Required | Description |
---|---|---|---|
identifier | string |
Required | The player's gamertag or UUID of which to get stats for |
game | Game |
Required | The game identifier - see GAME. |
options | object |
optional | Options is an object with the fields below: |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
options.season | number |
optional | The season to request the leaderboard for |
Returns a Promise which resolves to the following object:
Field | Type | Description |
---|---|---|
data | Response | null |
The response data |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
import { getSeasonStatistics, Game } from "hive-bedrock-api";
// Get player's season stats
const { data, error } = await getSeasonStatistics("player", Game.BedWars, {
season: 1,
});
Get the all-time leaderboard for a game or games.
Parameter | Type | Required | Description |
---|---|---|---|
game | Game |
Required | The game identifier - see GAME. |
options | object |
optional | Options is an object with the fields below: |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
Returns a Promise which resolves to the following object:
Field | Type | Description |
---|---|---|
data | Response | null |
The response data |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
import { getAllTimeLeaderboard, Game } from "hive-bedrock-api";
// Get the all-time leaderboard for Survival Games
const { data, error } = await getAllTimeLeaderboard(Game.SurvivalGames);
Get the season leaderboard for a game.
Parameter | Type | Required | Description |
---|---|---|---|
game | Game |
Required | The game identifier - see GAME. |
options | object |
optional | Options is an object with the fields below: |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
options.season | number |
optional | The season to request the leaderboard for |
Returns a Promise which resolves to the following object:
Field | Type | Description |
---|---|---|
data | Response | null |
The response data |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
import { getSeasonLeaderboard, Game } from "hive-bedrock-api";
// Get the season leaderboard for BedWars
const { data, error } = await getSeasonLeaderboard(Game.BedWars, { season: 1 });
Get special data such as each game's all-time player count.
Parameter | Type | Required | Description |
---|---|---|---|
options | object |
optional | Options is an object with the fields below: |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
Returns a Promise which resolves to the following object:
Field | Type | Description |
---|---|---|
data | Response | null |
The response data |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
import { getGlobalStatistics } from "hive-bedrock-api";
// Get global statistics
const { data, error } = await getGlobalStatistics();
Fetch data about a specific game's currently active maps. If the game has got only one map, returned data will be null and the error message will say so.
Parameter | Type | Required | Description |
---|---|---|---|
game | GAME |
Required | The game identifier - see GAME |
options | object |
optional | Options is an object with the fields below: |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
Returns a Promise which resolves to the following object:
Field | Type | Description |
---|---|---|
data | Response | null |
The response data |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
Allowed games (games with only one map don't work):
- BlockDrop
- CaptureTheFlag
- DeathRun
- Gravity
- GroundWars
- HideAndSeek
- MurderMystery
- Skywars
- SurvivalGames
- TreasureWars
- TheBridge
import { getMaps, Game } from "hive-bedrock-api";
// Get all currently active Skywars maps' data.
const { data, error } = await getMaps(Game.Skywars);
Currently Ground Wars does not work with this endpoint.
Fetch metadata about a specific game. This includes level and prestige infomation.
Parameter | Type | Required | Description |
---|---|---|---|
game | Game |
Required | The game identifier - see GAME |
options | object |
optional | Options is an object with the fields below: |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
Returns a Promise which resolves to the following object:
Field | Type | Description |
---|---|---|
data | Response | null |
The response data |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
import { getMetadata, Game } from "hive-bedrock-api";
// Get metadata about skywars levels and prestige
const { data, error } = await getMetadata(Game.Skywars);
Get a player's information, such as current/longest login streak, currently equipped and all unlocked cosmetics, and number of quests completed.
Parameter | Type | Required | Description |
---|---|---|---|
identifier | string |
Required | The player's gamertag or UUID of which to get info |
options | object |
optional | Options is an object with the fields below: |
options.init | RequestInit |
optional | Used in the api request to add custom headers and more |
Returns a Promise which resolves to the following object
Field | Type | Description |
---|---|---|
data | Response | null |
The response data |
error | { code: number, message: string } | null |
Error data |
status | number |
The http status returned |
duration | number | undefined |
The duration of the http request |
headers | Headers | undefined |
Response headers from the request |
import { getPlayerInformation } from "hive-bedrock-api";
// Get player's player info.
const { data, error } = await getPlayerInformation("player");
The have has changed Player Infomation recently, so the below infomation may be out of date.
PlayerInfo object structure
Field | Type | Description |
---|---|---|
UUID | string |
The player's UUID |
xuid | number |
The player's XUID (Xbox User ID) |
username | string |
The player's username |
username_cc | string |
The player's correctly capitalised username |
rank | Rank |
The player's rank |
first_played | number |
The unix timestamp when the player first played on The Hive |
daily_login_streak | number |
The player's current daily login streak |
longest_daily_login_streak | number |
The player's longest daily login streak |
friend_count | number |
How many friends the player has got on the server |
quest_count | number |
How many quests the player has ever completed |
paid_ranks | Avatar[] |
All of the player's paid ranks |
pets | string[] |
All of the player's owned pets' names |
mounts | string[] |
All of the player's owned mounts' names |
hub_title_count | number |
How many hub titles the player currently owns |
hub_title_unlocked | string[] |
All of the player's owned hub titles |
equipped_hub_title | string | null |
The player's currently equipped hub title |
costume_count | number |
How many costumes the player currently owns |
costume_unlocked | string[] |
All of the player's owned costumes' names |
equipped_costume | string | null |
The player's currently equipped costume's name |
avatar_count | number |
How many avatars the player currently owns |
avatar_unlocked | Avatar[] |
All of the player's owned avatars |
equipped_avatar | Avatar | null |
The player's currently equipped avatar |
hat_count | number |
How many hats the player currently owns |
hat_unlocked | Hat[] | null |
All of the player's owned hats |
equipped_hat | Hat | null |
The player's currently equipped hat |
backbling_count | number |
How many backblings the player currently owns |
cosmetic.backbling | Backbling[] | null |
All of the player's owned backblings |
equipped_backbling | Backbling | null |
The player's currently equipped backbling |
The structure of the avatar object.
Field | Type | Description |
---|---|---|
name | string |
The name of the avatar |
url | string |
The URL of the avatar's image |
The structure of the backbling object.
Field | Type | Description |
---|---|---|
name | string |
The name of the backbling |
icon | string |
The URL of the backbling's image |
rarity | string |
The URL of the backbling's image |
The structure of the hat object.
Field | Type | Description |
---|---|---|
name | string |
The name of the hat |
icon | string |
The URL of the hat's image |
rarity | string |
The URL of the hat's image |
Infomation about level and prestige data.
Field | Type | Description |
---|---|---|
name | string |
The full name of the game |
shortName | string |
The short name of the game |
maxLevel | number |
The maximum level in the game |
allowPrestiging | boolean |
Wether player can prestige in the game |
maxPrestige | number |
The largest prestige the player can reach |
experienceToLevel | { [xp: string]: number } |
An object listing the amount of xp required for each level |
Field | Type | Description |
---|---|---|
name | string |
The name of the map |
season | MAP_SEASON | The season the map belongs to |
variant | MAP_VARIANT | The variant of map |
image | string |
URL to an image of the map |
The season of the map.
Key | Value |
---|---|
MAP_SEASON.None | NO_SEASON |
MAP_SEASON.Winter | WINTERFEST |
MAP_SEASON.Spring | SPRING |
MAP_SEASON.Summer | SUMMER |
MAP_SEASON.Halloween | HALLOWEEN |
MAP_SEASON.Autumn | AUTUMN |
The variant of the map.
Key | Value |
---|---|
MAP_VARIANT.Regular | REGULAR |
MAP_VARIANT.Duos | DUOS |
MAP_VARIANT.Trios | TRIOS |
MAP_VARIANT.Squads | SQUADS |
MAP_VARIANT.Mega | MEGA |
MAP_VARIANT.Royale | ROYALE |
All possible player ranks.
Key | Value | Description |
---|---|---|
RANK.Regular | REGULAR |
A normal player, no extra ranks. |
RANK.Plus | PLUS |
Hive Plus rank. |
RANK.Youtuber | YOUTUBER |
YouTube partner rank. |
RANK.Streamer | STREAMER |
Streamer partner rank. |
RANK.Tiktok | TIKTOK |
TikTok partner rank. |
RANK.VIP | VIP |
Very Important Person rank. |
RANK.Helper | HELPER |
Hive Helper. |
RANK.Moderator | MODERATOR |
Hive Moderator. |
RANK.Hive | HIVE_TEAM |
Part of The Hive staff team. |
RANK.StaffManager | STAFF_MANAGER |
Staff Manager for The Hive. |
RANK.CommunityManager | COMMUNITY_MANAGER |
Community Manager for The Hive. |
RANK.Owner | OWNER |
Owner of The Hive. |
Each game, and its string ID
Key | Value |
---|---|
GAME.HideAndSeek | hide |
GAME.DeathRun | dr |
GAME.TreasureWars | wars |
GAME.MurderMystery | murder |
GAME.SurvivalGames | sg |
GAME.Skywars | sky |
GAME.CaptureTheFlag | ctf |
GAME.BlockDrop | drop |
GAME.GroundWars | ground |
GAME.JustBuild | build |
GAME.BlockParty | party |
GAME.TheBridge | bridge |
GAME.Gravity | grav |
GAME.ParkourWorlds | parkour |
Total player count for each game
Key | Type | Description |
---|---|---|
global | number |
Total player count globally |
main | number |
Main player count |
key in GAME |
number |
Total player count for each specific game |