twitch.schedule

Every method of twitch.schedule, with its parameters, what it returns and the token it needs.

get

twitch.schedule.get(params, options?): Paginator<ScheduleSegment, ScheduleResponse>

Lists the planned broadcasts of a channel. The broadcaster and vacation fields come with every page, under page.raw.data. Fails with a 404 when the channel has no schedule.

Token: app or user.

Parameters

Name	Type	Description
broadcaster_id required	string	Broadcaster whose schedule to read.
id	string | readonly string[]	Only these segments. Up to 100 IDs.
start_time	string | Date	Only segments that start after this moment. Twitch defaults to now.
first	number	Items per page, 1 to 25. Twitch defaults to 20.
after	string	Cursor of the next page.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Paginator<ScheduleSegment, ScheduleResponse>

Fields of ScheduleSegment

Name	Type	Description
id	string	ID of the segment.
start_time	string	When the broadcast starts, as an RFC 3339 timestamp.
end_time	string	When the broadcast ends, as an RFC 3339 timestamp.
title	string	Title of the broadcast.
canceled_until	string | null	Set when this occurrence of a recurring broadcast was canceled: it then holds the same RFC 3339 timestamp as end_time. null otherwise.
category	ScheduleCategory | null	Category planned for the broadcast, or null when none was chosen.
is_recurring	boolean	Whether the broadcast repeats every week. false for a one-time broadcast.

Example

const page = await twitch.schedule.get({ broadcaster_id: "141981764" });
console.log(page.raw.data.vacation);
for (const segment of page) console.log(segment.start_time, segment.title);

Twitch reference

icalendar

twitch.schedule.icalendar(params, options?): Promise<string>

Gets the schedule of a channel as iCalendar text, ready to be saved as an .ics file. Twitch does not ask for a token here, the client sends its usual one anyway.

Token: app or user.

Parameters

Name	Type	Description
broadcaster_id required	string	Broadcaster whose schedule to export.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Promise<string>

Example

const ics = await twitch.schedule.icalendar({ broadcaster_id: "141981764" });

Twitch reference

updateSettings

twitch.schedule.updateSettings(params?, options?): Promise<void>

Plans or cancels the vacation of a channel.

Token: user, scope channel:manage:schedule.

Parameters

Name	Type	Description
broadcaster_id	string	Broadcaster who owns the schedule. Defaults to the user making the call.
is_vacation_enabled	boolean	true to plan a vacation with the dates below, false to cancel the planned one.
vacation_start_time	string | Date	When the vacation starts. Required when is_vacation_enabled is true.
vacation_end_time	string | Date	When the vacation ends. Required when is_vacation_enabled is true.
timezone	string	Time zone the broadcaster streams from, as an IANA name such as "Europe/Paris". Required when is_vacation_enabled is true.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Promise<void>

Example

await twitch.schedule.updateSettings({
  is_vacation_enabled: true,
  vacation_start_time: "2026-08-01T00:00:00Z",
  vacation_end_time: "2026-08-15T00:00:00Z",
  timezone: "Europe/Paris",
});

Twitch reference

createSegment

twitch.schedule.createSegment(params, options?): Promise<Schedule>

Adds a one-time or weekly broadcast to the schedule of a channel. Resolves with the schedule, whose segments hold only the new one.

Token: user, scope channel:manage:schedule.

Parameters

Name	Type	Description
broadcaster_id	string	Broadcaster who owns the schedule. Defaults to the user making the call.
start_time required	string | Date	When the broadcast starts.
timezone required	string	Time zone of the broadcast, as an IANA name such as "Europe/Paris".
duration required	string	Length of the broadcast in minutes, written as a string: "30" to "1380".
is_recurring	boolean	Whether the broadcast repeats every week. One-time broadcasts are reserved to affiliates and partners.
category_id	string	ID of the category planned for the broadcast.
title	string	Title of the broadcast, 140 characters at most.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Promise<Schedule>

Fields of Schedule

Name	Type	Description
segments	ScheduleSegment[]	Planned broadcasts.
broadcaster_id	string	ID of the broadcaster who owns the schedule.
broadcaster_name	string	Display name of the broadcaster.
broadcaster_login	string	Login name of the broadcaster.
vacation	ScheduleVacation | null	Planned vacation, or null when vacation mode is off.

Example

const schedule = await twitch.schedule.createSegment({
  start_time: "2026-07-01T18:00:00Z",
  timezone: "Europe/Paris",
  duration: "120",
  is_recurring: true,
});

Twitch reference

updateSegment

twitch.schedule.updateSegment(params, options?): Promise<Schedule>

Changes or cancels a planned broadcast. On a recurring segment, a new title, category, duration or time zone applies to every occurrence. Resolves with the schedule, whose segments hold only the changed one.

Token: user, scope channel:manage:schedule.

Parameters

Name	Type	Description
broadcaster_id	string	Broadcaster who owns the schedule. Defaults to the user making the call.
id required	string	ID of the segment to change.
start_time	string | Date	New start. Only affiliates and partners can move a segment, and only a one-time one.
duration	string	New length in minutes, written as a string: "30" to "1380".
category_id	string	ID of the new category.
title	string	New title, 140 characters at most.
is_canceled	boolean	true to cancel the broadcast. On a recurring segment this cancels the next occurrence, whichever occurrence id points to.
timezone	string	New time zone, as an IANA name such as "Europe/Paris".

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Promise<Schedule>

Fields of Schedule

Name	Type	Description
segments	ScheduleSegment[]	Planned broadcasts.
broadcaster_id	string	ID of the broadcaster who owns the schedule.
broadcaster_name	string	Display name of the broadcaster.
broadcaster_login	string	Login name of the broadcaster.
vacation	ScheduleVacation | null	Planned vacation, or null when vacation mode is off.

Example

await twitch.schedule.updateSegment({ id: segment.id, duration: "90" });

Twitch reference

deleteSegment

twitch.schedule.deleteSegment(params, options?): Promise<void>

Removes a planned broadcast. Removing a recurring segment removes every occurrence of it.

Token: user, scope channel:manage:schedule.

Parameters

Name	Type	Description
broadcaster_id	string	Broadcaster who owns the schedule. Defaults to the user making the call.
id required	string	ID of the segment to remove.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Promise<void>

Example

await twitch.schedule.deleteSegment({ id: segment.id });

Twitch reference