A python wrapper for Fortnite-API.com
Project description
Sync/Async Python wrapper for Fortnite-API.com
This library offers a complete sync and async wrapper around the endpoints of Fortnite-API.com
Installation
pip install fortnite-api
- Get a API key on https://fortnite-api.com/profile
Documentation
Here is a quick overview how to start.
First we need to import the api and initialize client.
import fortnite_api
api = fortnite_api.FortniteAPI()
Parameters
api_key
[str] (Optional) - Insert your API key from https://fortnite-api.com/profilerun_async
[bool] (Optional) - Specify if the API should run async. Default is set tofalse
Attributes
cosmetics
- All cosmetic endpointsshop
- All shop endpointsnews
- All news endpoints
Now we can use the client:
Cosmetics
api.cosmetics.fetch_all()
Get all Br cosmetics.
Parameters
language
[GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns
Returns a list of BrCosmetic
objects.
Cosmetics
api.cosmetics.fetch_new()
Get all new Br cosmetics.
Parameters
language
[GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns
Returns a NewBrCosmetics
object.
api.cosmetics.search_by_id()
Search one o multiple items by their id.
Parameters
*cosmetic_id
- One or multiple cosmetic ids.language
[GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns
Returns a list of BrCosmetic
objects.
api.cosmetics.search_all()
Search all cosmetics which fit to the search parameters
Parameters
**search_parameters
- All search parameters are listed on the Fortnite-API.com Docs. Remember that Python does not use a camel case. So e.g.searchLanguage
becomessearch_language
language
[GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns
Returns a list of BrCosmetic
objects.
api.cosmetics.search_first()
Search the first cosmetics which fit to the search parameters
Parameters
**search_parameters
(Optional) - All search parameters are listed on the Fortnite-API.com Docs. Remember that Python does not use a camel case. So e.g.searchLanguage
becomessearch_language
language
[GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns
Returns a BrCosmetic
objects.
Shop
api.shop.fetch()
Get the latest Fortnite shop.
Parameters
language
[GameLanguage] (Optional) - Specify the language of the shop. Default is set to englishcombined
[bool] (Optional) - Enable thatspecial_featured
andspecial_daily
are moved intofeatured
anddaily
Returns
Returns a Shop
object.
AES
api.aes.fetch()
Get the latest Fortnite AES Key. This also include version and build information.
Parameters
key_format
[KeyFormat] (Optional) - Specify the AES key format. Default is set to HEX
Returns
Returns a AES
object.
News
api.news.fetch()
Get the latest Fortnite news of all game modes.
Parameters
language
[GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns
Returns a News
object.
api.news.fetch_by_type()
Get the latest Fortnite news of a specified game mode.
Parameters
news_type
[NewsType] - Specify the news type.language
[GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns
Returns a GameModeNews
object.
Creator Code
api.creator_code.fetch()
Get information about a creator code.
Parameters
name
[str] - Specify a creator code.
Returns
Returns a CreatorCode
object.
api.creator_code.exists()
Check if a creator code exists.
Parameters
name
[str] - Specify a creator code.
Returns
Returns a bool
object.
api.creator_code.search_all()
Search a creator code by name. All results are provided.
Parameters
name
[str] - Specify a creator code.
Returns
Returns a list
of CreatorCode
objects.
api.creator_code.search_first()
Search a creator code by name. Only the first result is provided.
Parameters
name
[str] - Specify a creator code.
Returns
Returns a CreatorCode
object.
BR Stats
api.creator_code.fetch_by_name()
Returns stats of the requested player account.
Parameters
name
[str] - Sets the account name.account_type
[AccountType] (Optional) - Sets the account type.time_window
[TimeWindow] (Optional) - Sets the time window.account_type
[StatsImageType] (Optional) - Sets the image platform.
Returns
Returns a BrPlayerStats
object.
api.creator_code.exists()
Returns stats of the requested player account by its account id.
Parameters
account_id
[str] - Sets the account id.time_window
[TimeWindow] (Optional) - Sets the time window.account_type
[StatsImageType] (Optional) - Sets the image platform.
Returns
Returns a BrPlayerStats
object.
Banner
api.cosmetics.fetch()
Get all banners.
Parameters
language
[GameLanguage] (Optional) - Specify the language of the banners. Default is set to english
Returns
Returns a Banner
object.
api.cosmetics.fetch_colors()
Get all banner colors.
Returns
Returns a list of BannerColor
objects.
Contribute
Every type of contribution is appreciated!
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.