Skip to main content
Defined in: types.ts:55

​
Properties

​
game_box_art_url?

optional game_box_art_url?: string
Defined in: types.ts:57 Template URL for the game’s box art.

​
game_id

game_id: string
Defined in: types.ts:60 ID of the game being played on the stream.

​
game_name

game_name: string
Defined in: types.ts:63 Name of the game being played.

​
id

id: string
Defined in: types.ts:66 Stream ID.

​
is_mature

is_mature: boolean
Defined in: types.ts:69 Indicates if the broadcaster has specified their channel contains mature content that may be inappropriate for younger audiences.

​
language

language: string
Defined in: types.ts:72 Stream language. A language value is either the ISO 639-1 two-letter code for a supported stream language or “other”.

​
started_at

started_at: Date
Defined in: types.ts:75 UTC timestamp.

​
tag_ids

tag_ids: string[]
Defined in: types.ts:78 Shows tag IDs that apply to the stream.

​
thumbnail_url

thumbnail_url: string
Defined in: types.ts:81 Thumbnail URL of the stream. All image URLs have variable width and height. You can replace {width} and {height} with any values to get that size image

​
title

title: string
Defined in: types.ts:84 Stream title.

​
type

type: string
Defined in: types.ts:87 Stream type: “live” or "" (in case of error).

​
user_id

user_id: string
Defined in: types.ts:90 ID of the user who is streaming.

​
user_login

user_login: string
Defined in: types.ts:93 Login of the user who is streaming.

​
user_name

user_name: string
Defined in: types.ts:96 Display name corresponding to TwitchHelixStreamsResult.user_id.

​
viewer_count

viewer_count: number
Defined in: types.ts:99 Number of viewers watching the stream at the time of the query.