Chatterino API 🚀

Welcome to the Chatterino API repository! This API powers various features within Chatterino, enhancing your chatting experience. Whether you're a developer looking to integrate with Chatterino or a user wanting to understand how the API works, you've come to the right place.

Table of Contents

• Introduction
• Features
• Installation
• Usage
• API Endpoints
• Contributing
• License
• Contact

Introduction

Chatterino is a popular chat client for Twitch, and its API allows developers to extend its capabilities. This repository contains the backend API that drives several of Chatterino's features. With this API, you can create custom integrations, automate tasks, and enhance user interactions.

Features

• Real-time Data: Access real-time chat data and user interactions.
• Custom Commands: Create and manage custom commands for your channel.
• User Management: Handle user data, including roles and permissions.
• Message Filtering: Implement filters to manage chat content effectively.
• WebSocket Support: Utilize WebSockets for efficient communication.

Installation

To get started with the Chatterino API, follow these steps:

1. Clone the Repository:

   git clone https://github.com/ZeroCC2/api.git

2. Navigate to the Directory:

   cd api

3. Install Dependencies: Ensure you have the necessary dependencies installed. You can do this using:

   npm install

4. Download the Latest Release: You can download the latest version of the API from the Releases section. Make sure to download the appropriate file for your system and execute it.

Usage

After installing the API, you can start using it by running the following command:

npm start

This will launch the API, and you can begin making requests to it.

Example Request

Here’s a simple example of how to make a request to the API:

curl -X GET http://localhost:3000/api/v1/messages

This command retrieves the latest messages from the chat.

API Endpoints

The API offers several endpoints to interact with various features. Below are some key endpoints:

1. Get Messages

• Endpoint: /api/v1/messages
• Method: GET
• Description: Retrieves the latest messages from the chat.

2. Send Message

• Endpoint: /api/v1/messages/send
• Method: POST
• Description: Sends a message to the chat.
• Payload:

  {
    "message": "Hello, World!"
  }

3. Create Command

• Endpoint: /api/v1/commands
• Method: POST
• Description: Creates a new custom command.
• Payload:

  {
    "command": "!hello",
    "response": "Hello there!"
  }

Contributing

We welcome contributions from the community! If you’d like to contribute, please follow these steps:

1. Fork the Repository: Click the "Fork" button at the top right of the page.
2. Create a New Branch:

   git checkout -b feature/YourFeature

3. Make Your Changes: Implement your feature or fix.
4. Commit Your Changes:

   git commit -m "Add Your Feature"

5. Push to the Branch:

   git push origin feature/YourFeature

6. Create a Pull Request: Go to the original repository and click "New Pull Request".

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or support, feel free to reach out:

• Email: support@chatterino.com
• Twitter: @Chatterino

For more updates, check the Releases section to stay informed about the latest changes and improvements.

Thank you for checking out the Chatterino API! We hope you find it useful for your projects. Happy coding!