V5 Documentation is here!

Hey, everyone!

As promised, here are the docs for v5. All new docs will be on the developer website. We’ll be deprecating the GitHub shortly.

Please be aware of a few things:

  • Reference material was consolidated based on URL. For example, there used to be a Subscriptions category. Instead, those have gone under their respective channel and users pages.
  • We have a new guide: Using the Twitch API. This is meant to cover how to get started with the API including getting a Client-ID, etc.
  • We have a new landing page: Twitch API Overview. This is meant to cover any meaningful changes for the API. This includes our deprecation timeline and changes that are applicable to v5 (from the blog post).
  • Lots of rewriting of text. The goal was a more consistent set of documentation. Please let me know if you see any rendering errors or text bugs.

Thanks for your patience with the documentation! We will continue to iterate on these docs as needed.

-Dallas

12 Likes

I am sure I speak for many when I say, thank you Dallas and team!

1 Like

?login= for /kraken/users/ doesn’t seem to be documented under the users page, which is where I’d expect to find it.

1 Like

@3ventic Just an oversight on my part (and the internal docs). Thanks for the heads up!

1 Like

Hey @DallasNChains, great work getting the docs up so fast. I’ve tried implementing the changes, and I’m running into an issue. I verified that I’ve set “application/vnd.twitchtv.v5+json” as the “Accept” in the header, but whenever I try to make a request using my channel id, I get a response saying “User 12326611 does not exist”. I doubled checked, and this is the value being returned under “_id” from “Get Channel”.

https://api.twitch.tv/kraken/channels/12326611/follows” is the URL.

Thanks!

@jpcguy89 “application/vnd.twitchtv.v5+json” should be the “Accept” header, not “Content-Type”, like this example in the docs:

curl -H 'Accept: application/vnd.twitchtv.v5+json' \
-H 'Authorization: OAuth cfabdegwdoklmawdzdo98xt2fo512y' \
-X GET https://api.twitch.tv/kraken

@Dist That’s what I meant. Just checked my code, it’s set as the accept header.

@jpcguy89 I can’t repro this. That channel ID gives me a list of followers for your channel. Can you paste your code (and please remove anything sensitive)?

how to get the list of emoticons per user in v5? i only found a way to get all emoticons which is very large

https://api.twitch.tv/kraken/chat/{user_id}/emoticons

this end point doesn’t seem to work…
i already set the right headers. v5, client id, auth token
its just that i can’t find the right end point

The docs show the endpoint of getChannel using the OAuth token as
https://api.twitch.tv/kraken/channels

Which doesn’t work

https://api.twitch.tv/kraken/channel
Is what works for me. Not sure if it’s an api or docs issue, just wanted to let you know :slight_smile:

@marloeleven Is this what you’re looking for? https://dev.twitch.tv/docs/v5/reference/users/#get-user-emotes

@Fireblazerrr Thanks for the report! It’s a docs issue. :slight_smile:

@DallasNChains Follow up to Marloeleven’s comment, kraken/users/<user ID>/emotes provides the list of emotes an user has access to use, not the list of subscription emotes available on a particular channel which /kraken/chat/<channelID>/emoticons currently provides in v3 and is broken or missing from v5.

Since there is no way to translate an emoteset ID to a channel name/ID so /kraken/chat/<channelID>/emoticons is needed for sites like twitchemotes.com to function.

I assuming it was just an oversight since /kraken/chat/<channelID>/emoticons is not listed a being removed in the v5 changelog :stuck_out_tongue:

3 Likes

yes this is what i am looking for… please provide the same end point just like in v3

I also have a few applications that rely on having the entire list of emotes (with a way to get the image URL as well, right now the ID is enough for the CDN URL). Is there a way to do this with v5?

Holiday break took over, so sorry for the slow response!

I’ll check on this for you. Thanks for the context!

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.