temotes

tEmotes API

Easy to use API for Twitch emotes

We support:

• Twitch
• 7TV
• BetterTTV
• FrankerFaceZ

Setup

Note: Keep in mind that you don’t need to install anything if you just want to consume the API.

You can use the public API that we expose on emotes.adamcy.pl

Requirements

• Golang
• Redis
• Twitch API Access (Client ID and Client Secret)

Configure

Configuration is as easy as defining the environment variables from the .env file.

Docker Swarm Secrets

For Docker Swarm environments, secrets are also supported. If an environment variable’s name ends with _FILE (e.g., REDIS_PASSWORD_FILE=/run/secrets/redis_password), the application will read the content of the specified file and use it as the value for that variable.

Precedence: If both FOO and FOO_FILE are set, the application will use the value from FOO and ignore FOO_FILE. This matches the implementation in getEnvOrFile and avoids surprises for operators.

Run & Build

Running and building the application is as simple as in any other Go project.

Health Endpoints

The API provides two health check endpoints for monitoring:

• Liveness Probe – checks if the server is running (/livez)
• Readiness Probe – checks if the application and its dependencies are ready to handle requests (/readyz)

License

This project is licensed under the terms of the AGPL-3.0 license.