API Host

apiv2.nethergames.org
Rate Limit

1000 requests/15 minutes

Endpoints

Public Player Data

Replace :username with the player username. Case insensitive.

Get Statistics

GET /players/:username/stats

Get Vote Status

GET /players/:username/votes

Get Warnings

GET /players/:username/warnings

Get Punishments

GET /players/:username/punishments

Public Server Statistics

GET /servers/stats?total={boolean}

Get data from the server manager table, showing how many players are online each server and gamemode. To show the total amount of players, specify the query string total with a boolean value of true.

Public Guild Statistics

GET /guilds/:name/stats

Replace :name with the guild name. Case insensitive.

Public Faction Statistics

GET /factions/:name/stats

Replace :name with the faction name. Case insensitive.

Public Leaderboards Data

GET /leaderboard?type={string}&game={string?}&column={string?}&scope={string?}&limit={number = 100}

Specify the leaderboard type (required) as one of the following values:

- xp
- kdr
- kills
- voters
- guilds
- credits
- parkour
- factions
- game

If the type is game, you need to specify a column as one of the following values:

- bw_kills
- bw_deaths
- bw_solo_kills
- bw_solo_deaths
- bw_doubles_kills
- bw_doubles_deaths
- bw_trios_kills
- bw_trios_deaths
- bw_squads_kills
- bw_squads_deaths
- bw_beds_broken
- bw_solo_beds_broken
- bw_doubles_beds_broken
- bw_trios_beds_broken
- bw_squads_beds_broken
- bw_diamonds_collected
- bw_emeralds_collected
- bw_gold_collected
- bw_iron_collected
- bw_final_kills
- bw_solo_final_kills
- bw_doubles_final_kills
- bw_trios_final_kills
- bw_squads_final_kills
- bw_wins
- bw_solo_wins
- bw_doubles_wins
- bw_trios_wins
- bw_squads_wins

- duels_kills
- duels_deaths
- duels_arrows_shot
- duels_melee_hits
- duels_streak
- duels_best_streak
- duels_wins
- duels_losses

- mm_kills
- mm_deaths
- mm_classic_kills
- mm_classic_deaths
- mm_infection_kills
- mm_infection_deaths
- mm_bow_kills
- mm_knife_kills
- mm_throw_knife_kills
- mm_wins
- mm_classic_wins
- mm_infection_wins

- sw_kills
- sw_deaths
- sw_solo_kills
- sw_solo_deaths
- sw_solo_normal_kills
- sw_solo_normal_deaths
- sw_solo_insane_kills
- sw_solo_insane_deaths
- sw_doubles_kills
- sw_doubles_deaths
- sw_doubles_normal_kills
- sw_doubles_normal_deaths
- sw_doubles_insane_kills
- sw_doubles_insane_deaths
- sw_blocks_broken
- sw_blocks_placed
- sw_arrows_shot
- sw_eggs_thrown
- sw_epearls_thrown
- sw_wins
- sw_solo_wins
- sw_doubles_wins
- sw_losses
- sw_solo_losses
- sw_doubles_losses

If the type is factions, you may optionally specify a scope, as one of the following (case sensitive) values:

- kills
- streak
- bestStreak

If the type is not factions, you may optionally specify the game mode as one of the following values:

- bb
- bh
- br
- bw
- duels
- mm
- rc
- sc
- sw
- sg
- tr

Specify the limit of returned objects (optional), as an integer between 0-1000. Defaults to 100 if not specified.

Public Server Announcements

GET /announcements?type={string}&limit={number = 100}

Specify the announcements type (required) as one of the following values:

- message
- board
- title

Specify the limit of returned objects (optional), as an integer between 0-1000. Defaults to 100 if not specified.

Public Discord Announcements

GET /announcements/discord?limit={number = 100}

Specify the limit of returned objects (optional), as an integer between 0-1000. Defaults to 100 if not specified.
Was this article helpful?
Cancel
Thank you!