84 results found
-
Documentation still outdated for helix requirements Even tho https://twitch.uservoice.com/forums/310213-developers/suggestions/40340764-add-client-id-headers-to-examples is marked as completed the docs are still 90% outta date for helix changes (According to Barry)
https://dev.twitch.tv/docs/api/guide#rate-limits still talks about not provided tokens
https://dev.twitch.tv/docs/api#step-2-sample-code still doesn't use a OAuth token
https://dev.twitch.tv/docs/api#step-3-results Is incorrect because step 2 doesn't use a OAuth token
8 votes -
Docs missing first/pagination on API's that support them From: https://github.com/twitchdev/issues/issues/19
Brief description
Many API's don't document that they support
firstandafterExpected documentation
Document first/after in the optional query parameters
Additional context or questions
Missing First in
Optional Query Parameters
- Get Banned Users
- Get Moderators
- Get Moderator Events
- Get Broadcaster Subscriptions
- Get VideosMissing Pagination in the
Return Values
- Get Broadcaster Subscriptions
- Get Videos8 votes -
Get users doesn't mention that an App Access Token works https://dev.twitch.tv/docs/api/reference#get-users
Mentions User OAuth and the optional scope, but doesn't mention that you can use an app access token for this endpoint to get "public" data.
Authentication User OAuth Token Optional scope: user:read:email If this scope is provided, the response includes the user’s email address.Should probably read
Authentication - App Access Token - User OAuth Token any/no scopes - User OAuth Token with scope: user:read:email response includes the user’s email address.7 votes -
Missing scope From: https://github.com/twitchdev/issues/issues/63
Brief description
The channel:read:redemptions scope is required by the Channel Points PubSub topic (https://dev.twitch.tv/docs/pubsub#topics) but not mentioned in the scopes overview (https://dev.twitch.tv/docs/authentication#scopes)Expected documentation
The channel:read:redemptions listed on the overview page (https://dev.twitch.tv/docs/authentication#scopes)7 votes -
It is unclear that "Authentication none" means "any token" Some endpoint in the docs say "authentication none" leading to some confusion
https://discuss.dev.twitch.tv/t/getting-top-games-in-python/28256/
6 votes -
broadcaster_name not noted in return values of Get Channel info https://dev.twitch.tv/docs/api/reference#get-channel-information
Omits the description of "broadcastername" and as per https://github.com/twitchdev/issues/issues/3 it's the "dISpLaYNaME" of the caster not the username.
So we have to do a second lookup to get the
loginfor embed purposes6 votes -
Document correction for helix moderators endpoint https://dev.twitch.tv/docs/api/reference#get-moderators Under optional parameter for user_id the description says for users who are banned in this channel for the moderators endpoint.
6 votes -
Fix or improve your API Documentation. Step 2 is unclear or wrong.
I'm unable to make it work only by changing the Client-ID, nor removing the Authentication headers.
You should precise that both need to be changed. Or maybe the OAuth token should work, but it doesn't.Fix your documentation it's important for developers that everything written here is clear and easily understandable by anyone (or at least devs).
I recommend you to make a full review of the entire documentation... (Get some newbie devs to test it, if they do not understand, it's not written correctly)
Also I really encourage you to make some sample…
5 votesEarlier in the year, the API example had been fixed and the guide has been rewritten.
-
links no-longer clickable The procedures are no longer clickable at https://dev.twitch.tv/docs/authentication#getting-tokens.
(for a clickable reference see https://web.archive.org/web/20191220122144/https://dev.twitch.tv/docs/authentication)
5 votes -
Error in "Refreshing access tokens" section The actual docs states that "When you make a request with expired or incorrect authorization credentials, the API returns a WWW-Authenticate header (with an invalid_token error) and a 401 Unauthorized status", but the WWW-Authenticate header is not present in the response.
Moreover the example shows a kraken endpoint.
4 votes -
Correct typing errors in the "Scopes" At https://dev.twitch.tv/docs/authentication#scopes
- "channel:manage:brodcast" is misspelled (should be "channel:manage:broadcast")
- "channel:manage:extension" is misspelled (should be "channel:manage:extensions")As metioned in other posts "channel:read:redemptions" is still missing there.
4 votes -
4 votes
EventSub is our Webhooks solution. We will remove the legacy Webhooks section of the docs when our Legacy Webhooks product is shut down later this year.
-
New IRC tag "msg-params-gift-months" in docs is actually "msg-param-gift-months" The recent announcement "Updates to PubSub Messages and IRC for Multi-Month Subscription Gifting" (https://discuss.dev.twitch.tv/t/updates-to-pubsub-messages-and-irc-for-multi-month-subscription-gifting/26873) and IRC Tags docs (https://dev.twitch.tv/docs/irc/tags#usernotice-twitch-tags) lists the new "msg-params-gift-months" tag, but like all other so far it's actually singular "param" not "params" ("msg-param-gift-months") in reality.
4 votes -
Helix Users docs showing optional scope as required The Helix Users endpoint docs state the "user:read:email" scope as required, although it is an optional scope if you also need the users email returned.
4 votes -
Documentation not updated for oAuth changes on Helix As per
https://discuss.dev.twitch.tv/t/requiring-oauth-for-helix-twitch-api-endpoints/23916
None of the documentation is updated to reflect this change.
Yes it's not required yet. But it's good practice for new developers to be using the new oAuth procedure now
4 votes -
4 votes
-
Webhooks limits: ambiguous From: https://github.com/twitchdev/issues/issues/65
Brief description
https://dev.twitch.tv/docs/api/webhooks-guide
Limits: By default, each client ID can have at most 10,000 subscriptions. Also, you can subscribe to the same topic at most 3 times.
Seems to be ambiguous to a lot of developers, they seem to think the that "3 times" means they can renew it 3 times then they are SOOL
Expected documentation
Limits: Each client ID can have at most 10,000 subscriptions. Where you can have 3 active subscriptions to a topic at the same time. Where an active subscription is defined as a topic/callback pair.
4 votes -
Get All Chat Emoticons From: https://github.com/twitchdev/issues/issues/10
Brief description
Docs state the "images" is an array
{
"links": {
"self": "http://api.twitch.tv/kraken/chat/emoticons"
},
"emoticons": [
{
"id": 115390,
"regex": "TwitchLit",
"images": [
{
"width": 28,
"height": 28,
"url": "https://static-cdn.jtvnw.net/jtvuserpictures/emoticon-115390-src-b577ded8522fc1a1-28x28.png",
"emoticonset": 19151
}
]
},
{
"id": 80393,
"regex": "Kappa",
"images": [
{
"width": 28,
"height": 28,
"url": "https://static-cdn.jtvnw.net/jtv_user_pictures/emoticon-80393-src-cf7c8d03a4c5cb75-28x28.png",
"emoticon_set": 15940
}
]
}
]
}Expected documentation
…{ "_links": { "self": "http://api.twitch.tv/kraken/chat/emoticons" }, "emoticons": [ { "id": 115390, "regex": "TwitchLit", "images": { "width": 28, "height": 28, "url": "https://static-cdn.jtvnw.net/jtv_user_pictures/emoticon-115390-src-b577ded8522fc1a1-28x28.png", "emoticon_set": 19151 } }, { "id": 80393, "regex": "Kappa",4 votes -
Extension viewer Session Token From: https://github.com/twitchdev/issues/issues/51
Brief description
https://dev.twitch.tv/docs/extensions/reference#helper-viewer
documentation wrong:
sessionToken Twitch.ext.viewer.isLinked: string The encoded JWT. This is the same as the token property of the authData parameter that currently gets passed to the onAuthorized callback.Expected documentation
sessionToken Twitch.ext.viewer.sessionToken: string The encoded JWT. This is the same as the token property of the authData parameter that currently gets passed to the onAuthorized callback.3 votesCorrected for today’s deployment
-
Get Broadcaster Subscriptions with an App Access Token From: https://github.com/twitchdev/issues/issues/45
Brief description
Get Broadcaster Subscriptions doesn't describe how you can use an "App Access Token" for an extension that has sub status enabled, to use the end point
Expected documentation
Describe that an "Extension App Access token" can be used when a broadcaster has granted the "channel:read:subscriptions" scope via the Twitch Extension Manager
3 votesAdded to today’s documentation deployment
- Don't see your idea?