Chatters / Viewers Helix API Endpoint
The existing API endpoint for getting chatters predates User IDs and only returns usernames. It's also part of TMI and not officially documented, which could result in it being removed at any point without any notice.
Many bots use the endpoint for channel loyalty points, and then have to make secondary calls to the get the user ID.
The "Get Chatters" endpoint is now in general availability (as opposed to open beta). "user_id" and "user_name" have been added to the response. Documentation can be found here: https://dev.twitch.tv/docs/api/reference#get-chatters
@LosFarmosCTL oh thanks for that clarification, I missed that change. I mostly see small streamers and I guess in such cases we more or less see everyone in the chatters list, or at least numbers are not so different between viewers and chatters.
I guess we'll have to deal with that then :)
@Durss Nope, the viewer list on the 1st party website has also been changed to not show a full list of chatters, which has been communicated to be an intended change during a TwitchDev livestream. Twitch does not want this information to be public, the undocumented TMI endpoint is also going away in the future.
This endpoint will have parity with the twitch website (at least for the most part, cant remember for sure if they plan to keep that incomplete list around, but would be useless anyways), unlike i.e. the braindead get mods/vips endpoint.
Otherwise I agree, user IDs are kind of a must-have considering twitch is using them for literally everything else, I can understand that its a bit of a different case here since I am guessing that its essentially still a TMI endpoint just wrapped into Helix, which does still work primarily via usernames. But from what they said during the mentioned TwitchDev stream, they are looking into it.
User groups would also definitely be a nice QOL.
Is there any reason for this endpoint to be limited to broadcaster and mods?
The "follower" endpoints are being updated to reflect Twitch UI, If this endpoint was also reflecting Twitch UI I think it should be opened to anyone. Right now, via Twitch interface, we can see chatters of any channel without having to be the boradcaster or a mod.
Any chance this would change ?
It would also be great to have the user ID with the user name.
And, in an ideal world, the chatter type of the unofficial endpoint (broadcaster, vip, moderator, staff, admin, global_mod, viewer) was a nice to have to avoid additional API requests for some use cases like showing chatters list splitted by roles.
We are actively reviewing the use cases that were shared in the quarterly survey that closed on August 1. 72 developers provided feedback for this question, which we greatly appreciate! This will help us understand the best design for such an endpoint. The functionality would focus on chatters, i.e., users that are connected to chat. Given this research, I will move this suggestion into "Investigating."
I'm not sure I follow point #2. Do you mean providing userids with the call to see if those specific users are connected to chat or something else?
Any updates on this?
1. Making the chatters list an official API GET endpoint.
2. Possible inclusion of userids.
3. An optional parameter to get viewers instead of chatters.
We've added a question regarding a chatters endpoint to the latest quarterly survey. If there are additional thoughts or use cases beyond these comments that you would like to provide, please feel free to add those notes to a survey submission and it will be passed along. https://twitter.com/TwitchDev/status/1542995359122989056
6th most-voted idea in this section and there hasn't been a single update from Twitch regarding this. Come on Twitch!
I think its not a official way to use these API keys. You need to buy original API keys then you have to use it. I also did the same thing for my website https://www.travellersquest.com/blog/mountain-biking-in-nepal/.
This is a really needed extension to the TwitchAPI. My loyalty system is currently using current chatters endpoint, but that approach is excluding lurkers. They are just as important so it's sad to see there's no official way to get that data.
I can't believe there isn't an official, documented solution for this in 2022. Twitch, this is urgently needed, especially as we move towards community-driven creator ecosystems where seeing who is active and who isn't is key.
This endpoint should no longer exist.
It should have never made it to v5 and I'm perplexed how an open endpoint that shows all of the viewers in chat is still active. It's been abused for years.
If you need to keep it, then add a `channel:read:chatters` scope; and don't grandfather it in. Sunset.
It would be nice if this endpoint will also return user IDs, not just their logins. Maybe even chat badges.
There is still no official way to get a user list of viewers/chatters. At the moment lots of implementations (especially for activity rewards) rely on undocumented/unofficial endpoints.
I am open for helping out into finding a solution that could work best as a eventsub topic.
Not only for loyalty, this is very helpful for moderation, so you can see who is in the channel, especially which mods are online or not. The mods are also on the undocumented endpoint.
With the scheduled sunset of /NAMES the undocumented endpoint will probably be seeing and increase in usage. I'm sure lots of bot devs would like to see a long term/documented endpoint for chatter lists. Mostly related to loyalty points.
👍 This is still needed even with Twitch's Channel Points