Skip to main content

A python wrapper for Fortnite-API.com

Project description

Sync/Async Python wrapper for Fortnite-API.com

GitHub issues PyPI - Downloads PyPI PyPI - Python Version Support

This library offers a complete sync and async wrapper around the endpoints of Fortnite-API.com

Installation

pip install fortnite-api

Documentation

Here is a quick overview how to start.

First we need to import the api and initialize client.

import fortnite_api

fortnite_client = fortnite_api.FortniteAPI()
Parameters
  • api_key [str] (Optional) - Enter the API key you will get if you requested a higher rate limit
  • run_async [bool] (Optional) - Specify if the API should run async. Default is set to false
Attributes
  • cosmetics - All cosmetic endpoints
  • shop - All shop endpoints
  • news - 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.


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. None if not found.


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 becomes search_language
  • language [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns

Returns a list of BrCosmetic objects. None if not found.


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 becomes search_language
  • language [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns

Returns a BrCosmetic objects. None if not found.


Shop

api.shop.fetch()

Get the latest Fortnite shop.

Parameters
  • language [GameLanguage] (Optional) - Specify the language of the shop. Default is set to english
Returns

Returns a Shop 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.

Contribute

Every type of contribution is appreciated!

License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fortnite-api-1.0.0.post2.tar.gz (8.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page