Skip to content

Arduino library for use with compatible micro controllers to access the unofficial Fortnite API hosted at https://fortniteapi.com/.

License

Notifications You must be signed in to change notification settings

chunkysteveo/FortniteAPI

Repository files navigation

Fortnite API

Library for use with Arduino compatible micro controllers (web enabled) such as ESP8266 and ESP32 to access the simple, yet very powerful (and FREE!) Fortnite API (UNOFFICIAL) - https://fortniteapi.com/. **All rights go to Epic Games**.

What does it do?

This API is an Arduino wrapper class for the API hosted at https://fortniteapi.com/ which is an unofficial API that scrapes data from the publically available data from the Epic Games API.

This library will make it easy for you to get information from Fortnite, such as player stats, store items, leaderboards and challenges. I leave it up to you what and how you process this data in the most useful or pointless way possible!

All hats got off to @samhoogantink Sam who manages and maintains the API servers and code - this just pulls in that data for use on Arduino.

Buy me a beer!

Getting Started

You will need an Arduino compatible microcontroller that can connect to the internet/your network - ideally an ESP8266, that's it. The API doesn't use (anymore) any authentication method or password, so you don't need to sign up or request a key.

Test your connection

Check that the Fortnite API is up and running, and polling the Fortnite game servers.

https://fortnite-public-api.theapinetwork.com/prod09/status/fortnite_server_status

Your browser should give you something like this:

{
  "status": "UP",
  "message": "Fortnite is up.",
  "version": "7.10",
  "time": {
    "since": {
      "seconds": "1545132605"
    },
    "duration": {
      "seconds": 2338740,
      "formated": "27 days, 01 hour, 39 minutes and 00 seconds"
    }
  }
}

Installation

Available in the official Arduino Library Manager - Sketch -> Include Library -> Manage Libraries... and then search for "fortniteapi" and click Install!

Also available via GitHub if you clone it or download as a ZIP. The downloaded ZIP code can be included as a new library into the IDE selecting the menu:

 Sketch / include Library / Add .Zip library

You will also have to install the awesome ArduinoJson library written by Benoît Blanchon. Search ArduinoJson on the Arduino Library manager or get it from here. !v5, not v6 BETA!

Include Fortnite API in your project:

#include <FortniteAPI.h>

Examples

HelloWorldSerial

This is the first sketch to try out. Enter your WiFi credentials, compile and upload. Open the serial monitor and you should start to see player stat information coming back from user "Ninja".

Acknowledgments

  • Hat tip to Brian Lough, aka @witnessmenow for his tireless work on his Arduino API libraries which gave me the base to create my own.
  • Sam (@samhoogantink) for his amazing work on the API. https://fortniteapi.com/

Authors

License

See the LICENSE.md file for details

Release History

  • 1.0.1
    • Adding basic funciton to check server status, and checking that the tags are working to pull in update on Arduino Library Manager. More endpoints to follow!
  • 1.0.0
    • First release, just getting it out there. Bear with me while I fill it out!

Requests / Future To Do List

  • Crikey - lots to do!

Meta

Stephen Ludgate:

@Instagram

YouTube

Blog

Email - [email protected]

https://github.com/chunkysteveo/FortniteAPI

Contributing

  1. Fork it (https://github.com/chunkysteveo/FortniteAPI/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

About

Arduino library for use with compatible micro controllers to access the unofficial Fortnite API hosted at https://fortniteapi.com/.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages