API Reference

This is the API reference for the library. It contains all the classes and functions that are available in the library. See Installation for installation instructions.

Don’t know where to start? Check out the Clients documentation to get started with the library.

• Clients
  • Client
  • SyncClient
• Base Classes
  • IdComparable
  • Hashable
  • ReconstructAble
• Objects
  • Account
  • Aes
  • Version
  • DynamicKey
  • CosmeticsAll
  • Asset
  • Banner
  • BannerColor
  • CreatorCode
  • Images
  • Map
  • MapImages
  • POI
  • POILocation
  • MaterialInstanceImages
  • MaterialInstanceColors
  • MaterialInstance
  • NewCosmetic
  • NewCosmetics
  • News
  • GameModeNews
  • NewsMotd
  • NewsMessage
  • PlaylistImages
  • Playlist
  • ShopEntryBundle
  • ShopEntryBanner
  • ShopEntryLayout
  • ShopEntryNewDisplayAsset
  • ShopEntry
  • Shop
  • TileSize
  • BrPlayerStats
  • BrBattlePass
  • BrInputs
  • BrInputStats
  • BrGameModeStats
  • Cosmetic Objects
  • Cosmetic Variants
  • Flags
  • Enumerations
  • Helper Utilities
• Exceptions
  • Exception Hierarchy
  • Exception Classes