Reference / API groups

twitch.goals

Creator goals of a channel.

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

get

twitch.goals.get(params?, options?): Promise<CreatorGoal[]>

Lists the active goals of a broadcaster with their current progress.

Token: user, scope channel:read:goals.

Name	Type	Description
`broadcaster_id`	`string`	Broadcaster who created the goals. Defaults to the user making the call.

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

Promise<CreatorGoal[]>

Fields of CreatorGoal

Name	Type	Description
`id`	`string`	ID of the goal.
`broadcaster_id`	`string`	ID of the broadcaster who created the goal.
`broadcaster_name`	`string`	Display name of the broadcaster.
`broadcaster_login`	`string`	Login name of the broadcaster.
`type`	`CreatorGoalType`	What the goal counts.
`description`	`string`	Text of the goal. An empty string when the broadcaster wrote none.
`current_amount`	`number`	Where the count stands now. For `follower` this is the whole follower count of the channel.
`target_amount`	`number`	Value the broadcaster wants to reach.
`created_at`	`string`	When the goal was created, as an RFC 3339 timestamp.

const goals = await twitch.goals.get();
for (const goal of goals) console.log(goal.type, goal.current_amount, goal.target_amount);