Various Helix Endpoints return the users DisPlaYName instead of login #3

BarryCarlyon · 2019-12-06T19:45:05Z

Brief description

Streams API returns the user_name as the users display_name instead.

Meaning for people building a embed from an API lookup either parse the thumbnail URL for the username, or call the users API to get the correct login name for the embed.

This is particularly a problem for "Korean" Streamers

For example

https://api.twitch.tv/helix/streams?user_id=139470326

Which returns the user_name as 한동숙 which is not valid for building a embed or channel URL

How to reproduce

Call https://api.twitch.tv/helix/streams?user_login=cohhcarnage

Expected behavior

Return "cohhcarnage" as the user_name instead of "CohhCarnage"

And/or extend the endpoint to return both

The text was updated successfully, but these errors were encountered:

BarryCarlyon · 2019-12-06T19:49:45Z

The problem also exists with the follows endpoint

For example: https://api.twitch.tv/helix/users/follows?to_id=26610234

{
"from_id": "79645823",
"from_name": "Cochelosf",
"to_id": "26610234",
"to_name": "CohhCarnage",
"followed_at": "2019-12-06T19:44:14Z"
}

Both to_name and from_name contain the users display_name instead of the user login

BarryCarlyon · 2019-12-07T00:01:28Z

Issue also exists on live_activated_channels

{
"channels": [
{
"id": "40118378",
"username": "Chronor007",
"game": "Magic: The Gathering",
"title": "🥴 Trying new Liliana deck from Twitch Prime!🥴 [GER/EN] !sounds !sr ",
"view_count": "9218"
}
]
}

BarryCarlyon · 2019-12-16T18:25:33Z

Issues also exists on "Get Clips"

{
"data": [
{
"id": "EmpathicWildGuanacoKappaClaus",
"url": "https://clips.twitch.tv/EmpathicWildGuanacoKappaClaus",
"embed_url": "https://clips.twitch.tv/embed?clip=EmpathicWildGuanacoKappaClaus",
"broadcaster_id": "26610234",
"broadcaster_name": "CohhCarnage",
"creator_id": "17268377",
"creator_name": "KrunkSplein",
"video_id": "520874596",
"game_id": "494684",
"language": "en",
"title": "Loading Rock",
"view_count": 33,
"created_at": "2019-12-13T15:46:03Z",
"thumbnail_url": "https://clips-media-assets2.twitch.tv/AT-cm%7C583875183-preview-480x272.jpg"
}
],
"pagination": {}
}

mauerbac · 2020-03-30T18:36:10Z

HLX-1333

BarryCarlyon · 2020-04-26T10:34:12Z

Problem also exists on

BarryCarlyon · 2020-07-30T14:42:02Z

The new

https://dev.twitch.tv/docs/api/reference#get-channel-information

also has this issue, for example

{
  broadcaster_id: '23161357',
  broadcaster_name: 'LIRIK',
  broadcaster_language: 'en',
  game_id: '497440',
  game_name: 'Hell Let Loose',
  title: ':D '
}

BarryCarlyon · 2020-08-18T16:01:12Z

https://dev.twitch.tv/docs/extensions/reference/#get-live-channels-with-extension-activated

Example use case:

https://twitch.extensions.barrycarlyon.co.uk/elitetrack/

To show streamers live with my extension and link to their channel, I have to do two requests, one to live_activated then a second to users to get the login for link/embed purposes

dilizarov · 2020-09-13T11:33:07Z

@BarryCarlyon so what is the solution for generating URLS via this API: https://dev.twitch.tv/docs/api/reference#get-users?

If I'm reading correctly, display_name is not a reliable parameter (korean characters, etc. possible), so I should leverage the login parameter instead?

That is to say if I got { ..., display_name: "Display Name", login: "loginname", ... }, then I would generate the url https://twitch.tv/loginname, correct?

Essentially my use case is trying to get the URL to the authenticated user's profile.

BarryCarlyon · 2020-09-14T12:34:37Z

If I'm reading correctly, display_name is not a reliable parameter (korean characters, etc. possible), so I should leverage the login parameter instead?

Correct, the users API is the ONLY API that returns the actual login, where the login is used for URLs.

If you called the streams API, you get a list of Display Names then have to do a lookup against the users API to get the logins for construction URLs/links to channel. Two lookups where one should of suffice.

BarryCarlyon · 2020-09-20T15:10:30Z

https://dev.twitch.tv/docs/api/reference/#get-stream-markers

Returns dISPlayNAME instead of user login for the creating user of the marker

BarryCarlyon · 2020-10-30T15:52:40Z

Example use case: https://barrycarlyon.github.io/twitch_misc/examples/browse_following/

I have to do one call to get the streams of the people I follow.
Then a second call to get the usernames of those people to generate a link to that stream.

BarryCarlyon · 2020-11-20T18:40:40Z

EventSub has now contracted the virus for saying "name" and sending dIsPlAy_NaMe instead

BarryCarlyon · 2021-01-07T12:57:05Z

Eventsub fixed it on eventsub \o/

…kuped as the streams API has the login returned as user_name

BarryCarlyon · 2021-01-29T01:37:26Z

As per todays documentation and API update noted in the change log

https://dev.twitch.tv/docs/change-log

The following endpoints no longer suffer from GitHub issue 3.

GET	helix/bits/leaderboard
GET	helix/channel_points/custom_rewards
PATCH helix/channel_points/custom_rewards
POST helix/channel_points/custom_rewards
GET	helix/channel_points/custom_rewards/redemptions
PATCH helix/channel_points/custom_rewards/redemptions
GET	helix/extensions/transactions
GET	helix/moderation/banned
GET	helix/moderation/banned/events
GET	helix/moderation/moderators
GET	helix/moderation/moderators/events
GET	helix/search/channels
GET	helix/streams
GET	helix/streams/markers
GET	helix/videos
GET	helix/users/follows

Most notably omitted at this time are the subscription related endpoints and extension live_activated_channels

But not longer for streams do we need to fetch users to get the username to link with! \o/

BarryCarlyon · 2021-03-04T23:03:54Z

Channel editors has the virus!

https://dev.twitch.tv/docs/api/reference#get-channel-editors

BarryCarlyon · 2022-03-04T00:40:31Z

And the new Get Extension Live Channels has it too which replaced extension live_activated_channels

https://dev.twitch.tv/docs/api/reference#get-extension-live-channels

Xemdo · 2023-07-27T21:59:59Z

Get Extension Live Channels and Get Channel Editors currently seem to be correct as per our documentation. broadcaster_name is the display name, not the user's login. The Get Extension Live Channels endpoint simply does not return the user's login, just Display Name and User ID.

Behavior likely wont change as user_name is consistent across all API endpoints. Ideally it would be called display_name instead, but since the field is already in place it would be a breaking change to rename it.
Best course of action from here would be adding the field user_login to these endpoints, but that would be a UserVoice suggestion rather than a bug.

BarryCarlyon added the product: api API endpoints in the "helix" namespace label Dec 6, 2019

BarryCarlyon mentioned this issue Dec 9, 2019

Helix Streams is skipping Streams #11

Closed

mauerbac added the ticketed Has been given an internal tracking ticket label Mar 30, 2020

BarryCarlyon mentioned this issue Apr 26, 2020

Subscriptions events uses display_name in some cases #97

Closed

iProdigy mentioned this issue Jun 4, 2020

ClientHelper: Use login and Stream in events, address potential thread contention twitch4j/twitch4j#138

Merged

2 tasks

BarryCarlyon mentioned this issue Oct 31, 2020

Live Activated Extensions returns display name and sometimes a blank one as username #248

Open

jbulava mentioned this issue Dec 11, 2020

Webhooks sending displayName instead of userName #265

Closed

Emilgardis mentioned this issue Dec 30, 2020

Fix user_name actually being display_name twitch-rs/twitch_api#60

Closed

mitchwadair mentioned this issue Jan 10, 2021

Minor Doc Changes for Recent Payload Changes mitchwadair/tesjs#14

Merged

BarryCarlyon added a commit to BarryCarlyon/twitch_misc that referenced this issue Jan 29, 2021

Due to partial resolve of twitchdev/issues#3 don't need the users loo…

5afc7c1

…kuped as the streams API has the login returned as user_name

BarryCarlyon mentioned this issue Jan 29, 2021

Search returns broadcaster_login as true or blank #296

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Various Helix Endpoints return the users DisPlaYName instead of login #3

Various Helix Endpoints return the users DisPlaYName instead of login #3

BarryCarlyon commented Dec 6, 2019 •

edited

Loading

BarryCarlyon commented Dec 6, 2019

BarryCarlyon commented Dec 7, 2019

BarryCarlyon commented Dec 16, 2019

mauerbac commented Mar 30, 2020

BarryCarlyon commented Apr 26, 2020 •

edited

Loading

BarryCarlyon commented Jul 30, 2020

BarryCarlyon commented Aug 18, 2020

dilizarov commented Sep 13, 2020 •

edited

Loading

BarryCarlyon commented Sep 14, 2020

BarryCarlyon commented Sep 20, 2020

BarryCarlyon commented Oct 30, 2020

BarryCarlyon commented Nov 20, 2020

BarryCarlyon commented Jan 7, 2021

BarryCarlyon commented Jan 29, 2021 •

edited

Loading

BarryCarlyon commented Mar 4, 2021

BarryCarlyon commented Mar 4, 2022 •

edited

Loading

Xemdo commented Jul 27, 2023

Various Helix Endpoints return the users DisPlaYName instead of login #3

Various Helix Endpoints return the users DisPlaYName instead of login #3

Comments

BarryCarlyon commented Dec 6, 2019 • edited Loading

BarryCarlyon commented Dec 6, 2019

BarryCarlyon commented Dec 7, 2019

BarryCarlyon commented Dec 16, 2019

mauerbac commented Mar 30, 2020

BarryCarlyon commented Apr 26, 2020 • edited Loading

BarryCarlyon commented Jul 30, 2020

BarryCarlyon commented Aug 18, 2020

dilizarov commented Sep 13, 2020 • edited Loading

BarryCarlyon commented Sep 14, 2020

BarryCarlyon commented Sep 20, 2020

BarryCarlyon commented Oct 30, 2020

BarryCarlyon commented Nov 20, 2020

BarryCarlyon commented Jan 7, 2021

BarryCarlyon commented Jan 29, 2021 • edited Loading

BarryCarlyon commented Mar 4, 2021

BarryCarlyon commented Mar 4, 2022 • edited Loading

Xemdo commented Jul 27, 2023

BarryCarlyon commented Dec 6, 2019 •

edited

Loading

BarryCarlyon commented Apr 26, 2020 •

edited

Loading

dilizarov commented Sep 13, 2020 •

edited

Loading

BarryCarlyon commented Jan 29, 2021 •

edited

Loading

BarryCarlyon commented Mar 4, 2022 •

edited

Loading