ViewerBoss API

• POSTCreate a viewer task/api/viewers/task

  Creates a new viewer task for a Twitch or Kick channel.

  Example request

  fetch('https://api.viewerboss.com/api/viewers/task', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      platform: "twitch",
      channel: "exampleChannel",
      count: 1300,
      delay: 50
    })
  })

  Example response

  {
    "message": "Success",
    "taskId": 4356
  }

• GETList viewer tasks/api/viewers/tasks

  Returns all of your viewer tasks on Twitch and Kick. Add onlyWorking=true to get only running tasks.

  Example request

  fetch('https://api.viewerboss.com/api/viewers/tasks?onlyWorking=true', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  })

  Example response

  [
    {
      "id": 4356,
      "platform": "twitch",
      "channel": "exampleChannel",
      "count": 1300,
      "status": "active"
    }
  ]

• GETGet a viewer task/api/viewers/task/{id}

  Returns the details of one viewer task by its ID.

  Example request

  fetch('https://api.viewerboss.com/api/viewers/task/4356', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  })

  Example response

  {
    "id": 4356,
    "platform": "twitch",
    "channel": "exampleChannel",
    "count": 1300,
    "status": "active"
  }

• DELETEDelete a viewer task/api/viewers/task/{id}

  Deletes a viewer task by its ID.

  Example request

  fetch('https://api.viewerboss.com/api/viewers/task/4356', {
    method: 'DELETE',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  })

  Example response

  {
    "message": "Task deleted successfully."
  }

• PUTAdd viewers to a task/api/viewers/task/{id}/increase-viewers

  Increases the number of viewers on a running task.

  Example request

  fetch('https://api.viewerboss.com/api/viewers/task/13082/increase-viewers?count=50&delay=100', {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  })

  Example response

  {
    "message": "Viewer count increased successfully.",
    "newCount": 1350
  }

• PUTRemove viewers from a task/api/viewers/task/{id}/decrease-viewers

  Decreases the number of viewers on a running task.

  Example request

  fetch('https://api.viewerboss.com/api/viewers/task/1522/decrease-viewers?count=100&delay=100', {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  })

  Example response

  {
    "message": "Viewer count decreased successfully.",
    "newCount": 1200
  }

Requests over the limit get an HTTP 429 (Too Many Requests) response. Contact support if you need higher limits.