API Reference

APIClient

Methods
class FortniteAPIAsync.APIClient[source]
await get_aes(key_format=AESKeyFormat.HEX)[source]

This function is a coroutine.

Return information about the current build including the main aes key and all dynamic keys.

Parameters:

key_format (AESKeyFormat) – Sets the AES key format, defaults to AESKeyFormat.HEX.

Return type:

AESKeys

await get_creator_code(name)[source]

This function is a coroutine.

Return all information about a specific Creator Code such as owner’s Epic account, whether its verified and whether its active.

Parameters:

name (str) – The creator code to get information for.

Return type:

CreatorCode

await get_map(language='en')[source]

This function is a coroutine.

Returns information about the current Battle Royale map.

Parameters:

language (Optional[str]) – Sets the output language.

Return type:

Map

await get_news(language='en')[source]

This function is a coroutine.

Get the current news posts.

Parameters:

language (Optional[str]) – Sets the output language.

Return type:

News

await get_playlists(language='en')[source]

This function is a coroutine.

Get all playlists currently in the game (old in-active playlists will not appear)

Parameters:

language (Optional[str]) – Sets the output language.

Return type:

list[Playlist]

await get_playlist_by_id(playlist_id, language='en')[source]

This function is a coroutine.

Get information about a specific playlist by playlist id (old in-active playlists will not be searchable appear)

Parameters:

  • playlist_id (str) – The playlist id to search for.

  • language (Optional[str]) – Sets the output language.

Return type:

Playlist

await get_stats(name, account_type=AccountType.EPIC, time_window=StatsTimeWindow.LIFETIME, image=StatsImage.NONE)[source]

This function is a coroutine.

Gets Battle Royale stats for the provided username on the provided platform.

Parameters:

  • name (str) – The username to search for.

  • account_type (Optional[AccountType]) – The platform to search the provided name on.

  • time_window (Optional[StatsTimeWindow]) – Stats time window to fetch (lifetime or seasonal).

  • image (Optional[StatsImage]) – Which input to create the image for, if not provided an image won’t be generated.

Return type:

Stats

await get_stats_by_id(account_id, time_window=StatsTimeWindow.LIFETIME, image=StatsImage.NONE)[source]

This function is a coroutine.

Gets Battle Royale stats for the provided account id.

Parameters:

  • account_id (str) – The Epic account id to fetch stats for.

  • time_window (Optional[StatsTimeWindow]) – Stats time window to fetch (lifetime or seasonal).

  • image (Optional[StatsImage]) – Which input to create the image for, if not provided an image won’t be generated.

Return type:

Stats

await get_banners(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Gets information about all banners.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (list`[:class:`ResponseFlags]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Return type:

list[Banners]

await get_banner_colors(language='en')[source]

This function is a coroutine.

Gets information about all banner colours.

Parameters:

language (Optional[str]) – Sets the output language.

Return type:

list[BannerColor]

await get_shop(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Gets the current Battle Royale shop.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (list`[:class:`ResponseFlags]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Return type:

Shop

Cosmetics

Methods

Accessible via APIClient.cosmetics.

class FortniteAPIAsync.Cosmetics[source]
await get_cosmetic(flags=[<ResponseFlags.NONE: 0>], **params)[source]

This function is a coroutine.

Fetches first cosmetic matching parameters. All parameters are optional but at least 1 is required.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

  • searchLanguage (Optional[str]) – Sets the search language.

  • matchMethod (Optional[str]) – Sets the match method for strings (full/contains/starts/ends).

  • id (Optional[str]) – Sets the id.

  • name (Optional[str]) – Sets the name.

  • description (Optional[str]) – Sets the description.

  • type (Optional[str]) – Sets the type.

  • displayType (Optional[str]) – Sets the display type.

  • backendType (Optional[str]) – Sets the backend type.

  • rarity (Optional[str]) – Sets the rarity.

  • displayRarity (Optional[str]) – Sets the display rarity.

  • backendRarity (Optional[str]) – Sets the backend rarity.

  • hasSeries (Optional[bool]) – Sets whether there is a series.

  • series (Optional[str]) – Sets the series.

  • backendSeries (Optional[str]) – Sets the backend series.

  • hasSet (Optional[bool]) – Sets whether there is a set.

  • set (Optional[str]) – Sets the set.

  • setText (Optional[str]) – Sets the set text.

  • backendSet (Optional[str]) – Sets the backend set.

  • hasIntroduction (Optional[bool]) – Sets whether there is an introduction.

  • backendIntroduction (Optional[int]) – Sets the introduction backend value.

  • introductionChapter (Optional[str]) – Sets the introduction chapter.

  • introductionSeason (Optional[str]) – Sets the introduction season.

  • hasFeaturedImage (Optional[bool]) – Sets whether there is a featured image.

  • hasVariants (Optional[bool]) – Sets whether there are variants.

  • hasGameplayTags (Optional[bool]) – Sets whether there are gameplay tags.

  • gameplayTag (Optional[str]) – Sets the gameplay tag.

  • hasMetaTags (Optional[bool]) – Sets whether there are meta tags.

  • metaTag (Optional[str]) – Sets the meta tag.

  • hasDynamicPakId (Optional[bool]) – Sets whether a dynamic pak id is set.

  • dynamicPakId (Optional[str]) – Sets the dynamic pak id.

  • added (Optional[int]) – Sets the added date.

  • addedSince (Optional[int]) – Sets the date since it was added.

  • unseenFor (Optional[int]) – Sets for how long its unseen.

  • lastAppearance (Optional[int]) – Sets the last appearance date.

Raises:

  • InvalidParameters – If none or more than 1 parameter is provided.

  • NotFound – If no cosmetics are found matching parameters.

Returns:

BRCosmetic object containing information of the cosmetic.

Return type:

BRCosmetic

await get_cosmetics(flags=[<ResponseFlags.NONE: 0>], **params)[source]

This function is a coroutine.

Fetches all cosmetics matching parameters. All parameters are optional but at least 1 is required.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

  • searchLanguage (Optional[str]) – Sets the search language.

  • matchMethod (Optional[str]) – Sets the match method for strings (full/contains/starts/ends).

  • id (Optional[str]) – Sets the id.

  • name (Optional[str]) – Sets the name.

  • description (Optional[str]) – Sets the description.

  • type (Optional[str]) – Sets the type.

  • displayType (Optional[str]) – Sets the display type.

  • backendType (Optional[str]) – Sets the backend type.

  • rarity (Optional[str]) – Sets the rarity.

  • displayRarity (Optional[str]) – Sets the display rarity.

  • backendRarity (Optional[str]) – Sets the backend rarity.

  • hasSeries (Optional[bool]) – Sets whether there is a series.

  • series (Optional[str]) – Sets the series.

  • backendSeries (Optional[str]) – Sets the backend series.

  • hasSet (Optional[bool]) – Sets whether there is a set.

  • set (Optional[str]) – Sets the set.

  • setText (Optional[str]) – Sets the set text.

  • backendSet (Optional[str]) – Sets the backend set.

  • hasIntroduction (Optional[bool]) – Sets whether there is an introduction.

  • backendIntroduction (Optional[int]) – Sets the introduction backend value.

  • introductionChapter (Optional[str]) – Sets the introduction chapter.

  • introductionSeason (Optional[str]) – Sets the introduction season.

  • hasFeaturedImage (Optional[bool]) – Sets whether there is a featured image.

  • hasVariants (Optional[bool]) – Sets whether there are variants.

  • hasGameplayTags (Optional[bool]) – Sets whether there are gameplay tags.

  • gameplayTag (Optional[str]) – Sets the gameplay tag.

  • hasMetaTags (Optional[bool]) – Sets whether there are meta tags.

  • metaTag (Optional[str]) – Sets the meta tag.

  • hasDynamicPakId (Optional[bool]) – Sets whether a dynamic pak id is set.

  • dynamicPakId (Optional[str]) – Sets the dynamic pak id.

  • added (Optional[int]) – Sets the added date.

  • addedSince (Optional[int]) – Sets the date since it was added.

  • unseenFor (Optional[int]) – Sets for how long its unseen.

  • lastAppearance (Optional[int]) – Sets the last appearance date.

Raises:

  • InvalidParameters – If none or more than 1 parameter is provided.

  • NotFound – If no cosmetics are found matching parameters.

Returns:

List of BRCosmetic object containing information of the cosmetics.

Return type:

List[BRCosmetic]

await search_cosmetic_ids(fortnite_ids=None, language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all cosmetics from id/s.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • fortnite_ids (Optional[str]) – Sets the cosmetic id (can be multiple).

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Raises:

  • InvalidParameters – If none or more than 1 parameter is provided.

  • NotFound – If no cosmetics are found matching parameters.

Returns:

BRCosmetic object containing information of the cosmetic.

Return type:

BRCosmetic

await get_all_br_cosmetics(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all cosmetics.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Returns:

List of BRCosmetic object containing information of the cosmetics.

Return type:

List[BRCosmetic]

await get_new_cosmetics(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all new cosmetics.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Returns:

NewCosmetics object containing information of each cosmetic types new items.

Return type:

NewCosmetics

await get_cosmetic_from_id(fortnite_id=None, language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches cosmetic from id.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

  • fortnite_id (Optional[str]) – Sets the cosmetic id (can be multiple).

Raises:

  • InvalidParameters – If none or more than 1 parameter is provided.

  • NotFound – If no cosmetics are found matching parameters.

Returns:

BRCosmetic object containing information of the cosmetic.

Return type:

BRCosmetic

await get_all_cosmetics(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all cosmetics.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Returns:

AllCosmetics object containing all types cosmetics.

Return type:

AllCosmetics

await get_all_track_cosmetics(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all track cosmetics.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Returns:

List of TrackCosmetic object containing information of the cosmetics.

Return type:

List[TrackCosmetic]

await get_all_instrument_cosmetics(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all instrument cosmetics.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Returns:

List of InstrumentCosmetic object containing information of the cosmetics.

Return type:

list[InstrumentCosmetic]

await get_all_car_cosmetics(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all car cosmetics.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Returns:

List of CarCosmetic object containing information of the cosmetics.

Return type:

list[CarCosmetic]

await get_all_lego_cosmetics(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all lego cosmetics.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Returns:

List of LegoCosmetic object containing information of the cosmetics.

Return type:

list[LegoCosmetic]

await get_all_lego_kit_cosmetics(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all lego kit cosmetics.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Returns:

List of LegoKitCosmetic object containing information of the cosmetics.

Return type:

list[LegoKitCosmetic]

await get_all_bean_cosmetics(language='en', flags=[<ResponseFlags.NONE: 0>])[source]

This function is a coroutine.

Fetches all bean cosmetics.

Parameters:

  • language (Optional[str]) – Sets the output language.

  • flags (Optional[list`[:class:`ResponseFlags]]) – Opt-in for certain properties, defaults to [ResponseFlags.NONE].

Returns:

List of BeanCosmetic object containing information of the cosmetics.

Return type:

list[BeanCosmetic]

Enumerations

class FortniteAPIAsync.AccountType[source]

An enumeration for supported account types.

EPIC

Epic Games account.

PLAYSTATION

PlayStation Network account.

XBOX

Xbox Live account.

class FortniteAPIAsync.StatsTimeWindow[source]

An enumeration for available statistics time windows.

SEASON

Statistics scoped to the current season.

LIFETIME

Statistics scoped to the entire account lifetime.

class FortniteAPIAsync.StatsImage[source]

An enumeration for available statistics input images.

ALL

Statistics aggregated across all input types.

KEYBOARD_AND_MOUSE

Statistics for keyboard and mouse input.

CONTROLLER

Statistics for controller input.

TOUCH

Statistics for touch input.

NONE

No input image applied.

class FortniteAPIAsync.AESKeyFormat[source]

An enumeration for AES key output formats.

HEX

AES key encoded in hexadecimal format.

BASE64

AES key encoded in base64 format.

class FortniteAPIAsync.ResponseFlags[source]

An enumeration of flags used to opt-in to additional API response properties.

These flags will be automatically combined using bitwise operations.

NONE

Do not include any optional response properties.

INCLUDE_PATHS

Include file path related properties in the response.

INCLUDE_GAMEPLAY_TAGS

Include gameplay tags in the response.

INCLUDE_SHOP_HISTORY

Include shop history information in the response.

Data Models

BRCosmetic

Attributes
class FortniteAPIAsync.BRCosmetic[source]

Represents a Fortnite cosmetic.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

id

The ID of the cosmetic.

Type:

str

name

The name of the cosmetic.

Type:

str

description

The description of the cosmetic.

Type:

str

exclusive_description

The exclusive description of the cosmetic.

Type:

str

unlock_requirements

The unlock requirements of the cosmetic.

Type:

str

custom_exclusive_callout

The custom exclusive callout of the cosmetic.

Type:

str

type

Object containing information on cosmetic type.

Type:

CosmeticType

rarity

Object containing information on cosmetic rarity.

Type:

Rarity

series

Object containing information on cosmetic series.

Type:

Series

set

Object containing information on cosmetic set.

Type:

Set

introduction

Object containing information on cosmetic introduction.

Type:

Introduction

images

Dictionary containing the images of the cosmetic.

Type:

dict

variants

List containing information on cosmetic variants.

Type:

list`[:class:`dict]

built_in_emote_ids

List of the cosmetic’s built-in emote IDs.

Type:

list`[:class:`str]

search_tags

List of the cosmetic’s search tags.

Type:

list`[:class:`str]

gameplay_tags

List of the cosmetics gameplay tags.

Type:

list`[:class:`str]

meta_tags

List of the cosmetic’s meta tags.

Type:

list`[:class:`str]

showcase_video

Represents a YouTube video id of a video showcasing the cosmetic.

Type:

str

dynamic_pak_id

Represents the dynamic pak id of the cosmetic.

Type:

str

item_preview_hero_path

Represents the item preview hero path of the cosmetic.

Type:

str

display_asset_path

File path of the display asset.

Type:

str

definition_path

File path of the cosmetic definition

Type:

str

path

File path of cosmetic.

Type:

str

added

Datetime object which represents when the cosmetic was added to the API.

Type:

datetime.datetime

shop_history

List of datetime objects which represent a shop release.

Type:

list`[:class:`datetime.datetime]

CosmeticType

Attributes
class FortniteAPIAsync.CosmeticType[source]

Represents a cosmetic type.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

value

The cosmetic type value.

Type:

str

display_value

The display value of the cosmetic type.

Type:

str

backend_value

The backend value of the cosmetic type.

Type:

str

Rarity

Attributes
class FortniteAPIAsync.Rarity[source]

Represents a cosmetic rarity.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

value

The cosmetic rarity value.

Type:

str

display_value

The display value of the cosmetic rarity.

Type:

str

backend_value

The backend value of the cosmetic rarity.

Type:

str

Series

Attributes
class FortniteAPIAsync.Series[source]

Represents a cosmetic series.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

value

The cosmetic series value.

Type:

str

image

The image associated with the cosmetic series.

Type:

str

colors

List of colors associated with the cosmetic series.

Type:

list`[:class:`str]

backend_value

The backend value of the cosmetic series.

Type:

str

Introduction

Attributes
class FortniteAPIAsync.Introduction[source]

Represents cosmetic introduction information.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

chapter

The chapter the cosmetic was introduced in.

Type:

str

season

The season the cosmetic was introduced in.

Type:

str

text

The introduction text of the cosmetic.

Type:

str

backend_value

The backend value of the cosmetic introduction.

Type:

str

Set

Attributes
class FortniteAPIAsync.Set[source]

Represents a cosmetic set.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

value

The cosmetic set value.

Type:

str

text

The text associated with the cosmetic set.

Type:

str

backend_value

The backend value of the cosmetic set.

Type:

str

TrackDifficulty

Attributes
class FortniteAPIAsync.TrackDifficulty[source]

Represents track difficulty values.

vocals

The vocal difficulty rating.

Type:

int

guitar

The guitar difficulty rating.

Type:

int

bass

The bass difficulty rating.

Type:

int

plastic_bass

The plastic bass difficulty rating.

Type:

int

drums

The drums difficulty rating.

Type:

int

plastic_drums

The plastic drums difficulty rating.

Type:

int

TrackCosmetic

Attributes
class FortniteAPIAsync.TrackCosmetic[source]

Represents a track cosmetic.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

id

The ID of the track cosmetic.

Type:

str

dev_name

The developer name of the track.

Type:

str

title

The title of the track.

Type:

str

artist

The artist of the track.

Type:

str

album

The album the track belongs to.

Type:

str

release_year

The release year of the track.

Type:

int

bpm

The beats per minute of the track.

Type:

int

duration

The duration of the track in seconds.

Type:

int

difficulty

Object containing difficulty information for the track.

Type:

TrackDifficulty

gameplay_tags

List of gameplay tags associated with the track.

Type:

list`[:class:`str]

genres

List of genres associated with the track.

Type:

list`[:class:`str]

album_art

The album art image for the track.

Type:

str

added

Datetime object which represents when the track was added to the API.

Type:

datetime.datetime

shop_history

List of datetime objects which represent a shop release.

Type:

list`[:class:`datetime.datetime]

InstrumentCosmetic

Attributes
class FortniteAPIAsync.InstrumentCosmetic[source]

Represents an instrument cosmetic.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

id

The ID of the instrument cosmetic.

Type:

str

name

The name of the instrument cosmetic.

Type:

str

description

The description of the instrument cosmetic.

Type:

str

type

Object containing information on cosmetic type.

Type:

CosmeticType

rarity

Object containing information on cosmetic rarity.

Type:

Rarity

small_image

The small image of the instrument cosmetic.

Type:

str

large_image

The large image of the instrument cosmetic.

Type:

str

series

Object containing information on cosmetic series.

Type:

Series

gameplay_tags

List of the instrument cosmetic gameplay tags.

Type:

list`[:class:`str]

path

File path of cosmetic.

Type:

str

showcase_video

Represents a YouTube video id of a video showcasing the instrument cosmetic.

Type:

str

added

Datetime object which represents when the instrument cosmetic was added to the API.

Type:

datetime.datetime

shop_history

List of datetime objects which represent a shop release.

Type:

list`[:class:`datetime.datetime]

CarCosmetic

Attributes
class FortniteAPIAsync.CarCosmetic[source]

Represents a car cosmetic.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

id

The ID of the car cosmetic.

Type:

str

vehicle_id

The vehicle ID associated with the car cosmetic.

Type:

str

name

The name of the car cosmetic.

Type:

str

description

The description of the car cosmetic.

Type:

str

type

Object containing information on cosmetic type.

Type:

CosmeticType

rarity

Object containing information on cosmetic rarity.

Type:

Rarity

small_image

The small image of the car cosmetic.

Type:

str

large_image

The large image of the car cosmetic.

Type:

str

series

Object containing information on cosmetic series.

Type:

Series

gameplay_tags

List of the car cosmetic gameplay tags.

Type:

list`[:class:`str]

path

File path of cosmetic.

Type:

str

showcase_video

Represents a YouTube video id of a video showcasing the car cosmetic.

Type:

str

added

Datetime object which represents when the car cosmetic was added to the API.

Type:

datetime.datetime

shop_history

List of datetime objects which represent a shop release.

Type:

list`[:class:`datetime.datetime]

LegoCosmetic

Attributes
class FortniteAPIAsync.LegoCosmetic[source]

Represents a LEGO cosmetic.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

id

The ID of the LEGO cosmetic.

Type:

str

cosmetic_id

The associated cosmetic ID.

Type:

str

sound_library_tags

List of sound library tags associated with the LEGO cosmetic.

Type:

list`[:class:`str]

small_image

The small image of the LEGO cosmetic.

Type:

str

large_image

The large image of the LEGO cosmetic.

Type:

str

wide_image

The wide image of the LEGO cosmetic.

Type:

str

path

File path of cosmetic.

Type:

str

added

Datetime object which represents when the LEGO cosmetic was added to the API.

Type:

datetime.datetime

LegoKitCosmetic

Attributes
class FortniteAPIAsync.LegoKitCosmetic[source]

Represents a LEGO kit cosmetic.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

id

The ID of the LEGO kit cosmetic.

Type:

str

name

The name of the LEGO kit cosmetic.

Type:

str

type

Object containing information on cosmetic type.

Type:

CosmeticType

value

The value of the LEGO kit cosmetic.

Type:

str

display_value

The display value of the LEGO kit cosmetic.

Type:

str

backend_value

The backend value of the LEGO kit cosmetic.

Type:

str

series

Object containing information on cosmetic series.

Type:

Series

gameplay_tags

List of the LEGO kit cosmetic gameplay tags.

Type:

list`[:class:`str]

small_image

The small image of the LEGO kit cosmetic.

Type:

str

large_image

The large image of the LEGO kit cosmetic.

Type:

str

wide_image

The wide image of the LEGO kit cosmetic.

Type:

str

path

File path of cosmetic.

Type:

str

added

Datetime object which represents when the LEGO kit cosmetic was added to the API.

Type:

datetime.datetime

shop_history

List of datetime objects which represent a shop release.

Type:

list`[:class:`datetime.datetime]

BeanCosmetic

Attributes
class FortniteAPIAsync.BeanCosmetic[source]

Represents a Bean cosmetic.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

id

The ID of the Bean cosmetic.

Type:

str

cosmetic_id

The associated cosmetic ID.

Type:

str

name

The name of the Bean cosmetic.

Type:

str

gender

The gender of the Bean cosmetic.

Type:

str

gameplay_tags

List of the Bean cosmetic gameplay tags.

Type:

list`[:class:`str]

small_image

The small image of the Bean cosmetic.

Type:

str

large_image

The large image of the Bean cosmetic.

Type:

str

path

File path of cosmetic.

Type:

str

added

Datetime object which represents when the Bean cosmetic was added to the API.

Type:

datetime.datetime

AllCosmetics

Attributes
class FortniteAPIAsync.AllCosmetics[source]

Represents all cosmetics grouped by type.

br

List of Battle Royale cosmetics.

Type:

list`[:class:`BRCosmetic]

tracks

List of track cosmetics.

Type:

list`[:class:`TrackCosmetic]

instruments

List of instrument cosmetics.

Type:

list`[:class:`InstrumentCosmetic]

cars

List of car cosmetics.

Type:

list`[:class:`CarCosmetic]

lego

List of LEGO cosmetics.

Type:

list`[:class:`LegoCosmetic]

lego_kits

List of LEGO kit cosmetics.

Type:

list`[:class:`LegoKitCosmetic]

beans

List of Bean cosmetics.

Type:

list`[:class:`BeanCosmetic]

NewCosmeticsType

Attributes
class FortniteAPIAsync.NewCosmeticsType[source]

Represents a grouped set of newly added cosmetics of a specific type.

hash

Hash of the cosmetic data used to detect changes.

Type:

str

last_addition

Datetime of the most recent addition for the cosmetic type.

Type:

datetime.datetime

items

List of cosmetics of the given type.

Type:

list

NewCosmetics

Attributes
class FortniteAPIAsync.NewCosmetics[source]

Represents newly added cosmetics.

date

Datetime when the new cosmetics data was generated.

Type:

datetime.datetime

hash

Hash of all cosmetic data used for change detection.

Type:

str

last_addition

Datetime string of the most recent cosmetic addition.

Type:

str

build

The current Fortnite build version.

Type:

str

previous_build

The previous Fortnite build version.

Type:

str

br

Newly added Battle Royale cosmetics.

Type:

NewCosmeticsType

tracks

Newly added track cosmetics.

Type:

NewCosmeticsType

instruments

Newly added instrument cosmetics.

Type:

NewCosmeticsType

cars

Newly added car cosmetics.

Type:

NewCosmeticsType

lego

Newly added LEGO cosmetics.

Type:

NewCosmeticsType

lego_kits

Newly added LEGO kit cosmetics.

Type:

NewCosmeticsType

beans

Newly added Bean cosmetics.

Type:

NewCosmeticsType

AESKeys

Attributes
class FortniteAPIAsync.AESKeys[source]

Represents AES encryption keys.

build

The Fortnite build version the keys apply to.

Type:

str

main_key

The main AES encryption key.

Type:

str

updated

Datetime when the keys were last updated.

Type:

datetime.datetime

dynamic_keys

List of dynamic AES keys.

Type:

list`[:class:`DynamicAESKey]

DynamicAESKey

Attributes
class FortniteAPIAsync.DynamicAESKey[source]

Represents a dynamic AES key.

filename

The pak filename associated with the key.

Type:

str

guid

The GUID of the pak file.

Type:

str

key

The AES encryption key.

Type:

str

BannerColor

Attributes
class FortniteAPIAsync.BannerColor[source]

Represents a banner color.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

id

The ID of the banner color.

Type:

str

color

The color value of the banner.

Type:

str

category

The category of the banner color.

Type:

str

sub_category_group

The sub-category group of the banner color.

Type:

str

CreatorCode

Attributes
class FortniteAPIAsync.CreatorCode[source]

Represents a creator code.

code

The creator code.

Type:

str

account_id

The account ID of the account associated with the creator code.

Type:

str

display_name

The display name of the account associated with the creator code.

Type:

str

status

The status of the creator code.

Type:

str

verified

Whether the creator code is verified.

Type:

bool

Map

Attributes
class FortniteAPIAsync.Map[source]

Represents the current Fortnite Battle Royale map.

blank_image

An image of the map without POIs labelled.

Type:

str

pois_image

An image of the map with POIs labelled.

Type:

str

pois

List of points of interest on the map.

Type:

list`[:class:`POI]

POI

Attributes
class FortniteAPIAsync.POI[source]

Represents a point of interest on the map.

id

The ID of the POI.

Type:

str

name

The name of the POI.

Type:

str

x

The X coordinate of the POI.

Type:

float

y

The Y coordinate of the POI.

Type:

float

z

The Z coordinate of the POI.

Type:

float

News

Attributes
class FortniteAPIAsync.News[source]

Represents Fortnite news.

hash

Hash of the news data used for change detection.

Type:

str

image

An animated gif of the current news posts.

Type:

str

updated

Datetime when the news was last updated.

Type:

datetime.datetime

posts

List of news posts.

Type:

list`[:class:`NewsPost]

NewsPost

Attributes
class FortniteAPIAsync.NewsPost[source]

Represents a news post.

id

The ID of the news post.

Type:

str

title

The title of the news post.

Type:

str

tab_title

The tab title of the news post.

Type:

str

body

The body text of the news post.

Type:

str

image

The image associated with the news post.

Type:

str

tile_image

The tile image of the news post.

Type:

str

sorting_priority

The sorting priority of the news post.

Type:

int

hidden

Whether the news post is hidden.

Type:

bool

Playlist

Attributes
class FortniteAPIAsync.Playlist[source]

Represents a Fortnite playlist.

id

The ID of the playlist.

Type:

str

name

The name of the playlist.

Type:

str

game_type

The game type of the playlist.

Type:

str

min_players

The minimum number of players.

Type:

int

max_players

The maximum number of players.

Type:

int

max_teams

The maximum number of teams.

Type:

int

max_team_size

The maximum team size.

Type:

int

max_squads

The maximum number of squads.

Type:

int

max_squad_size

The maximum squad size.

Type:

int

is_default

Whether the playlist is a default playlist.

Type:

bool

is_tournament

Whether the playlist is a tournament playlist.

Type:

bool

is_ltm

Whether the playlist is a limited time mode.

Type:

bool

is_large_team_game

Whether the playlist is a large team game mode.

Type:

bool

accumulate_to_profile_stats

Whether matches count towards profile statistics (this value is not actually used for anything and isn’t an indicator of whether or not the playlist accumulates to profile stats on websites such as FortniteTracker).

Type:

bool

gameplay_tags

List of gameplay tags associated with the playlist.

Type:

list`[:class:`str]

path

File path of playlist.

Type:

str

added

Datetime object which represents when the playlist was added to the API.

Type:

datetime.datetime

GamemodeStats

Attributes
class FortniteAPIAsync.GamemodeStats[source]

Represents statistics for a specific game mode.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

score

The total score.

Type:

int

score_per_min

The score earned per minute.

Type:

float

score_per_match

The score earned per match.

Type:

float

wins

The number of wins.

Type:

int

top_3

The number of top 3 finishes.

Type:

int

top_5

The number of top 5 finishes.

Type:

int

top_6

The number of top 6 finishes.

Type:

int

top_10

The number of top 10 finishes.

Type:

int

top_12

The number of top 12 finishes.

Type:

int

top_25

The number of top 25 finishes.

Type:

int

kills

The total number of kills.

Type:

int

kills_per_min

The number of kills per minute.

Type:

float

kills_per_match

The number of kills per match.

Type:

float

deaths

The total number of deaths.

Type:

int

kd

The kill/death ratio.

Type:

float

matches

The total number of matches played.

Type:

int

win_rate

The win rate percentage.

Type:

float

minutes_played

The total number of minutes played.

Type:

int

players_outlived

The total number of players outlived.

Type:

int

last_modified

Datetime when the stats were last modified.

Type:

datetime.datetime

Stats

Attributes
class FortniteAPIAsync.Stats[source]

Represents player statistics.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

id

The account ID of the player.

Type:

str

display_name

The display name of the player.

Type:

str

level

The current Battle Pass level.

Type:

int

level_progress

The Battle Pass level progress.

Type:

int

image

URL of the rendered stats image.

Type:

str

inputs

Dictionary mapping input types to input-specific stats.

Type:

dict

ShopBundle

Attributes
class FortniteAPIAsync.ShopBundle[source]

Represents a shop bundle.

name

The name of the bundle.

Type:

str

info

Additional information about the bundle.

Type:

str

image

The image associated with the bundle.

Type:

str

ShopBanner

Attributes
class FortniteAPIAsync.ShopBanner[source]

Represents a shop banner.

value

The banner value.

Type:

str

intensity

The banner intensity.

Type:

str

backend_value

The backend value of the banner.

Type:

str

OfferTag

Attributes
class FortniteAPIAsync.OfferTag[source]

Represents an offer tag.

id

The ID of the offer tag.

Type:

str

text

The text of the offer tag.

Type:

str

Layout

Attributes
class FortniteAPIAsync.Layout[source]

Represents a shop layout.

id

The ID of the layout.

Type:

str

name

The name of the layout.

Type:

str

category

The category of the layout.

Type:

str

index

The index of the layout.

Type:

int

rank

The rank of the layout.

Type:

int

show_ineligible_offers

Whether ineligible offers are shown.

Type:

bool

background

The background of the layout.

Type:

str

use_wide_preview

Whether wide preview is used.

Type:

bool

display_type

The display type of the layout.

Type:

str

texture_metadata

List of texture metadata.

Type:

list

string_metadata

List of string metadata.

Type:

list

text_metadata

List of text metadata.

Type:

list

Colors

Attributes
class FortniteAPIAsync.Colors[source]

Represents colour configuration.

color_1

The primary colour.

Type:

str

color_2

The secondary colour.

Type:

str

color_3

The tertiary colour.

Type:

str

text_background_color

The text background colour.

Type:

str

MaterialInstances

Attributes
class FortniteAPIAsync.MaterialInstances[source]

Represents a material instance.

id

The ID of the material instance.

Type:

str

primary_mode

The primary mode of the material instance.

Type:

str

product_tag

The product tag associated with the material instance.

Type:

str

images

Image data for the material instance.

Type:

dict

colors

Color data for the material instance.

Type:

dict

scalings

Scaling data for the material instance.

Type:

dict

flags

Flag data for the material instance.

Type:

dict

RenderImages

Attributes
class FortniteAPIAsync.RenderImages[source]

Represents a render image.

product_tag

The product tag associated with the render image.

Type:

str

file_name

The file name of the render image.

Type:

str

image

The render image URL.

Type:

str

NewDisplayAsset

Attributes
class FortniteAPIAsync.NewDisplayAsset[source]

Represents a new display asset.

id

The ID of the display asset.

Type:

str

cosmetic_id

The associated cosmetic ID.

Type:

str

material_instances

List of material instances.

Type:

list`[:class:`MaterialInstances]

render_images

List of render images.

Type:

list`[:class:`RenderImages]

ShopEntry

Attributes
class FortniteAPIAsync.ShopEntry[source]

Represents a shop entry.

regular_price

The regular price of the offer.

Type:

int

final_price

The final price of the offer.

Type:

int

dev_name

The developer name of the offer.

Type:

str

offer_id

The offer ID.

Type:

str

in_date

Datetime when the offer becomes available.

Type:

datetime.datetime

out_date

Datetime when the offer is removed.

Type:

datetime.datetime

bundle

Bundle information for the offer.

Type:

ShopBundle

banner

Banner information for the offer.

Type:

ShopBanner

offer_tag

Offer tag associated with the entry.

Type:

OfferTag

giftable

Whether the offer is giftable.

Type:

bool

refundable

Whether the offer is refundable.

Type:

bool

sort_priority

The sorting priority of the offer.

Type:

int

layout_id

The layout ID of the offer.

Type:

str

layout

Layout information for the offer.

Type:

Layout

colors

Color configuration for the offer.

Type:

Colors

tile_background_material

The tile background material.

Type:

str

tile_size

The tile size.

Type:

str

display_asset_path

The display asset path.

Type:

str

new_display_asset_path

The new display asset path.

Type:

str

new_display_asset

New display asset information.

Type:

NewDisplayAsset

br_items

List of Battle Royale cosmetics included.

Type:

list`[:class:`BRCosmetic]

tracks

List of track cosmetics included.

Type:

list`[:class:`TrackCosmetic]

instruments

List of instrument cosmetics included.

Type:

list`[:class:`InstrumentCosmetic]

cars

List of car cosmetics included.

Type:

list`[:class:`CarCosmetic]

lego_kits

List of LEGO kit cosmetics included.

Type:

list`[:class:`LegoKitCosmetic]

Shop

Attributes
class FortniteAPIAsync.Shop[source]

Represents the Fortnite item shop.

raw

Raw data from FortniteAPI (can be used to reconstruct object)

Type:

dict

hash

Hash of the shop data used for change detection.

Type:

str

date

Datetime when the shop data was generated.

Type:

datetime.datetime

vbuck_icon

The V-Bucks icon image.

Type:

str

entries

List of shop entries.

Type:

list`[:class:`ShopEntry]

Exceptions

exception FortniteAPIAsync.FortniteAPIException[source]
exception FortniteAPIAsync.InvalidParameters[source]
exception FortniteAPIAsync.NotFound[source]
exception FortniteAPIAsync.Private[source]
exception FortniteAPIAsync.UnknownHTTPException[source]