Hive Bedrock API

An API wrapper for the Hive Minecraft Bedrock Edition server. Which allows you to get stats for leaderboards, players, cosmetics, unique player counts, maps and metadata.

[!NOTE] This API responses returned from this package will differ from the responses returned by the official Hive API. This due to our preference and needs when using this package on Hive Backpack.

Getting started

$ npm install hive-bedrock-api
$ yarn add hive-bedrock-api

You should also include hive-bedrock-data as it includes useful functions and game information.

Usage

To start using the API, construct the main class HiveAPI. This class takes in options that will be used in every HTTP request.

const api = new HiveAPI({
    resolveDynamicTitles: true,
    apiBaseEndpoint: "https://api.playhive.com/v0",
    requestInit: { headers: {} },
});

Fetch Player Infomation

// Returns player, cosmetics, server statistics and profile infomation
const { data, error, meta } = await api.getPlayer("player");

Fetch Player Search

// Returns a list of players matching the prefix
const { data, error, meta } = await api.getPlayerSearch("prefix");

Fetch All-Time/Monthly/Seasonal Player Statistics

import { Timeframe, Game } from "hive-bedrock-data";

// Returns all all-time games
const { data, error, meta } = await api.getStatistics("player", Timeframe.AllTime);
// Returns all monthly games
const { data, error, meta } = await api.getStatistics("player", Timeframe.Monthly);
// Returns seasonal game
const { data, error, meta } = await api.getStatistics("player", Timeframe.Seasonal);

Fetch All-Time/Monthly Leaderboard

import { Timeframe, Game } from "hive-bedrock-data";

// Returns all-time leaderboard
const { data, error, meta } = await api.getLeaderboard(Timeframe.AllTime, Game.SkyWars);
// Returns monthly leaderboard
const { data, error, meta } = await api.getLeaderboard(Timeframe.Monthly, Game.SkyWars);
// Returns seasonal leaderboard
const { data, error, meta } = await api.getLeaderboard(Timeframe.Seasonal, Game.BedWars);

Fetch Global Statistics

// Returns unqiue total player counts for different games
const { data, error, meta } = await api.getGlobalStatistics();

Fetch Maps

import { Game } from "hive-bedrock-data";

// Returns data for a specific game's currently active maps
const { data, error, meta } = await api.getGameMaps(Game.TreasureWars);

Fetch Metadata

import { Game } from "hive-bedrock-data";

// Returns data for a specific game's currently active maps
const { data, error, meta } = await api.getGameMetadata(Game.TreasureWars);

Documentation

More documentation will be added about what is returned when using this package.