The Python Fortnite API Wrapper
Project description
[![Discord](https://img.shields.io/discord/430802154022895616.svg?logo=discord)](https://discord.gg/AEfWXP9)
[![PyPI](https://img.shields.io/pypi/v/fortnite.svg)](https://pypi.org/project/fortnite/)
## Installation
```bash
pip install fortnite
```
## Usage
### Setup
[Obtaining fortnite and launcher tokens](https://github.com/qlaffont/fortnite-api#init)
```python
from pfaw import Fortnite, Platform
fortnite = Fortnite(fortnite_token='FORTNITE_TOKEN', launcher_token='LAUNCHER_TOKEN',
password='PASSWORD', email='EMAIL')
```
### Player
Return an object containing the attributes name and id.
```python
player = fortnite.player(username='Smitty Werbenjagermanjensen')
print(player.name)
print(player.id)
# prints:
# Smitty Werbenjagermanjensen
# 9c9212603304472d831c03d0978d2bc1
```
### Battle Royale Stats
Creates an object containing various stats for a given player.
```python
stats = fortnite.battle_royale_stats(username='Smitty Werbenjagermanjensen', platform=Platform.pc)
print(f'Solo Wins: {stats.solo.wins}')
print(f'Duo Wins: {stats.duo.wins}')
print(f'Squad Wins: {stats.squad.wins}')
print(f'Lifetime Wins: {stats.all.wins}')
# prints:
# Solo Wins: 1051
# Duo Wins: 1005
# Squad Wins: 210
# Lifetime Wins: 2266
```
### Server Status
Check the status of the Fortnite servers. Return True if up or False if down.
```python
status = fortnite.server_status()
if status:
print('Servers are UP!')
else:
print('Servers are DOWN.')
```
### Friends
Return a list of player IDs
```python
smittys_pals = fortnite.friends(username='Smitty Werbenjagermanjensen')
for friend in smittys_pals:
print(friend)
```
### News
Return an object containing the attributes common, br, and login.
```python
news = fortnite.news()
for br_news in news.br:
print(br_news)
```
### Store
```python
store = fortnite.store()
print(store.refresh_interval_hrs)
print(store.daily_purchase_hrs)
print(store.expiration)
for front in store.storefronts:
print(front.name)
for entry in front.catalog_entries:
print(entry.offer_id)
print(entry.dev_name)
print(entry.offer_type)
print(entry.title)
print(entry.description)
print(entry.refundable)
for price in entry.prices:
print(price.currency_type)
print(price.regular_price)
print(price.final_price)
print(price.sale_expiration)
print(price.base_price)
```
## Contributors
A thank you to those who have helped out with this project.
- Tom ([@Douile](https://github.com/Douile))
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
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-0.0.6.tar.gz
(5.3 kB
view hashes)