83 results found
-
Get Subscriptions Endpoint description is ambiguous The Documentation for the Get Broadcaster Subscriptions Endpoint has a description of
Get all of a broadcaster’s subscriptions.
- This is ambiguous and sounds like it returns the Subscriptions to other channels a Broadcaster has whereas it returns the users that subscribed to the broadcaster.I would suggest changing the description to say
Get all of a broadcaster’s subscribers.
instead.2 votes -
Authentication for oAuth is unclear https://dev.twitch.tv/docs/authentication/getting-tokens-oauth
Both Implicit code flow and authorization code flow label the first step as a "HTTP GET" instead of "this is a link that you need to put on a page for the user you wish to authenticate" or "you need to redirect the user to this page"
Too many people are trying to curl/fetch the URL as the docs seem to label it as a HTTP GET request
2 votes -
bug report "Exchanging bits for a product" section has broken markdown link to /extensions/reference/#helper-bits
1 vote -
Typo A token bucketalgorithm
1 voteThis has been fixed.
-
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.
-
PubSub examples need to be updated for multi_month_duration The pubsub examples need to be extended for the new multi month gifting
2 votes -
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 -
1 vote
-
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 -
Words missing in docs Missing word(s) in this sentence:
"if the parameters supplied are you receive an immediate 202 Accepted response"
between the "are" and the "you" there's words missing.
1 vote -
formatting broken for example response Formatting broken for example response at https://dev.twitch.tv/docs/api/reference#get-hype-train-events
1 vote -
Chat embed ID parameter example/description Should the ID parameter now be "chat_embed" or the channel name? Parameter description and example code don't match or I don't understand it.
1 vote -
Documentation for 'Get Users Follows' is out of date The documentation for Get Users Follows says: “Authentication: None”, but you get “OAuth token is missing” response when not using an app or user access token.
1 vote -
Missing Client-ID in examples The recent new end points caused the existing documentation to lose the Client-ID from all other examples as is required by the changes to helix.
For Example:
https://dev.twitch.tv/docs/api/reference#get-extension-analytics
curl -H 'Authorization: Bearer cfabdegwdoklmawdzdo98xt2fo512y' \ -X GET 'https://api.twitch.tv/helix/analytics/extensions?first=5'
Getting Started also needs to be updated as it doesn't reference authorization required at all
https://dev.twitch.tv/docs/api, and doesn't cover how to get authorization
1 vote -
Get Channel includes references to information not in the response https://dev.twitch.tv/docs/api/reference#get-channel-information
Refers to
status
anddescription
which are not in the responseAlso mentioned in
https://dev.twitch.tv/docs/api/reference#modify-channel-information
1 vote -
Documentation layout when scrolling You scroll to the right this happens:
1 vote -
The new documentation uses a different format to the cURL examples curl --location --request PATCH 'https://api.twitch.tv/helix/channels?broadcaster_id=41245072' \ --header 'client-id: wbmytr93xzw8zbg0p1izqyzzc5mbiz' \ --header 'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx' \ --header 'Content-Type: application/json' \ --data-raw '{"game_id":"33214", "title":"there are helicopters in the game? REASON TO PLAY FORTNITE found", "broadcaster_language":"en"}'
compared to
curl -H 'Authorization: Bearer cfabdegwdoklmawdzdo98xt2fo512y' \ -X GET 'https://api.twitch.tv/helix/streams/markers?user_id=123&first=5'
Examples should be consistent
1 vote -
Modify channel: oAuth confusing https://dev.twitch.tv/docs/api/reference#modify-channel-information
Says
Parameter Type Description broadcaster_id string ID of the channel to be updated
When it should say
User ID of the broadcaster. Must match the User ID in the Bearer token.
as per
https://discuss.dev.twitch.tv/t/announcing-the-latest-helix-endpoints-and-hype-train-api/26530/12
1 vote -
Some Typos on "The New API" Documentation Hello,
Searching in the documentation of the new API I have found these four small errors. They are not at all severe, but they should be remedied in order to facilitate the use of the API.
- https://dev.twitch.tv/docs/api/reference#get-extension-transactions => Link bad rendered in Markdown
- https://dev.twitch.tv/docs/api/reference#get-bits-leaderboard => typo on OAuth Token, missing O
- https://dev.twitch.tv/docs/api/reference#redeem-code => method missing
- https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions => Scope in wrong format (not labeled)
2 votes -
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
- Don't see your idea?