Open Data API
Comments, Bugs, Missing Data - opendata@ninjakiwi.com
Read the Changelog
/btd6/races
A list of all available Race events
/btd6/races/:raceID/leaderboard
A race leaderboard
/btd6/races/:raceID/metadata
Metadata for a race event
/btd6/bosses
List all available Boss events
/btd6/bosses/:bossID/leaderboard/:type/:teamSize
Load a Boss event leaderboard
/btd6/bosses/:bossID/metadata/:difficulty
Load Boss event Metadata
/btd6/users/:userID
Load information about a BTD6 Player
/btd6/challenges
List all available Challenge Filters
/btd6/challenges/filter/:challengeFilter
List challenges based on a filter
/btd6/challenges/challenge/:challengeID
Get specific information about a challenge
/btd6/ct
Load information about current and historical CT events
/btd6/ct/:ctID/tiles
Load Information about the tiles from a CT event
/btd6/ct/:ctID/leaderboard/player
Load Top Player Leaderboard for a CT event
/btd6/ct/:ctID/leaderboard/team
Load Top Team Leaderboard for a CT event
/btd6/guild/:guildID
Load information about a BTD6 Team
/btd6/odyssey
A list of all available Odyssey events
/btd6/odyssey/:odysseyID/:difficulty
A odyssey event metadata
/btd6/odyssey/:odysseyID/:difficulty/maps
A odyssey event map information
/btd6/save/:oakID
Load detailed information about a players' progress. Requires an OAK Token from the player
/btd6/maps
List all map filters
/btd6/maps/filter/:mapFilter
List maps based on a filter
/btd6/maps/map/:mapID
Get specific information about a map
/battles2/homs
A list of current Hall of Masters events
/battles2/homs/:homID/leaderboard
A HoM leaderboard
/battles2/users/:userID
Information about a Battles 2 Player
/battles2/users/:userID/matches
Recent match information
/battles2/users/:userID/homs
Recent hall of masters positions
/battles2/guild/:guildID
Information about a Battles 2 Guild/Clan
/battles2/guild/:guildID/war
A list of recent wars the guild has taken part in

Endpoint: /btd6/races 🔎
A list of all available Race events
Request Parameters
None
Response Model: _btd6race
Name
Description
Type
id
Race Event ID
string
name
Race Name
string
start
Race start time in unix epoch milliseconds
number
end
Race end time in unix epoch milliseconds
number
totalScores
The total number of scores submitted
number
leaderboard
URL to leaderboard data
string
metadata
URL to full Race metadata
string
Try Endpoint 🚀
A race leaderboard
Request Parameters
Name
Description
Allowed Values
:raceID
The current Race ID
Response Model: _btd6raceleaderboard
Name
Description
Type
displayName
The display name for this user
string
score
The Race score in milliseconds
number
scoreParts
When the leaderboard includes multiple scores they will be included here
array
submissionTime
The epoch time in milliseconds when the score was submitted (-1 when not available)
number
profile
URL to the players public profile
string
Try Endpoint 🚀
:raceID
Metadata for a race event
Request Parameters
Name
Description
Allowed Values
:raceID
The current Race ID
Response Model: _btd6challengedocument
Name
Description
Type
name
Challenge Name
string
createdAt
Challenge creation time in unix epoch milliseconds
number
id
Unique Challenge ID
string
creator
URL to the creators profile
string
gameVersion
Version of the game this challenge was created in
string
map
Map Name
string
mapURL
URL to the map icon
assetURL
mode
Game Mode
string
difficulty
Challenge Difficulty
string
disableDoubleCash
true when Double Cash Mode is disabled
string
disableInstas
true when Instas are disabled
string
disableMK
true when Monkey Knowledge is disabled
string
disablePowers
true when Powers are disabled
string
disableSelling
true when Selling is disabled
string
startingCash
Starting cash value
number
lives
Starting lives
number
maxLives
Maximum allowed lives
number
maxTowers
Maximum towers allowed
number
maxParagons
Maximum paragons allowed
number
startRound
Starting round
number
endRound
End Round
number
plays
Total number of attempts
number
wins
Total number of wins
number
losses
Total number of losses
number
upvotes
Total number of upvotes
number
playsUnique
Total number of unique attempts
number
restarts
Total number of restarts
number
winsUnique
Total number of unique player wins
number
lossesUnique
Total number of unique player losses
number
abilityCooldownReductionMultiplier
Ability Cooldown Multiplier
number
leastCashUsed
Least Cash Used Setting
number
leastTiersUsed
Least Tier Used
number
noContinues
Are continues enabled
number
seed
The RNG seed
number
removeableCostMultiplier
Blocker removal cost multiplier
number
roundSets
Bloon Round Information
string[]
_powers
[!] Power restrictions
raw
_bloonModifiers
[!] Bloon Modifiers
raw
_towers
[!] Tower restrictions
raw
Try Endpoint 🚀
:raceID
Endpoint: /btd6/bosses 🔎
List all available Boss events
Request Parameters
None
Response Model: _btd6boss
Name
Description
Type
id
Boss Event ID
string
name
Boss Name
string
start
Boss start time in unix epoch milliseconds
number
end
Boss end time in unix epoch milliseconds
number
bossType
The name of the Boss
string
bossTypeURL
Boss Icon
assetURL
totalScores_standard
Total scores in the Standard leaderboard
number
totalScores_elite
Total scores in the Elite leaderboard
number
leaderboard_standard_players_1
URL to Elite Difficulty Single Player leaderboard data
string
leaderboard_elite_players_1
URL to Elite Difficulty Single Player leaderboard data
string
metadataStandard
URL to full metadata for Standard Mode
string
metadataElite
URL to full metadata for Elite Mode
string
scoringType
The score type for this leaderboard.
string
Try Endpoint 🚀
Load a Boss event leaderboard
Request Parameters
Name
Description
Allowed Values
:bossID
The current boss event ID
:type
A boss event type
standard,elite
:teamSize
The size of the team. Currently, only single player leaderboards are supported so this value should always be '1'
1
Response Model: _btd6bossleaderboard
Name
Description
Type
displayName
The display name for this user
string
score
The Boss score in milliseconds (lower is better)
number
scoreParts
When the leaderboard includes multiple scores they will be included here
array
submissionTime
The epoch time in milliseconds
number
profile
URL to the players public profile
string
Try Endpoint 🚀
:bossID
:type
:teamSize
Load Boss event Metadata
Request Parameters
Name
Description
Allowed Values
:bossID
The current boss event ID
:difficulty
A boss event difficulty
standard,elite
Response Model: _btd6challengedocument
Name
Description
Type
name
Challenge Name
string
createdAt
Challenge creation time in unix epoch milliseconds
number
id
Unique Challenge ID
string
creator
URL to the creators profile
string
gameVersion
Version of the game this challenge was created in
string
map
Map Name
string
mapURL
URL to the map icon
assetURL
mode
Game Mode
string
difficulty
Challenge Difficulty
string
disableDoubleCash
true when Double Cash Mode is disabled
string
disableInstas
true when Instas are disabled
string
disableMK
true when Monkey Knowledge is disabled
string
disablePowers
true when Powers are disabled
string
disableSelling
true when Selling is disabled
string
startingCash
Starting cash value
number
lives
Starting lives
number
maxLives
Maximum allowed lives
number
maxTowers
Maximum towers allowed
number
maxParagons
Maximum paragons allowed
number
startRound
Starting round
number
endRound
End Round
number
plays
Total number of attempts
number
wins
Total number of wins
number
losses
Total number of losses
number
upvotes
Total number of upvotes
number
playsUnique
Total number of unique attempts
number
restarts
Total number of restarts
number
winsUnique
Total number of unique player wins
number
lossesUnique
Total number of unique player losses
number
abilityCooldownReductionMultiplier
Ability Cooldown Multiplier
number
leastCashUsed
Least Cash Used Setting
number
leastTiersUsed
Least Tier Used
number
noContinues
Are continues enabled
number
seed
The RNG seed
number
removeableCostMultiplier
Blocker removal cost multiplier
number
roundSets
Bloon Round Information
string[]
_powers
[!] Power restrictions
raw
_bloonModifiers
[!] Bloon Modifiers
raw
_towers
[!] Tower restrictions
raw
Try Endpoint 🚀
:bossID
:difficulty
Load information about a BTD6 Player
Request Parameters
Name
Description
Allowed Values
:userID
This can be an encrypted ID generated by the API or a user Open Access Key (OAK) - https://ninja.kiwi/opendatafaq
Response Model: _btd6userprofile
Name
Description
Type
displayName
Current User Display Name
string
rank
Player Rank
number
veteranRank
Player Veteran Rank
number
achievements
Number of achievements unlocked
string
mostExperiencedMonkey
Most Experienced Monkey
string
highestRound
[Deprected] Use gameplay.highestRound
number
avatar
User avatar icon
string
banner
User banner icon
string
avatarURL
URL to avatar icon
assetURL
bannerURL
URL to banner icon
assetURL
followers
Number of followers
number
bloonsPopped
Bloon Pop Stats
map
gameplay
Gameplay Stats
map
heroesPlaced
Hero Stats
map
towersPlaced
Tower Stats
map
bossBadgesNormal
Normal Boss Badges
map
bossBadgesElite
Normal Boss Badges
map
_medalsSinglePlayer
[!] Single Player Medals
raw
_medalsMultiplayer
[!] Multiplayer Medals
raw
_medalsBoss
[!] Boss Medals
raw
_medalsBossElite
[!] Elite Boss Medals
raw
_medalsCTLocal
[!] CT Local Medals
raw
_medalsCTGlobal
[!] CT Global Medals
raw
_medalsRace
[!] Race Medals
raw
Try Endpoint 🚀
:userID
List all available Challenge Filters
Request Parameters
None
Response Model: _btd6challengetype
Name
Description
Type
type
Challenge Filter Name
string
challenges
URL to view challenges with this filter
string
Try Endpoint 🚀
List challenges based on a filter
Request Parameters
Name
Description
Allowed Values
:challengeFilter
The current challenge filter
newest,trending,daily
Response Model: _btd6challenge
Name
Description
Type
name
Challenge Filter Name
string
createdAt
Challenge creation time in unix epoch milliseconds
number
id
Unique Challenge ID
string
creator
URL to the creators profile
string
metadata
URL to the full challenge information
string
Try Endpoint 🚀
:challengeFilter
Get specific information about a challenge
Request Parameters
Name
Description
Allowed Values
:challengeID
The ID of the current challenge
Response Model: _btd6challengedocument
Name
Description
Type
name
Challenge Name
string
createdAt
Challenge creation time in unix epoch milliseconds
number
id
Unique Challenge ID
string
creator
URL to the creators profile
string
gameVersion
Version of the game this challenge was created in
string
map
Map Name
string
mapURL
URL to the map icon
assetURL
mode
Game Mode
string
difficulty
Challenge Difficulty
string
disableDoubleCash
true when Double Cash Mode is disabled
string
disableInstas
true when Instas are disabled
string
disableMK
true when Monkey Knowledge is disabled
string
disablePowers
true when Powers are disabled
string
disableSelling
true when Selling is disabled
string
startingCash
Starting cash value
number
lives
Starting lives
number
maxLives
Maximum allowed lives
number
maxTowers
Maximum towers allowed
number
maxParagons
Maximum paragons allowed
number
startRound
Starting round
number
endRound
End Round
number
plays
Total number of attempts
number
wins
Total number of wins
number
losses
Total number of losses
number
upvotes
Total number of upvotes
number
playsUnique
Total number of unique attempts
number
restarts
Total number of restarts
number
winsUnique
Total number of unique player wins
number
lossesUnique
Total number of unique player losses
number
abilityCooldownReductionMultiplier
Ability Cooldown Multiplier
number
leastCashUsed
Least Cash Used Setting
number
leastTiersUsed
Least Tier Used
number
noContinues
Are continues enabled
number
seed
The RNG seed
number
removeableCostMultiplier
Blocker removal cost multiplier
number
roundSets
Bloon Round Information
string[]
_powers
[!] Power restrictions
raw
_bloonModifiers
[!] Bloon Modifiers
raw
_towers
[!] Tower restrictions
raw
Try Endpoint 🚀
:challengeID
Endpoint: /btd6/ct 🔎
Load information about current and historical CT events
Request Parameters
None
Response Model: _btd6ct
Name
Description
Type
id
CT Event ID
string
start
Event start time in unix epoch milliseconds
number
end
Event end time in unix epoch milliseconds
number
totalScores_player
Total scores in the Player leaderboard
number
totalScores_team
Total scores in the Team leaderboard
number
tiles
URL to Information about each CT tile
string
leaderboard_player
URL to Top Player leaderboard
string
leaderboard_team
URL to Top Team leaderboard
string
Try Endpoint 🚀
Load Information about the tiles from a CT event
Request Parameters
Name
Description
Allowed Values
:ctID
The ID of the current CT event
Response Model: _btd6cttile
Name
Description
Type
id
The CT ID
string
tiles
A list of CT tiles
array
Try Endpoint 🚀
:ctID
Load Top Player Leaderboard for a CT event
Request Parameters
Name
Description
Allowed Values
:ctID
The ID of the current CT event
Response Model: _btd6ctleaderboardplayer
Name
Description
Type
displayName
The display name for this user
string
score
The CT score
number
profile
URL to the players public profile
string
Try Endpoint 🚀
:ctID
Load Top Team Leaderboard for a CT event
Request Parameters
Name
Description
Allowed Values
:ctID
The ID of the current CT event
Response Model: _btd6ctleaderboardteam
Name
Description
Type
displayName
The display name for this Team
string
score
The CT score
number
profile
URL to the team public profile
string
Try Endpoint 🚀
:ctID
Load information about a BTD6 Team
Request Parameters
Name
Description
Allowed Values
:guildID
The current guild ID
Response Model: _btd6guildprofile
Name
Description
Type
name
Guild Name
string
owner
URL to the Owners public profile
string
numMembers
Number of players in Team
number
status
Status of the Team (OPEN, FILTERED, DISBANDED, CLOSED)
string
banner
Banner Icon Name
string
frame
Frame Icon Name
string
icon
Team Icon Name
string
bannerURL
URL to banner icon
assetURL
frameURL
URL to frame icon
assetURL
iconURL
URL to icon
assetURL
Try Endpoint 🚀
:guildID
Endpoint: /btd6/odyssey 🔎
A list of all available Odyssey events
Request Parameters
None
Response Model: _btd6odyssey
Name
Description
Type
id
Odyssey Event ID
string
name
Odyssey Name
string
description
Odyssey Description
string
start
Odyssey start time in unix epoch milliseconds
number
end
Odyssey end time in unix epoch milliseconds
number
metadata_easy
URL to Easy Mode Settings
URL
metadata_medium
URL to Medium Mode Settings
URL
metadata_hard
URL to Hard Mode Settings
URL
Try Endpoint 🚀
A odyssey event metadata
Request Parameters
Name
Description
Allowed Values
:odysseyID
The ID of the current Odyssey event
:difficulty
The current difficulty
easy,medium,hard
Response Model: _btd6odysseymetadata
Name
Description
Type
id
Odyssey Event ID
string
isExtreme
True when the Odyssey is extreme
string
maxMonkeySeats
Maximum seats on the boat
number
maxMonkeysOnBoat
Maximum towers
number
maxPowerSlots
Maximum number of powers
number
startingHealth
Voyage starting health
number
_rewards
[!] Rewards list
raw
_availablePowers
[!] Powers that can be chosen
raw
_availableTowers
[!] Towers that can be chosen
raw
_defaultPowers
[!] Default event powers
raw
_defaultTowers
[!] Defauly Towers
raw
maps
URL to map information
URL
Try Endpoint 🚀
:odysseyID
:difficulty
A odyssey event map information
Request Parameters
Name
Description
Allowed Values
:odysseyID
The ID of the current Odyssey event
:difficulty
The current difficulty
easy,medium,hard
Response Model: _btd6challengedocument
Name
Description
Type
name
Challenge Name
string
createdAt
Challenge creation time in unix epoch milliseconds
number
id
Unique Challenge ID
string
creator
URL to the creators profile
string
gameVersion
Version of the game this challenge was created in
string
map
Map Name
string
mapURL
URL to the map icon
assetURL
mode
Game Mode
string
difficulty
Challenge Difficulty
string
disableDoubleCash
true when Double Cash Mode is disabled
string
disableInstas
true when Instas are disabled
string
disableMK
true when Monkey Knowledge is disabled
string
disablePowers
true when Powers are disabled
string
disableSelling
true when Selling is disabled
string
startingCash
Starting cash value
number
lives
Starting lives
number
maxLives
Maximum allowed lives
number
maxTowers
Maximum towers allowed
number
maxParagons
Maximum paragons allowed
number
startRound
Starting round
number
endRound
End Round
number
plays
Total number of attempts
number
wins
Total number of wins
number
losses
Total number of losses
number
upvotes
Total number of upvotes
number
playsUnique
Total number of unique attempts
number
restarts
Total number of restarts
number
winsUnique
Total number of unique player wins
number
lossesUnique
Total number of unique player losses
number
abilityCooldownReductionMultiplier
Ability Cooldown Multiplier
number
leastCashUsed
Least Cash Used Setting
number
leastTiersUsed
Least Tier Used
number
noContinues
Are continues enabled
number
seed
The RNG seed
number
removeableCostMultiplier
Blocker removal cost multiplier
number
roundSets
Bloon Round Information
string[]
_powers
[!] Power restrictions
raw
_bloonModifiers
[!] Bloon Modifiers
raw
_towers
[!] Tower restrictions
raw
Try Endpoint 🚀
:odysseyID
:difficulty
Load detailed information about a players' progress. Requires an OAK Token from the player
Request Parameters
None
Response Model: _btd6usersave
Name
Description
Type
latestGameVersion
The latest version of the game that this player has played
string
towerXP
Tower XP
map
acquiredUpgrades
Upgrades Unlocked
map
acquiredKnowledge
Upgrades Monkey Knowledge
map
unlockedTowers
Towers Unlocked
map
unlockedHeros
Towers Heros Unlocked
map
unlockedSkins
Towers Hero Skins Unlocked
map
gamesPlayed
Total Games Played
number
powers
Powers Unlocked
map
instaTowers
Insta Towers (tier & count)
nestedmap
monkeyMoney
Current Monkey Money
number
xp
Current XP
number
rank
Current Rank
number
veteranXp
Current Veteran XP
number
veteranRank
Current Veteran Rank
number
trophies
Current Trophies
number
lifetimeTrophies
Total trophies earned
number
lifetimeTeamTrophies
Total Team Trophies Earned
number
knowledgePoints
Current MK Points
number
primaryHero
Current Selected Hero
string
achievementsClaimed
Achievements Claimed
array
highestSeenRound
Highest Ever Round
number
dailyRewardCount
Daily Rewards Claimed
number
totalDailyChallengesCompleted
Total DC's completed
number
consecutiveDailyChallengesCompleted
Current number of consecutive days a DC has been completed
number
totalRacesEntered
Total Races Entered
number
challengesPlayed
Total Challenges Played
number
challengesShared
Total Challenges Shared
number
totalCompletedOdysseys
Total Odysseys Complete
number
unlockedBigBloons
true when Big Bloons has been unlocked
boolean
bigBloonsActive
true when Big Bloons is active
boolean
unlockedSmallBloons
true when Small Bloons has been unlocked
boolean
smallBloonsActive
true when Small Bloons is active
boolean
seenBigTowers
true when Big Bloons has been unlocked
boolean
bigTowersActive
true when Big Bloons is active
boolean
unlockedSmallTowers
true when Small Bloons has been unlocked
boolean
smallTowersActive
true when Small Bloons is active
boolean
unlockedSmallBosses
true when Small Bosses has been unlocked
boolean
smallBossesActive
true when Small Bosses is active
boolean
namedMonkeys
Named Monkey Names (note: Ninja Kiwi is not responsible for these names but they can be reported at https://support.ninjakiwi.com)
nestedmap
collectionEventCratesOpened
Collect event crates opened
number
continuesUsed
Continues Used
number
trophyStoreItems
Trophy Store Items Purchased
map
mapProgress
A list of maps completed split by single/coop mode and difficulty.
nestedmap
Try Endpoint 🚀
Endpoint: /btd6/maps 🔎
List all map filters
Request Parameters
None
Response Model: _btd6maptype
Name
Description
Type
type
Map Filter Name
string
maps
URL to view maps with this filter
string
Try Endpoint 🚀
List maps based on a filter
Request Parameters
Name
Description
Allowed Values
:mapFilter
The name of the filter
Response Model: _btd6map
Name
Description
Type
name
Map Filter Name
string
createdAt
Map creation time in unix epoch milliseconds
number
id
Unique Map ID
string
creator
URL to the creators profile
string
metadata
URL to the full map information
string
Try Endpoint 🚀
:mapFilter
Get specific information about a map
Request Parameters
Name
Description
Allowed Values
:mapID
Map ID
Response Model: _btd6mapdocument
Name
Description
Type
name
Map Name
string
createdAt
Map creation time in unix epoch milliseconds
number
id
Unique Map ID
string
creator
URL to the creators profile
string
gameVersion
Version of the game this map was created in
string
map
Map Name
string
mapURL
URL to the map icon
assetURL
plays
Total number of attempts
number
wins
Total number of wins
number
losses
Total number of losses
number
upvotes
Total number of upvotes
number
playsUnique
Total number of unique attempts
number
restarts
Total number of restarts
number
winsUnique
Total number of unique player wins
number
lossesUnique
Total number of unique player losses
number
Try Endpoint 🚀
:mapID
A list of current Hall of Masters events
Request Parameters
None
Response Model: _battles2hom
Name
Description
Type
id
HoM Event ID
string
name
Season Name
string
start
Event start time in unix epoch milliseconds
number
end
Event end time in unix epoch milliseconds
number
live
When 'true', this is the live in-game HoM event
boolean
totalScores
The total number of scores submitted
number
leaderboard
URL to leaderboard data
string
Try Endpoint 🚀
A HoM leaderboard
Request Parameters
Name
Description
Allowed Values
:homID
The current HoM season ID
:homID
The current HoM season ID
Response Model: _battles2homleaderboard
Name
Description
Type
displayName
The display name for this user
string
score
The HoM score
number
profile
URL to the players public profile
string
currentlyInHoM
When true, the player is currenty in the HoM. This might be false if the user has been demoted from HoM by finishing in the demotion zone of an arena league
boolean
Try Endpoint 🚀
:homID
:homID
Information about a Battles 2 Player
Request Parameters
Name
Description
Allowed Values
:userID
This can be an encrypted ID generated by the API or a user Open Access Key (OAK) - https://ninja.kiwi/opendatafaq
Response Model: _battles2userprofile
Name
Description
Type
displayName
User Display Name
string
is_vip
VIP Status (deprecated)
boolean
is_club_member
Club Membership Status
boolean
equippedAvatar
Selected avatar
string
equippedAvatarURL
Avatar Icon
assetURL
equippedBanner
Selected Banner
string
equippedBannerURL
Banner Icon
assetURL
equippedBorder
Selected Border
string
equippedBorderURL
Border Icon
assetURL
casualStats
User Display Name
map
rankedStats
User Display Name
map
badges_equipped
Currently Equpped badges
map[]
badges_all
All Badges
map[]
chests
Pending Chests
string[]
chestsOpened
Total Chests Opened
number
currentSeason
The most recent season the user has played in
string
currentSeason_highestArenaIndex
Numerical Representation of Highest Arena Reached
number
currentSeason_highestArena
Highest Arena Reached during the most recent event
string
currentSeason_trophies
Current Season Trophies
number
lifetime_highestArenaIndex
Numerical Representation of Highest Arena reached across all seasons
number
lifetime_highestArena
Highest Arena reached across all seasons
string
lifetime_trophies
Highest Trophies across all seasons
number
matches
Recent match information
string
homs
Recent HoM leaderboard scores
string
inGuild
True when the player is part of a guild
boolean
guild
URL to guild profile
string
accolades
All Accolades
map[]
arenaLeagueTier
The players current arena league. Tiers start at RBC=0 through HOM=8
number
_bloonStats
User Display Name
raw
_towers
Tower Usage Stats
raw
Try Endpoint 🚀
:userID
Recent match information
Request Parameters
Name
Description
Allowed Values
:userID
This can be an encrypted ID generated by the API or a user Open Access Key (OAK) - https://ninja.kiwi/opendatafaq
Response Model: _battles2usermap
Name
Description
Type
id
A unique ID for this match
string
gametype
Match type
string
map
Map Name
string
duration
Duration of the match in seconds
number
endRound
Round the match ended
number
playerLeft
Details about the Left Side Player
map
playerRight
Details about the Right Side Player
map
mapURL
Map Icon URL
string
Try Endpoint 🚀
:userID
Recent hall of masters positions
Request Parameters
Name
Description
Allowed Values
:userID
This can be an encrypted ID generated by the API or a user Open Access Key (OAK) - https://ninja.kiwi/opendatafaq
Response Model: _battles2userhomrank
Name
Description
Type
id
HoM Event ID
string
name
HoM Season Name
string
season
HoM Season Index
string
rank
The players current rank (1 = top)
number
score
The users current HoM score
number
totalScores
Total players in the HoM
number
leaderboard
URL to the full leaderboard data
string
Try Endpoint 🚀
:userID
Information about a Battles 2 Guild/Clan
Request Parameters
None
Response Model: _battles2guild
Name
Description
Type
name
Guild Name
string
numMembers
The number of members currently in the guild
number
status
The current status of the guild. Can be OPEN|FILTERED|CLOSED|DISBANDED
string
owner
The guild owner's profile
string
tagline
Guilds' tagline. Ninja Kiwi is not responsible for any content from services linked to from taglines
string
banner
The Guild Banner
string
bannerURL
The Guild Banner
assetURL
wars
Recent wars this guild has taken part in
string
Try Endpoint 🚀
A list of recent wars the guild has taken part in
Request Parameters
None
Response Model: _battles2guildwar
Name
Description
Type
eventState
The curent event state. Can be NOT_STARTED,WAR_WARMUP,WAR_RUNNING,WAR_GRACE_PERIOD,WAR_FINISHED
string
rewardState
After a war, you can check if rewards have been given out. Can be TOO_EARLY,PROCESSING,FINISHED
string
tier
The guild's tier in this event
number
nextMatchEpoch
Unix epoch timestamp. This is when the daily matches will reset
number
groupGuildLeaderboard
An array of guild scores for all the guilds in this group
map[]
memberContributionsLeaderboard
An array of scores. This represents the medallions won be each player in the current guild. This can include members not currently in the guild if they won a match but left during the event
map[]
Try Endpoint 🚀