Changelog

v3.2.0

This version introduces support for new Shoes cosmetic type, drops support for Python 3.8, and adds safeguards and future proofing against potential API changes.

Breaking Changes

• Drop support for Python 3.8. The minimum supported Python version is now 3.9.

• CreatorCode.status and CreatorCode.disabled have been removed, since both returned a static value. Disabled creator codes always raise fortnite_api.NotFound when trying to fetch them.

• CreatorCode.verified has been removed, since it isn’t used within the affiliate system. It always returns False.

• All enums now use an internal “Enum-like” class to handle unknown values, instead of the built-in enum.Enum. This potentially breaks type checks, but does not break core functionality or change the enum interface; you can use them the same.

New Features

• Added support for fortnite_api.CosmeticType.SHOES.

Documentation

• Document fortnite_api.Forbidden to be raised by fortnite_api.Client.fetch_br_stats() and fortnite_api.SyncClient.fetch_br_stats().

Miscellaneous

• Add safeguards against Epic Games’ API changing or providing invalid values in API responses.

  • All enums now can handle unknown values via an internally defined “Enum-like” class. If the API returns a value not in the enum, it will be stored as an attribute on the enum object. The interface for using this class is the same as using enum.Enum.

  • fortnite_api.TileSize no longer raises ValueError when an unknown value is passed to it. Instead, it now has a fallback value of -1 for both width and height.

v3.1.0

This version introduces new data for shop-related objects, reflecting the updated shop layouts and the Fortnite webshop. Additionally, it includes functions that were omitted in version v3.0.0 and addresses a design decision that results in a breaking change.

Breaking Changes

• ShopEntryNewDisplayAsset has been renamed to fortnite_api.NewDisplayAsset.

• Alias BannerColor.colour has been removed for consistency. The API does not use aliases, use fortnite_api.BannerColor.color instead.

New Features

• Added new object fortnite_api.ProductTag.

• Added attribute fortnite_api.MaterialInstance.product_tag.

• Added new object fortnite_api.ShopEntryOfferTag.

• Added new object fortnite_api.ShopEntryColors.

• Added new object fortnite_api.RenderImage.

• Added attribute fortnite_api.ShopEntryLayout.rank.

• Added attribute fortnite_api.NewDisplayAsset.render_images.

• Added attribute fortnite_api.ShopEntry.offer_tag.

• Added attribute fortnite_api.ShopEntry.colors.

Bug Fixes

• Fixed an issue where type and time_window parameters were not respected when fetching stats.

• fortnite_api.Playlist.images now returns None when no images are available, instead of an empty dict.

• Bug fix for returning naive datetime objects in rare cases. All datetime objects are UTC aware.

Documentation

• Added response flags documentation to explain how to use the fortnite_api.ResponseFlags class, how to enable response flags, which response flags are available, and when you should enable them.

• Added opt-in directive in the documentation on attributes that require a specific response flag to be set. This ensures users know of the response flags required to access certain attributes when using the API.

Miscellaneous

• Previously, fetching specific game mode news raised fortnite_api.ServiceUnavailable due to improper handling from Fortnite-API.com. This has been fixed within the API. Now, when no news is available, fortnite_api.NotFound is raised instead. This change is also reflected in the documentation.

v3.0.0

For help on Migrating to Version 3 from Version 2, and a complete list of all the new features, see the Migration guide.