API Reference¶

Below is a description of the Client class that you’ll be interfacing with, as well as the data model used by the module including Enums and Dataclasses.

Client¶

This is the class you’ll be interfacing with to get data about the games. Most methods are static, however you can create an instance with a Ninja Kiwi Open Access Key to gain access to more functions. If you are in an asynchronous envirnoment, you should check out bloonspy.AsyncClient.

AsyncClient¶

Client for asynchronous environments.

Model¶

Loadable¶

Challenge¶

User¶

Team¶

Event¶

Race¶

RacePlayer¶

BossEvent¶

Boss¶

BossPlayer¶

BossPlayerTeam¶

OdysseyEvent¶

Odyssey¶

ContestedTerritoryEvent¶

CtPlayer¶

CtTeam¶

CustomMap¶

Data Classes¶

UserSave¶

GameVersion¶

Asset¶

InstaMonkey¶

Reward¶

ChallengeModifier¶

Gamemode¶

EventMedals¶

CtLocalMedals¶

CtGlobalMedals¶

MapMedals¶

Restriction¶

TowerRestriction¶

BloonsPoppedStats¶

GameplayStats¶

Infinity¶

Score¶

MapProgress¶

GamemodeCompletionData¶

TrophyStoreItemStatus¶

HeroPlacementFx¶

PowerSkins¶

TowerPets¶

TowerProjectiles¶

VillageFlagCosmetics¶

MusicTracks¶

AllMonkeyFx¶

CoopEmotes¶

BloonsPopFx¶

BloonDecals¶

MoabSkins¶

PowerAmount¶

CtTile¶

Enums¶

BossBloon¶

TeamStatus¶

ChallengeFilter¶

Difficulty¶

Mode¶

OdysseyDifficulty¶

Power¶

Tower¶

ScoreType¶

MonkeyKnowledge¶

Upgrade¶

Achievement¶

MapBorder¶

Map¶

Relic¶

CtTileType¶

GameType¶

Exceptions¶

BloonsException¶

class bloonspy.exceptions.BloonsException¶: Superclass for all Bloons exceptions. Can be used as a catch-all.

NotFound¶

class bloonspy.exceptions.NotFound¶: The requested resource or event doesn’t exist or has expired.

UnderMaintenance¶

class bloonspy.exceptions.UnderMaintenance¶: The Ninja Kiwi server is under maintenance.

BadTeamSize¶

class bloonspy.exceptions.BadTeamSize¶: You specified a bad team size.

InvalidTowerPath¶

class bloonspy.exceptions.InvalidTowerPath(tp: int, mp: int, bp: int)¶

New in 0.5.0

You specified a bad path (for example: 522).

Forbidden¶

class bloonspy.exceptions.Forbidden¶

New in 0.5.0

You are not allowed to use this method.

Forbidden¶

class bloonspy.exceptions.NotLoaded¶

New in 0.9.0

You attempted to access an unloaded property in a lazy-loaded resource in an asynchronous environment.