Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xmistt/rebootpy/llms.txt

Use this file to discover all available pages before exploring further.

Enumerations provide type-safe constants for various Fortnite-related values. All enums inherit from the base Enum class which provides additional helper methods.

​
Base Enum Class

All enums in rebootpy inherit from a custom Enum class that extends Python’s standard enum.Enum:

​
Methods

​
get_random_member()
classmethod
Returns a random member from the enum.Returns: Optional enum member
​
get_random_name()
classmethod
Returns the name of a random enum member.Returns: Optional[str]
​
get_random_value()
classmethod
Returns the value of a random enum member.Returns: Optional[Any]

​
PartyPrivacy

Defines privacy settings for parties.

​
Members

​
PUBLIC
dict
Party is open to everyone.
{
    'partyType': 'Public',
    'inviteRestriction': 'AnyMember',
    'onlyLeaderFriendsCanJoin': False,
    'presencePermission': 'Anyone',
    'invitePermission': 'Anyone',
    'acceptingMembers': True
}
​
FRIENDS_ALLOW_FRIENDS_OF_FRIENDS
dict
Friends-only party that allows friends of friends.
{
    'partyType': 'FriendsOnly',
    'inviteRestriction': 'AnyMember',
    'onlyLeaderFriendsCanJoin': False,
    'presencePermission': 'Anyone',
    'invitePermission': 'AnyMember',
    'acceptingMembers': True
}
​
FRIENDS
dict
Friends-only party restricted to leader’s friends.
{
    'partyType': 'FriendsOnly',
    'inviteRestriction': 'LeaderOnly',
    'onlyLeaderFriendsCanJoin': True,
    'presencePermission': 'Leader',
    'invitePermission': 'Leader',
    'acceptingMembers': False
}
​
PRIVATE_ALLOW_FRIENDS_OF_FRIENDS
dict
Private party that allows friends of friends.
{
    'partyType': 'Private',
    'inviteRestriction': 'AnyMember',
    'onlyLeaderFriendsCanJoin': False,
    'presencePermission': 'Noone',
    'invitePermission': 'AnyMember',
    'acceptingMembers': False
}
​
PRIVATE
dict
Fully private party.
{
    'partyType': 'Private',
    'inviteRestriction': 'LeaderOnly',
    'onlyLeaderFriendsCanJoin': True,
    'presencePermission': 'Noone',
    'invitePermission': 'Leader',
    'acceptingMembers': False
}

​
Example

await party.set_privacy(rebootpy.PartyPrivacy.PRIVATE)

​
PartyDiscoverability

Defines party discoverability settings.

​
Members

​
ALL
str
Value: "ALL"Party is discoverable by all.
​
INVITED_ONLY
str
Value: "INVITED_ONLY"Party is only discoverable by invited members.

​
PartyJoinability

Defines who can join the party.

​
Members

​
OPEN
str
Value: "OPEN"Party is open for anyone to join.
​
INVITE_ONLY
str
Value: "INVITE_ONLY"Party requires an invite to join.
​
INVITE_AND_FORMER
str
Value: "INVITE_AND_FORMER"Party can be joined by invited members and former members.

​
Platform

Fortnite platform identifiers.

​
Members

​
WINDOWS
str
Value: "WIN"
​
MAC
str
Value: "MAC"
​
PLAYSTATION / PLAYSTATION_4
str
Value: "PSN"PlayStation 4 platform.
​
PLAYSTATION_5
str
Value: "PS5"
​
XBOX / XBOX_ONE
str
Value: "XBL"Xbox One platform.
​
XBOX_X
str
Value: "XSX"Xbox Series X/S platform.
​
SWITCH
str
Value: "SWT"
​
IOS
str
Value: "IOS"
​
ANDROID
str
Value: "AND"
​
SWITCH_2
str
Value: "SWT2"
​
UNKNOWN
str
Value: "UNKNOWN"Default value for unrecognized platforms.

​
Region

Fortnite server regions.

​
Members

​
NAEAST
str
Value: "NAE" - North America East
​
NAWEST
str
Value: "NAW" - North America West
​
NACENTRAL
str
Value: "NAC" - North America Central
​
EUROPE
str
Value: "EU" - Europe
​
BRAZIL
str
Value: "BR" - Brazil
​
OCEANIA
str
Value: "OCE" - Oceania
​
ASIA
str
Value: "ASIA" - Asia
​
MIDDLEEAST
str
Value: "ME" - Middle East

​
ReadyState

Party member ready states.

​
Members

​
READY
str
Value: "Ready"Member is ready to play.
​
NOT_READY
str
Value: "NotReady"Member is not ready.
​
SITTING_OUT
str
Value: "SittingOut"Member is sitting out.
​
SLEEPING
str
Value: "Away"Member is away.

​
Example

await client.party.me.set_ready(rebootpy.ReadyState.READY)

​
AwayStatus

Presence away status.

​
Members

​
ONLINE
None
User is online and active.
​
AWAY
str
Value: "away"User is away.
​
EXTENDED_AWAY
str
Value: "xa"User is extended away (away for a long time).

​
Season

Fortnite seasons with their metadata.

​
Attributes

Each season member has the following attributes:
​
start_timestamp
int
Unix timestamp when the season started.
​
end_timestamp
int
Unix timestamp when the season ended.
​
battlepass_level
Optional[str | tuple]
Battle pass level identifier(s) for the season.
​
ranked_tracks
Optional[tuple]
Ranked track identifiers for the season (available from Chapter 4 Season 2 onwards).

​
Members

Chapter 1
  • C1S1 - Season 1
  • C1S2 - Season 2
  • C1S3 - Season 3
  • C1S4 - Season 4
  • C1S5 - Season 5
  • C1S6 - Season 6
  • C1S7 - Season 7
  • C1S8 - Season 8
  • C1S9 - Season 9
  • C1SX - Season X
Chapter 2
  • C2S1 - Season 1
  • C2S2 - Season 2
  • C2S3 - Season 3
  • C2S4 - Season 4
  • C2S5 - Season 5
  • C2S6 - Season 6
  • C2S7 - Season 7
  • C2S8 - Season 8
Chapter 3
  • C3S1 - Season 1
  • C3S2 - Season 2
  • C3S3 - Season 3
  • C3S4 - Season 4
Chapter 4
  • C4S1 - Season 1
  • C4S2 - Season 2
  • C4S3 - Season 3
  • C4S4 - Season 4
  • C4SOG - Season OG
Chapter 5
  • C5S1 - Season 1
  • C5S2 - Season 2
  • C5S3 - Season 3
  • C5S4 - Season 4
  • C5SOG - Season OG
Chapter 6
  • C6S1 - Season 1

​
Example

season = rebootpy.Season.C5S4
print(f"Season started: {season.start_timestamp}")
print(f"Ranked tracks: {season.ranked_tracks}")

​
RankingType

Ranked game mode types.

​
Members

​
BATTLE_ROYALE
str
Value: "ranked-br"Standard Battle Royale ranked mode.
​
ZERO_BUILD
str
Value: "ranked-zb"Zero Build ranked mode.
​
ROCKET_RACING
str
Value: "delmar-competitive"Rocket Racing competitive mode.
​
RELOAD
str
Value: "ranked_blastberry_build"Reload mode with building.
​
RELOAD_ZB
str
Value: "ranked_blastberry_nobuild"Reload mode without building.
​
BALLISTIC
str
Value: "ranked-feral"Ballistic ranked mode.
​
OG
str
Value: "ranked-figment-build"OG mode with building.
​
OG_ZERO_BUILD
str
Value: "ranked-figment-nobuild"OG mode without building.
​
CROWN_JAM
str
Value: "ranked-pimlico"Crown Jam ranked mode.

​
Rank

Ranked mode tiers.

​
Members

​
UNRANKED
None
Player has no rank.
​
BRONZE_1
int
Value: 0 - Bronze I
​
BRONZE_2
int
Value: 1 - Bronze II
​
BRONZE_3
int
Value: 2 - Bronze III
​
SILVER_1
int
Value: 3 - Silver I
​
SILVER_2
int
Value: 4 - Silver II
​
SILVER_3
int
Value: 5 - Silver III
​
GOLD_1
int
Value: 6 - Gold I
​
GOLD_2
int
Value: 7 - Gold II
​
GOLD_3
int
Value: 8 - Gold III
​
PLATINUM_1
int
Value: 9 - Platinum I
​
PLATINUM_2
int
Value: 10 - Platinum II
​
PLATINUM_3
int
Value: 11 - Platinum III
​
DIAMOND_1
int
Value: 12 - Diamond I
​
DIAMOND_2
int
Value: 13 - Diamond II
​
DIAMOND_3
int
Value: 14 - Diamond III
​
ELITE
int
Value: 15 - Elite
​
CHAMPION
int
Value: 16 - Champion
​
UNREAL
int
Value: 17 - Unreal

​
StatsCollectionType

Types of collectible stats.

​
Members

​
FISH
str
Value: "collection_fish"Fish collection statistics.
​
CHARACTER
str
Value: "collection_character"Character collection statistics.

​
V2Input

Input method types for V2 endpoints.

​
Members

​
KEYBOARDANDMOUSE
str
Value: "keyboardmouse"
​
GAMEPAD
str
Value: "gamepad"
​
TOUCH
str
Value: "touch"

​
UserSearchPlatform

Platforms for user search operations.

​
Members

​
EPIC_GAMES
str
Value: "epic"
​
PLAYSTATION
str
Value: "psn"
​
XBOX
str
Value: "xbl"
​
STEAM
str
Value: "steam"

​
UserSearchMatchType

Match types for user searches.

​
Members

​
EXACT
str
Value: "exact"Exact username match.
​
PREFIX
str
Value: "prefix"Username prefix match.

​
DefaultCharactersChapter1

Default character IDs from Fortnite Chapter 1.

​
Members

  • CID_001_Athena_Commando_F_Default - Value: 1
  • CID_002_Athena_Commando_F_Default - Value: 2
  • CID_003_Athena_Commando_F_Default - Value: 3
  • CID_004_Athena_Commando_F_Default - Value: 4
  • CID_005_Athena_Commando_M_Default - Value: 5
  • CID_006_Athena_Commando_M_Default - Value: 6
  • CID_007_Athena_Commando_M_Default - Value: 7
  • CID_008_Athena_Commando_M_Default - Value: 8

​
DefaultCharactersChapter2

Default character IDs from Fortnite Chapter 2.

​
Members

  • CID_556_Athena_Commando_F_RebirthDefaultA - Value: 1
  • CID_557_Athena_Commando_F_RebirthDefaultB - Value: 2
  • CID_558_Athena_Commando_F_RebirthDefaultC - Value: 3
  • CID_559_Athena_Commando_F_RebirthDefaultD - Value: 4
  • CID_560_Athena_Commando_M_RebirthDefaultA - Value: 5
  • CID_561_Athena_Commando_M_RebirthDefaultB - Value: 6
  • CID_562_Athena_Commando_M_RebirthDefaultC - Value: 7
  • CID_563_Athena_Commando_M_RebirthDefaultD - Value: 8

​
DefaultCharactersChapter3

Default character IDs from Fortnite Chapter 3.

​
Members

  • CID_A_272_Athena_Commando_F_Prime - Value: 1
  • CID_A_273_Athena_Commando_F_Prime_B - Value: 2
  • CID_A_274_Athena_Commando_F_Prime_C - Value: 3
  • CID_A_275_Athena_Commando_F_Prime_D - Value: 4
  • CID_A_276_Athena_Commando_F_Prime_E - Value: 5
  • CID_A_277_Athena_Commando_F_Prime_F - Value: 6
  • CID_A_278_Athena_Commando_F_Prime_G - Value: 7
  • CID_A_279_Athena_Commando_M_Prime - Value: 8
  • CID_A_280_Athena_Commando_M_Prime_B - Value: 9
  • CID_A_281_Athena_Commando_M_Prime_C - Value: 10
  • CID_A_282_Athena_Commando_M_Prime_D - Value: 11
  • CID_A_283_Athena_Commando_M_Prime_E - Value: 12
  • CID_A_284_Athena_Commando_M_Prime_F - Value: 13
  • CID_A_285_Athena_Commando_M_Prime_G - Value: 14

​
Country

Country identifiers for leaderboards and region-specific features.

​
Members

  • ARGENTINA - Value: "argentina"
  • AUSTRALIA - Value: "australia"
  • BELARUS - Value: "belarus"
  • BELGIUM - Value: "belgium"
  • BRAZIL - Value: "brazil"
  • CANADA - Value: "canada"
  • COLOMBIA - Value: "colombia"
  • CZECHREPUBLIC - Value: "czechrepublic"
  • DENMARK - Value: "denmark"
  • EGYPT - Value: "egypt"
  • ENGLAND - Value: "england"
  • FRANCE - Value: "france"
  • GERMANY - Value: "germany"
  • GLOBAL - Value: "global"
  • ICELAND - Value: "iceland"
  • IRELAND - Value: "ireland"
  • ITALY - Value: "italy"
  • JAPAN - Value: "japan"
  • LATVIA - Value: "latvia"
  • MEXICO - Value: "mexico"
  • NETHERLANDS - Value: "netherlands"
  • NEWZEALAND - Value: "newzealand"
  • NIGERIA - Value: "nigeria"
  • NORWAY - Value: "norway"
  • POLAND - Value: "poland"
  • PORTUGAL - Value: "portugal"
  • RUSSIA - Value: "russia"
  • SAUDIARABIA - Value: "saudiarabia"
  • SCOTLAND - Value: "scotland"
  • SOUTHKOREA - Value: "southkorea"
  • SPAIN - Value: "spain"
  • SWEDEN - Value: "sweden"
  • SWITZERLAND - Value: "switzerland"
  • TURKEY - Value: "turkey"
  • UKRAINE - Value: "ukraine"
  • UNITEDKINGDOM - Value: "unitedkingdom"
  • UNITEDSTATES - Value: "unitedstates"
  • URUGUAY - Value: "uruguay"
  • WALES - Value: "wales"

Build docs developers (and LLMs) love

Get started for freeTalk to us