AxelChat

Multichat for streamers

View project on GitHub

AxelChat API

The AxelChat API provides the ability to integrate third-party software with AxelChat, for example to read messages and viewer information. There are currently three ways to read data from AxelChat: HTTP requests, WebSocket and Output to files

HTTP requests

AxelChat can work as a HTTP server. Using HTTP requests, you can receive various data or control the work of AxelChat. For ease of API testing, use Postman or similar applications. Here is a list of HTTP requests supported by the latest version of AxelChat:

  • GET http://127.0.0.1:8356/api/v1/set-visibility?main=0 - hide main window AxelChat
  • GET http://127.0.0.1:8356/api/v1/set-visibility?main=1 - show main window AxelChat
  • GET http://127.0.0.1:8356/api/v1/app - get information about AxelChat version
  • GET http://127.0.0.1:8356/api/v1/messages?count=100 - get list of last 100 messages
  • GET http://127.0.0.1:8356/api/v1/selected-messages - get list of selected messages
  • GET http://127.0.0.1:8356/api/v1/state - get information about the status of connected platforms, including information about the number of viewers and more
  • GET http://127.0.0.1:8356/api/v1/chat/clear - (since 0.40.5) clear chat
  • POST http://127.0.0.1:8356/api/v1/receive-events - (since 0.44.0) send events to AxelChat. This endpoint can be used both for sending test events and for integration with a third-party program that receives data from a platform that is not natively supported in AxelChat, or for displaying any other messages. The request body must contain an array of objects. Each object is an event, such as a message event. Please keep some points in mind:
    • As of version 0.44.0, message deletion events are not yet supported. Only message adding and updating events work
      • It is not necessary to specify all fields in the object - If you don’t specify an event ID or message author ID, AxelChat will generate them automatically
      • It is recommended to additionally specify the platform ID at the beginning of the author ID to avoid identifier conflicts. For message IDs, it is also recommended to add the author ID at the beginning - If you send two messages with the same ID, the second message will be ignored. However, if the edited field in the second message is true, the first message will be overwritten by the second message, and a corresponding note will be added indicating that the message has been edited
    • The serviceId field contains the text ID of the platform from which this event was received. If the event was received from a platform AxelChat doesn’t know anything about, you can create your own ID. In this case, it is recommended to also specify the URL to the platform’s icon in the serviceBadge field. A list of known AxelChat platform IDs can be found below in this documentation.
    • If this request is successfully processed, AxelChat will return information about how the event was handled (the IDs of the messages that were added, updated, or deleted). A sample response is below.

An example of two message events:

[
    {
        "contents": [
            {
                "data": {
                    "text": "Simple message"
                },
                "type": "text"
            }
        ]
    },
    {
        "author": {
            "id": "twitch_15VIhcy2f6qvy6eKaI79d",
            "name": "Goose Doe",
            "serviceId": "twitch",
            "color": "#FF3FEF",
            "customBackgroundColor": "#99D9FF",
            "avatar": "https://img.icons8.com/?size=100&id=CqciCrEqfguR&format=png&color=000000",
            "page": "https://en.wikipedia.org/wiki/Goose",
            "serviceBadge": "https://img.icons8.com/?size=100&id=3XZiNbyjUeNL&format=png&color=000000",
            "leftBadges": [
                "https://img.icons8.com/?size=100&id=0WWwdtiSb6xB&format=png&color=000000",
                "https://img.icons8.com/?size=100&id=81210&format=png&color=000000"
            ],
            "leftTags": [
                {
                    "text": "GOOSE",
                    "backgroundColor": "#990026",
                    "textColor": "#FFFFFF"
                }
            ],
            "rightBadges": [
                "https://img.icons8.com/?size=100&id=101716&format=png&color=000000",
                "https://img.icons8.com/?size=100&id=120346&format=png&color=000000"
            ],
            "rightTags": [
                {
                    "text": "STREAMER",
                    "backgroundColor": "#9900E4",
                    "textColor": "#FFFFFF"
                }
            ]
        },
        "id": "twitch_15VIhcy2f6qvy6eKaI79d_15VIhcy2f6qvy6eKaI79_9BPXd1Q75B65zHgnQppd7Mjg7m3G7Zv",
        "eventType": "Message",
        "edited": false,
        "deletedOnPlatform": false,
        "markedAsDeleted": false,
        "customAuthorAvatarUrl": "",
        "customAuthorName": "",
        "mentionedYouAs": "",
        "publishedAt": "2025-12-27T12:13:47.266",
        "receivedAt": "2025-12-27T12:43:48.145",
        "reply": null,
        "bodyStyle": {
            "backgroundColor": "#0000FF",
            "borderColor": "#00FF00",
            "sideLineColor": "#FF0000"
        },
        "contents": [
            {
                "data": {
                    "text": "Hi! I'm Goose Doe\n"
                },
                "style": {
                    "font-weight": "bold"
                },
                "type": "text"
            },
            {
                "data": {
                    "text": "This is my friend, Duckinson Duck: "
                },
                "style": {
                    "font-style": "italic"
                },
                "type": "text"
            },
            {
                "data": {
                    "url": "https://img.icons8.com/?size=100&id=BO1UW1ckftwU&format=png&color=000000"
                },
                "type": "image"
            },
            {
                "data": {
                    "text": "\nI found his photo "
                },
                "type": "text"
            },
            {
                "data": {
                    "text": "here",
                    "url": "https://icons8.com/icons/set/duck"
                },
                "style": {
                    "font-style": "italic"
                },
                "type": "hyperlink"
            },
            {
                "data": {
                    "text": "\nAnd this is arbitrary HTML content:\n"
                },
                "type": "text"
            },
            {
                "data": {
                    "html": "This is another friend of mine, Platy Platypus:<br><img src=\"https://img.icons8.com/?size=100&id=Ssxi5U7QWAK4&format=png&color=000000\">"
                },
                "type": "html"
            }
        ]
    }
]

Response example:

{
    "addedMessages": [
        "twitch_15VIhcy2f6qvy6eKaI79_9BPXd1Q75B65zHgnQppd7Mjg7m3G7Zv"
    ],
    "removedMessages": [],
    "updatedMessages": []
}

WebSocket

AxelChat can work as a WebSocket server. AxelChat web widgets use exactly this method of communication. The main advantage of this method is instant receipt of messages and various events by your software.

To connect to AxelChat using WebSocket, follow these steps:

  • Launch AxelChat
  • Open the section Settings->Developers. If the WebSocket server was successfully launched, the message “State: Ok” should be displayed
  • This section will display the URL for connecting to AxelChat via WebSocket, usually ws://127.0.0.1:8356. Connect your WebSocket client using this link. See the documentation for your programming language or use the appropriate libraries
  • If the connection is successful, a new client will be displayed in the Developers section
  • Immediately after connecting, your software should send a message in this format to provide AxelChat with information about your client: 
    {
  "data": {
      "client": {
          "name": "<Name of your client>",
          "version": "<Your client version>"
          "type": "MAIN_WEBSOCKETCLIENT",
      },
      "info": {
          "name": "<Additional client name>",
          "type": "GENERIC"
      }
  },
  "type": "HELLO"
}

    If you do not send this message within a few seconds, or send another message, the connection will be automatically terminated.

  • Next, AxelChat will send a message in the format: 
    {
  "data": {
      "app_name": "AxelChat",
      "app_version": "0.37.3",
      "client_uuid": "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}",
      "services": [...]
  },
  "type": "HELLO"
}

    The services field will display the client ID, which is assigned to the client by AxelChat.

The services field stores information about the services currently supported by AxelChat.

  • Next, AxelChat will send messages:

STATES_CHANGED - Information about the status of services:

{
    "data": {
        "services": [
            {
                "connection_state": "connecting",
                "enabled": true,
                "type_id": "youtube",
                "viewers": 11
            },
            {
                "connection_state": "not_connected",
                "enabled": false,
                "type_id": "twitch",
                "viewers": 13
            }
        ],
        "viewers": 24
    },
    "type": "STATES_CHANGED"
}

NEW_MESSAGES_RECEIVED, MESSAGES_CHANGED - New messages received or changed existing messages:

{
    "data": {
        "messages": [
            {
                "author": {
                    "avatar": "<avatar_url>",
                    "color": "",
                    "customBackgroundColor": "",
                    "id": "<user_id>",
                    "leftBadges": [],
                    "name": "Alex",
                    "pageUrl": "<user_page_url>",
                    "rightBadges": [],
                    "serviceId": "youtube"
                },
                "contents": [
                    {
                        "data": {
                            "text": "Hello, I'm Axel"
                        },
                        "type": "text"
                    }
                ],
                "customAuthorAvatarUrl": "",
                "customAuthorName": "",
				"deleted": false,
                "destination": [],
                "bodyStyle": {},
                "id": "<message_id>",
                "publishedAt": "2024-08-04T16:18:02.954",
                "receivedAt": "2024-08-04T16:19:18.548",
                "extra": {}
            },
            {
                "author": {
                    "avatar": "<avatar_url>",
                    "color": "",
                    "customBackgroundColor": "",
                    "id": "<user_id>",
                    "leftBadges": [],
                    "name": "Inn",
                    "pageUrl": "<user_page_url>",
                    "rightBadges": [],
                    "serviceId": "youtube"
                },
                "contents": [
                    {
                        "data": {
                            "text": "See this image "
                        },
                        "type": "text"
                    },
                    {
                        "data": {
                            "url": "https://fonts.gstatic.com/s/e/notoemoji/15.1/1f44c_1f3fc/72.png"
                        },
                        "type": "image"
                    }
                ],
                "customAuthorAvatarUrl": "",
                "customAuthorName": "",
				"deleted": false,
                "destination": [],
                "bodyStyle": {},
                "id": "<message_id>",
                "publishedAt": "2024-08-04T16:18:04.069",
                "receivedAt": "2024-08-04T16:19:18.548",
                "extra": {}
            }
        ]
    },
    "type": "NEW_MESSAGES_RECEIVED"
}

CLEAR_MESSAGES - Cleared all messages

{
    "data": null,
    "type": "CLEAR_MESSAGES"
}

Notification of changes

New message types may appear in future updates of AxelChat. Also, existing message types may be changed, usually by adding new data to the message object. Stay tuned for updates

Output to files

This method is considered obsolete and may no longer be supported in the future.

To connect to AxelChat using file reading, follow these steps:

  • Launch AxelChat
  • In the section Settings->Output to files enable output to ini-files
  • The specified folder will store files that contain various information from AxelChat. These files periodically update their contents and your software must periodically read and parse these files to receive up-to-date information from AxelChat

List of known AxelChat platform IDs

This list is current as of version 0.44.0

["bigolive", "boosty", "chzzk", "discord", "dlive", "donatepayeu", "donatepayru", "donatestream", "donationalerts", "facebook", "goodgame", "kick", "livacha", "loco", "memealerts", "nekolive", "niconico", "nimotv", "nuum", "odysee", "ok", "parti", "picarto", "rumble", "rutube", "software", "soopglobal", "soopkorea", "steam", "streamelements", "streamlabs", "telegram", "tiktok", "trovo", "twitch", "unknown", "vaughnlive", "vimm", "vkvideo", "vkvideolive", "xcom", "youtube", "youtubeshorts"]

You can find the most up-to-date list of platforms for your version this way:

  1. Enable Output to a files (Settings->Output to a files)
  2. Click Show in Explorer
  3. In the folder that opens, open the folder services. This folder will list folders whose names correspond to the IDs of known AxelChat platforms except for IDs software and unknown