OBJECT

Channel

A User's place on Twitch.

GraphQL Schema definition

1 type Channel {
2 
3 #   All Prediction Events that are actively accepting new predictions.
4 activePredictionEvents: [PredictionEvent!] 
5 
6 #   A mapping of AutoMod categories to levels.
7 autoModConfiguration: AutoModConfiguration 
8 
9 #   A list of content attributes created for the channel, that can be associated 
10 #   with the chanlets, to augment the multi-view experience.
11 availableContentAttributes: [MultiviewContentAttribute!] 
12 
13 #   A list of available Drops that viewers of this channel can claim when certain 
14 #   game events are met.
15 availableDrops: [DropObject] @deprecated( reason: "use channel.viewerDropCampaigns"  )
16 
17 #   A paginated list of users who are banned from this channel.
18 bannedUsers(after: Cursor, first: Int): ChannelBannedUserConnection 
19 
20 #   The boost settings for the channel.
21 boostSettings: BoostSettings 
22 
23 #   The language the broadcaster has chosen to stream in.
24 broadcasterLanguage: String! @deprecated( reason: "Use stream.language instead."  )
25 
26 #   The celebration configuration for the channel, which contains if celebrations 
27 #   are enabled and a list of configured celebrations.
28 celebrations: CelebrationConfig 
29 
30 #   The stream key for this channel if it is a multi-view chanlet. The requesting 
31 #   user must "own" this chanlet to be authorized to see this.
32 chanletStreamKey: String 
33 
34 #   A list of the channel's chanlets (sub-channels) in a multi-view experience.
35 chanlets(sort: ChanletSort, bypassDisableFlag: Boolean): [Channel!] 
36 
37 #   Get the chatters on this channel.
38 chatters: ChattersInfo 
39 
40 #   The clip settings for a channel, includes settings on clip creation.
41 clipsSettings: ChannelClipsSettings 
42 
43 #   Get a single community points custom reward redemption by its ID.
44 communityPointsCustomRewardRedemption(
45 id: ID!
46 ): CommunityPointsCustomRewardRedemption 
47 
48 #   The queue of community points custom reward redemptions in this channel.
49 communityPointsRedemptionQueue(
50 first: Int,
51 after: Cursor,
52 options: CommunityPointsRedemptionQueueOptions
53 ): CommunityPointsCustomRewardRedemptionConnection 
54 
55 #   Details about community points in the channel.
56 communityPointsSettings: CommunityPointsChannelSettings 
57 
58 #   For a multi-view chanlet, this is the list of content attributes that have been 
59 #   associated with the given chanlet.
60 contentAttributes: [MultiviewContentAttribute!] 
61 
62 #   The channel's badge flair setting and assets that are available to eligible 
63 #   subscribers.
64 creatorBadgeFlair: CreatorBadgeFlair 
65 
66 #   Fetch the requesting user's currently playing radio content.
67 currentRadioTrack: RadioCurrentlyPlaying 
68 
69 #   Returns configurations for a dashboard view in different parts of Twitch, such 
70 #   as Stream Manager
71 #   or Twitch Studio. Includes configurations for things like layout and other 
72 #   features.
73 dashboardView(type: ChannelDashboardViewType!): ChannelDashboardView! 
74 
75 #   The channel's name, with user-specified formatting.
76 displayName: String 
77 
78 #   A drop 2.0 campaign including personal settings (e.g. account connection 
79 #   status). (Streamer dashboard individual item).
80 dropCampaign(id: ID!): DropCampaign 
81 
82 #   A list of all available Drops 2.0 campaigns that a channel is eligible to 
83 #   participate in. (Streamer dashboard list).
84 dropCampaigns: [DropCampaign!] 
85 
86 #   founderBadgeAvailability is a number of available slots for Founder Badge 
87 #   entitlement.
88 founderBadgeAvailability: Int! 
89 
90 #   The name of the last game played on this channel.
91 game: String! @deprecated( reason: "Use user.lastBroadcast.game.name instead."  )
92 
93 #   The Home of a channel.
94 home: ChannelHome 
95 
96 #   The structure that contains information about the channel's Hype Train execution 
97 #   and config.
98 hypeTrain: HypeTrain! 
99 
100 #   The channel's unique identfier.
101 id: ID! 
102 
103 #   A setting which states whether or not users can create Clips on this channel.
104 #   By default, clipping on a channel is enabled.
105 isClipsEnabled: Boolean! @deprecated( reason: "Use channel.clipsSettings instead."  )
106 
107 #   Whether or not the channel is a hidden multi-view chanlet that is only meant to 
108 #   be accessible through another channel and not exist as a completely independent 
109 #   channel.
110 isHiddenChanlet: Boolean! 
111 
112 #   Whether the broadcaster has designated the channel's broadcast for mature 
113 #   audiences only.
114 isMature: Boolean! @deprecated( reason: "Use stream.isMature instead."  )
115 
116 #   Whether the channel has opted out of drops.
117 isOptedOutOfDrops: Boolean 
118 
119 #   Whether the channel is using the new AutoMod vendor for enforcement.
120 isMemberOfAutoModRollout: Boolean 
121 
122 #   leaderboardSet contains the set of leaderboards that are active on this channel.
123 leaderboardSet(first: Int): LeaderboardSet 
124 
125 #   leaderboardTimePeriod indicates whether the leaderboard type is of WEEKLY, 
126 #   ALL-TIME, etc.
127 leaderboardTimePeriod: LeaderboardTimePeriodType 
128 
129 #   All Prediction Events that are no longer accepting new predictions, and are 
130 #   awaiting resolution.
131 lockedPredictionEvents: [PredictionEvent!] 
132 
133 #   Retrieves video manager videos for the channel, this requires owner or editor 
134 #   permissions.
135 managedVideos(
136 first: Int,
137 after: Cursor,
138 statuses: [VideoStatus!],
139 types: [BroadcastType!],
140 sort: VideoSort
141 ): VideoConnection 
142 
143 #   Returns a resolver to query moderation logs.
144 moderationLogs: ModerationLogs 
145 
146 #   The channel's name.
147 name: String! 
148 
149 #   The number of VIP roles a user can assign in their channel.
150 numberOfVIPsAllowed: Int 
151 
152 #   The user who owns this channel.
153 owner: User 
154 
155 #   Configurations for chanlets this channel owns.
156 ownerChanletAttributes: OwnerChanletAttributes 
157 
158 #   Settings dictating how Prediction Events are run on this channel.
159 predictionSettings: ChannelPredictionSettings 
160 
161 #   Fetches most recent chat messages sent for the given channel.
162 recentChatMessages: [Message!]! 
163 
164 #   A single page of Prediction Events that have been resolved.
165 resolvedPredictionEvents(first: Int, after: Cursor): PredictionEventConnection 
166 
167 #   The restriction that is currently active on the channel for restricting a user's 
168 #   access to it.
169 restriction: ResourceRestriction 
170 
171 #   The stream schedule of the user.
172 #   Returns null when the user has not set a schedule.
173 schedule: Schedule 
174 
175 #   The requesting user's relationship with the channel.
176 self: ChannelSelfEdge 
177 
178 #   Extension information pertaining to the active user. Note that this is not part 
179 #   of the `self` property as this still returns data for anonymous users.
180 selfInstalledExtensions(isMobile: Boolean): [ExtensionInstallationSelfEdge!] 
181 
182 #   The channel's social media links and favicons.
183 socialMedias: [SocialMedia!] 
184 
185 #   A user-defined status message.
186 status: String! @deprecated( reason: "Use user.lastBroadcast.title instead."  )
187 
188 #   The live broadcast associated with this channel, if currently broadcasting.
189 stream: Stream @deprecated( reason: "Use user.stream instead."  )
190 
191 #   A list of streams for a given channel for multi-view.
192 streams: [Stream!] 
193 
194 #   Channel trailer for this channel.
195 trailer: Trailer 
196 
197 #   Requests from channel-banned users to be unbanned submitted on the channel.
198 #   Accessible by users with moderator role or higher.
199 unbanRequests(after: Cursor, first: Int, options: UnbanRequestsOptions): UnbanRequestConnection 
200 
201 #   Settings for users creating unban requests on the channel.
202 unbanRequestsSettings: UnbanRequestsSettings 
203 
204 #   The URL to view the channel in a browser.
205 url: String! 
206 
207 #   Video stream settings for ingesting a stream such as stream key, latency mode, 
208 #   or vod save preference.
209 videoStreamSettings: VideoStreamSettings 
210 
211 #   A list of available Drop 2.0 Campaigns of which drops viewers of this channel 
212 #   can claim when certain game events or minutes watched events are met. (Channel 
213 #   highlight card).
214 viewerDropCampaigns: [DropCampaign!] 
215 
216 }

1	type Channel {
2
3	# All Prediction Events that are actively accepting new predictions.
4	activePredictionEvents: [PredictionEvent!]
5
6	# A mapping of AutoMod categories to levels.
7	autoModConfiguration: AutoModConfiguration
8
9	# A list of content attributes created for the channel, that can be associated
10	# with the chanlets, to augment the multi-view experience.
11	availableContentAttributes: [MultiviewContentAttribute!]
12
13	# A list of available Drops that viewers of this channel can claim when certain
14	# game events are met.
15	availableDrops: [DropObject] @deprecated( reason: "use channel.viewerDropCampaigns" )
16
17	# A paginated list of users who are banned from this channel.
18	bannedUsers(after: Cursor, first: Int): ChannelBannedUserConnection
19
20	# The boost settings for the channel.
21	boostSettings: BoostSettings
22
23	# The language the broadcaster has chosen to stream in.
24	broadcasterLanguage: String! @deprecated( reason: "Use stream.language instead." )
25
26	# The celebration configuration for the channel, which contains if celebrations
27	# are enabled and a list of configured celebrations.
28	celebrations: CelebrationConfig
29
30	# The stream key for this channel if it is a multi-view chanlet. The requesting
31	# user must "own" this chanlet to be authorized to see this.
32	chanletStreamKey: String
33
34	# A list of the channel's chanlets (sub-channels) in a multi-view experience.
35	chanlets(sort: ChanletSort, bypassDisableFlag: Boolean): [Channel!]
36
37	# Get the chatters on this channel.
38	chatters: ChattersInfo
39
40	# The clip settings for a channel, includes settings on clip creation.
41	clipsSettings: ChannelClipsSettings
42
43	# Get a single community points custom reward redemption by its ID.
44	communityPointsCustomRewardRedemption(
45	id: ID!
46	): CommunityPointsCustomRewardRedemption
47
48	# The queue of community points custom reward redemptions in this channel.
49	communityPointsRedemptionQueue(
50	first: Int,
51	after: Cursor,
52	options: CommunityPointsRedemptionQueueOptions
53	): CommunityPointsCustomRewardRedemptionConnection
54
55	# Details about community points in the channel.
56	communityPointsSettings: CommunityPointsChannelSettings
57
58	# For a multi-view chanlet, this is the list of content attributes that have been
59	# associated with the given chanlet.
60	contentAttributes: [MultiviewContentAttribute!]
61
62	# The channel's badge flair setting and assets that are available to eligible
63	# subscribers.
64	creatorBadgeFlair: CreatorBadgeFlair
65
66	# Fetch the requesting user's currently playing radio content.
67	currentRadioTrack: RadioCurrentlyPlaying
68
69	# Returns configurations for a dashboard view in different parts of Twitch, such
70	# as Stream Manager
71	# or Twitch Studio. Includes configurations for things like layout and other
72	# features.
73	dashboardView(type: ChannelDashboardViewType!): ChannelDashboardView!
74
75	# The channel's name, with user-specified formatting.
76	displayName: String
77
78	# A drop 2.0 campaign including personal settings (e.g. account connection
79	# status). (Streamer dashboard individual item).
80	dropCampaign(id: ID!): DropCampaign
81
82	# A list of all available Drops 2.0 campaigns that a channel is eligible to
83	# participate in. (Streamer dashboard list).
84	dropCampaigns: [DropCampaign!]
85
86	# founderBadgeAvailability is a number of available slots for Founder Badge
87	# entitlement.
88	founderBadgeAvailability: Int!
89
90	# The name of the last game played on this channel.
91	game: String! @deprecated( reason: "Use user.lastBroadcast.game.name instead." )
92
93	# The Home of a channel.
94	home: ChannelHome
95
96	# The structure that contains information about the channel's Hype Train execution
97	# and config.
98	hypeTrain: HypeTrain!
99
100	# The channel's unique identfier.
101	id: ID!
102
103	# A setting which states whether or not users can create Clips on this channel.
104	# By default, clipping on a channel is enabled.
105	isClipsEnabled: Boolean! @deprecated( reason: "Use channel.clipsSettings instead." )
106
107	# Whether or not the channel is a hidden multi-view chanlet that is only meant to
108	# be accessible through another channel and not exist as a completely independent
109	# channel.
110	isHiddenChanlet: Boolean!
111
112	# Whether the broadcaster has designated the channel's broadcast for mature
113	# audiences only.
114	isMature: Boolean! @deprecated( reason: "Use stream.isMature instead." )
115
116	# Whether the channel has opted out of drops.
117	isOptedOutOfDrops: Boolean
118
119	# Whether the channel is using the new AutoMod vendor for enforcement.
120	isMemberOfAutoModRollout: Boolean
121
122	# leaderboardSet contains the set of leaderboards that are active on this channel.
123	leaderboardSet(first: Int): LeaderboardSet
124
125	# leaderboardTimePeriod indicates whether the leaderboard type is of WEEKLY,
126	# ALL-TIME, etc.
127	leaderboardTimePeriod: LeaderboardTimePeriodType
128
129	# All Prediction Events that are no longer accepting new predictions, and are
130	# awaiting resolution.
131	lockedPredictionEvents: [PredictionEvent!]
132
133	# Retrieves video manager videos for the channel, this requires owner or editor
134	# permissions.
135	managedVideos(
136	first: Int,
137	after: Cursor,
138	statuses: [VideoStatus!],
139	types: [BroadcastType!],
140	sort: VideoSort
141	): VideoConnection
142
143	# Returns a resolver to query moderation logs.
144	moderationLogs: ModerationLogs
145
146	# The channel's name.
147	name: String!
148
149	# The number of VIP roles a user can assign in their channel.
150	numberOfVIPsAllowed: Int
151
152	# The user who owns this channel.
153	owner: User
154
155	# Configurations for chanlets this channel owns.
156	ownerChanletAttributes: OwnerChanletAttributes
157
158	# Settings dictating how Prediction Events are run on this channel.
159	predictionSettings: ChannelPredictionSettings
160
161	# Fetches most recent chat messages sent for the given channel.
162	recentChatMessages: [Message!]!
163
164	# A single page of Prediction Events that have been resolved.
165	resolvedPredictionEvents(first: Int, after: Cursor): PredictionEventConnection
166
167	# The restriction that is currently active on the channel for restricting a user's
168	# access to it.
169	restriction: ResourceRestriction
170
171	# The stream schedule of the user.
172	# Returns null when the user has not set a schedule.
173	schedule: Schedule
174
175	# The requesting user's relationship with the channel.
176	self: ChannelSelfEdge
177
178	# Extension information pertaining to the active user. Note that this is not part
179	# of the `self` property as this still returns data for anonymous users.
180	selfInstalledExtensions(isMobile: Boolean): [ExtensionInstallationSelfEdge!]
181
182	# The channel's social media links and favicons.
183	socialMedias: [SocialMedia!]
184
185	# A user-defined status message.
186	status: String! @deprecated( reason: "Use user.lastBroadcast.title instead." )
187
188	# The live broadcast associated with this channel, if currently broadcasting.
189	stream: Stream @deprecated( reason: "Use user.stream instead." )
190
191	# A list of streams for a given channel for multi-view.
192	streams: [Stream!]
193
194	# Channel trailer for this channel.
195	trailer: Trailer
196
197	# Requests from channel-banned users to be unbanned submitted on the channel.
198	# Accessible by users with moderator role or higher.
199	unbanRequests(after: Cursor, first: Int, options: UnbanRequestsOptions): UnbanRequestConnection
200
201	# Settings for users creating unban requests on the channel.
202	unbanRequestsSettings: UnbanRequestsSettings
203
204	# The URL to view the channel in a browser.
205	url: String!
206
207	# Video stream settings for ingesting a stream such as stream key, latency mode,
208	# or vod save preference.
209	videoStreamSettings: VideoStreamSettings
210
211	# A list of available Drop 2.0 Campaigns of which drops viewers of this channel
212	# can claim when certain game events or minutes watched events are met. (Channel
213	# highlight card).
214	viewerDropCampaigns: [DropCampaign!]
215
216	}

Channel

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by