Streamer.bot Scripting API

Welcome to the Streamer.bot Scripting API documentation.

This reference guides you through the CPH object and its methods, which are available in all supported scripting languages:

• C#
• JavaScript
• Lua
• Python
• C++

Usage

The CPH object is your main entry point for interacting with Streamer.bot. It allows you to:

• Control streaming platforms (Twitch, YouTube, Trovo, etc.)
• Manage OBS Studio (Scenes, Sources, Filters)
• Execute Actions and Timers
• Read and Write Variables (Global and User-scoped)
• Log messages to the application log

Example (C#)

public bool Execute()
{
    // Log a message
    CPH.LogInfo("Hello from C#!");
 
    // Send a message to Twitch
    if (CPH.TwitchIsConnected())
    {
        CPH.SendMessage("Streamer.bot is awesome!");
    }
 
    return true;
}

Example (Lua)

function Execute()
    CPH:LogInfo("Hello from Lua!")
    return true
end

API Reference

Explore the CPH class reference for a complete list of available methods.