Welcome #

This is the website hosting all of the Glimesh API documentation. If you have any questions let us know in our Discord!

While Glimesh is shutting down, you may want to run your own instance of Glimesh on a custom server. These docs will be removed, but you can access the markdown files at the documentation repo.

Structure #

This repo is divided into topics (auth, chat, etc.). Each topic has several tutorial pages. Most of the examples are generic and not specific to any programming language. However, some pages do contain code samples. Some pages will help you understand the API while others help you build something (chatbot/follow alerts).

This documentation is a work in progress. We will do our best to keep this updated!

Interested in contributing? Click here to help out!

Get Started #

It is recommended to follow these tutorials in this order. This will give you a basic understanding of the API and what you can do with it.

• Create a Dev App #

• Creating a developer application

• Basic Queries #

• Making requests to the API

• WebSocket Connections #

• Connecting to chat
• Channel Updates

• OAuth Authentication #

• Generating your own access token
• Getting a users access token
• Refreshing an access token

Not seeing what you are looking for? Consider adding a tutorial for it or talking to us about it on discord.

Links #

Links you may find useful:

• Glimesh developer applications
• Create API requests on Glimesh without a dev environment (Old API)
• Our dev-questions channel in Discord