simple-fortnite-api-io v1.0.3

SIMPLE-FORTNITE-API-IO

If you need help with sth, join our Support Server: https://discord.gg/yAP4Ags #Ad

How to get started?

just type

npm install --save simple-fortnite-api-io

Client

To use the full potential of the API, you need to create an account on fortniteapi.io and then put your API KEY in the client. You can also add language from list after api key: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

const simplefortnite = require('simple-fortnite-api-io');

const client = new simplefortnite.api("API-KEY-FROM-FORTNITEAPI-IO", "pl");

Servers Status

Returns Fortnite Servers Status.

Example of usage:

let data = await client.serversStatus();
console.log(data);

List challenges

List all challenges as well as rewards (xp, stars, cosmetics). Weekly challenges/missions are available for each season under .weeklyLimited time missions are available under .limited_timeList of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.challengesList();
console.log(data);

List items

List all cosmetic items: skins, backpacks, emotes, pickaxes, sprays, etc.List of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.itemsList();
console.log(data);

List upcoming items

List all cosmetic items: skins, backpacks, emotes, pickaxes, sprays, etc.List of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.upcomingItemsList();
console.log(data);

Get item details

List all cosmetic items: skins, backpacks, emotes, pickaxes, sprays, etc.List of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.itemsDetails("CID_242_Athena_Commando_F_Bullseye");
console.log(data);

Get daily shop

List all items currently in the shopList of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.dailyShop();
console.log(data);

Get shop voting options

Get options to vote for the next community shop item

Example of usage:

let data = await client.shopVoting();
console.log(data);

Search account ID

Search an account ID using a player name

Example of usage:

let data = await client.getAccountID("breftejk");
console.log(data);

Get global player stats

Get player stats, with a breakdown per platform used (mouse & keyboard, gamepad, touch)

Example of usage:

let data = await client.playerStats("id-from-getAccountID");
console.log(data);

Get recent matches for a player

List the last 25 games for a player. Some games can be grouped. If it's the first time you search this user, the matches list will be empty.

Example of usage:

let data = await client.playerRecentMatches("id-from-getAccountID");
console.log(data);

Get Battle Royale/STW/Creative news

Lists the current news in Fortnite Battle Royale, Save The World or CreativeList of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.BRnews();
console.log(data);

let data = await client.STWnews();
console.log(data);

let data = await client.CREATIVEnews();
console.log(data);

Battle Pass rewards

Get the list of rewards given in the Battle Pass for each seasonList of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.battlePassRewards();
console.log(data);

Achievements

Get the list of achievementsList of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.achievements();
console.log(data);

Tournaments

Get the list of tournamentsList of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.tournaments();
console.log(data);

Tournament session details

Get a tournament session details: rules, payout, results

Example of usage:

let data = await client.tournamentSessionDetails("S11_CC_Contenders_EU_Event1");
console.log(data);

Get map (2048x2048px)

This is the latest map available in the files.

Notes:

To view the map with POI names, add "true" in function args (for v11.00+ maps only) Currently, the dynamic changes on the map are not there, but they usually show up on the next game patch. With time we will try to improve this.

Example of usage:

let data = await client.map();
console.log(data);

let data = await client.map(true);
console.log(data);

List previous maps

Get the list of links to the different maps. Every new map change is now automatically archived.

Example of usage:

let data = await client.previousMapsList();
console.log(data);

List previous seasons

List all the season dates and patch versions associated.

Example of usage:

let data = await client.previousSeasonsList();
console.log(data);

Loot/weapons list

List all loot/weapons in the game with their basic stats.List of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.lootList();
console.log(data);

List of current POIs

List all the POIs currently in the game. X/Y coordinates are centered from the middle of the map.List of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.currentPOIsList();
console.log(data);

List of game modes

List all the game modes in the games files.List of supported languages: en, ar, de, es, es-419, fr, it, ja, ko, pl, pt-BR, ru, tr

Example of usage:

let data = await client.gameModesList();
console.log(data);

Creative: featured islands

List the current featured islands in creative mode

Example of usage:

let data = await client.featuredIslands();
console.log(data);

Creative: search for an island

Get all details related to a creative island

Example of usage:

let data = await client.featuredIslandDetails("1787-6243-5207");
console.log(data);