Getting Started

Welcome to the Fyre API docs!

These endpoints are designed to enhance your chat's stream experience.

So how does it work?

Most (if not all) Twitch bots have a special command variable that is able to return a response from an online source.

Refer to your bot's documentation for more information.

Although the syntax may differ between platforms, the usage remains largely the same.

How do I use the Fyre API?

The documentation for any given endpoint will always begin by defining the base URL (required for the variable) and any required parameters.

Required parameters are indicated by a colon in the base URL. For example:

This indicates that id is a necessary part of the URL for it to work. Further information would be given below detailing what that would be.

Many endpoints will also accept optional parameters to allow you to fine-tune the response. These use a query-string format:

Query strings always begin with a question mark ? and subsequent parameters are appended using an ampersand &. In the example above, two additional parameters have been given: return and separator.

A variety of different parameters can be chained together to return specific responses for different uses. Different use-cases are usually outlined with examples for each platform, to give you an idea of how it can be used.

Occasionally, you can also use your bot's variables within the URL, which are replaced when the command is run or the timer is triggered. This is useful for customising responses on the fly.

Anything else?

Although this is all still very much new and a work-in-progress, I hope you find great use with what is available so far.

If you have any questions, requests, or need help setting up commands, please don't hesitate to drop a question in the support channel.

Enjoy!