Overview

Start here

Choose the interface that matches your integration. These guides cover stream metadata, server information, real-time status updates, and direct connections to Vaughn Live chat servers.

REST endpoints

The following public endpoint paths are documented on the existing VaughnSoft developer site.

Base URL: https://api.vaughnsoft.net

Stream data API

Fetch JSON metadata for a stream, including broadcast state, viewer count, and the addresses used to connect to its chat servers.

GET https://api.vaughnsoft.net/v1/stream/vl/mark

Example response with selected fields:

{
  "status": 200,
  "chat_server": "chat-ws-1x03.vaughnsoft.net",
  "chat_server_irc": "irc-1x03.vaughnsoft.net",
  "live": true,
  "viewers": "80",
  "followers": "1399",
  "url": "https://vaughn.live/mark"
}

Use chat_server to locate the stream’s WebSocket chat server. The chat_server_irc field identifies an IRC address; IRC access requires a VIP account.

Server API (sAPI)

Use the Server API WebSocket service to request stream data without repeatedly opening new connections. The existing protocol uses MVN LOAD3 to initiate the session, followed by MVN STREAM3 to request a channel’s status.

const ws = new WebSocket("wss://sapi-ws.vaughnsoft.net");
ws.addEventListener("open", () => {
  ws.send("MVN LOAD3 #vl-mark guest guest\n\0");
});
ws.addEventListener("message", (event) => {
  const response = String(event.data).replace(/[\n\0]/g, "");
  if (response.startsWith("ACK3 ")) {
    ws.send("MVN STREAM3 #vl-mark\n\0");
  } else if (response.startsWith("STREAM3 ")) {
    console.log(response);
  } else if (response === "PING") {
    ws.send("PONG");
  }
});

Vaughn Live Chat Protocol

The chat server protocol supports WebSocket, raw TCP, and IRC clients. The dedicated reference covers connection flow, authentication, user roles, message formats, channel management, moderation, and server events.

// Send as separate WebSocket text messages, in this order:
MVN AUTH guest
// After receiving ACK:
JOIN #vl-mark
// After receiving PING:
PONG

WebSocket connection format: wss://<chat host>/mvn. The chat host can be obtained from the stream API’s chat_server field.

Open the full Vaughn Live Chat Protocol reference →

Follower notifications

Clients connected to the chat server can receive channel events, including notifications when someone follows a channel.

// A channel event received over the chat connection:
MVN FOLLOW #vl-mark Laney

The MVN FOLLOW #chan <user> event is documented alongside subscriptions, superchats, and other server-originated events in the Chat Protocol reference.

Support & contact

For questions about the APIs or integration behavior, contact contact@vaughnsoft.com.

Vaughn Live is a product of VaughnSoft Media Corporation.