Skip to content
Josh Heng edited this page Oct 5, 2023 · 7 revisions

Welcome to the unofficial Firefly API wiki.

Note that all this documentation has been created from a single pupil user account on a single Firefly instance, and may differ slightly to yours.

Feel free to contribute to this repository and this documentation - pull requests are accepted!

Unfortunately, it appears that Firefly have changed their API since I left my school/sixth form that used it. Therefore a lot of this documentation may now be incorrect, and may need re-doing by someone with access and spare time (using tools such as ZAP Proxy or Burpsuite). If you discover anything new, feel free to make a PR into this repository or let me know through an issue and I'll happily merge it.

Requests & Responses

The request endpoint is the URL of the Firefly instance (e.g. https://host.fireflycloud.net), which can be obtained from a request to the app gateway. Please see the misc page for more details.

Examples

The repository includes example Node.JS code. Please see README.md for more details.

Contents

Name Description
Misc Misc requests that don't require authentication
Authentication How to authenticate and manage your token
GraphQL Queries GraphQL queries - includes timetable and host configuration
Tasks Retrieving Tasks
Clone this wiki locally