TwitchApi.Helix (twitch_api v0.2.1)

The Twitch API

Twitch API version: Helix

Link to this section Summary

Functions

create_channel_points_custom_reward(client_id, user_access_token, user_id, title, cost)

Create a channel points icon on a channel

get_user_image_by_user_id!(user_access_token, client_id, user_id)

Get the user's profile image by their user id (channel)

get_user_info_by_user_id!(user_access_token, client_id, user_id)

Get information about the user by their id (channel)

get_username_by_user_id!(user_access_token, client_id, user_id)

Get the username by their user id (channel)

is_banned_for_channel?(user_access_token, client_id, channel, user_id)

Check whether this user is banned for a channel

is_installed?(client_id, access_token)

Check whether the extension is installed for a user Using the user access token directly

is_installed?(client_id, app_access_token, user_id)

Check whether the extension is installed for a user Using the extensions app_access_token

is_live?(user_access_token, client_id, user_id)

Is the user or streamer live?

Link to this section Functions

create_channel_points_custom_reward(client_id, user_access_token, user_id, title, cost)

Create a channel points icon on a channel

get_user_image_by_user_id!(user_access_token, client_id, user_id)

Get the user's profile image by their user id (channel)

get_user_info_by_user_id!(user_access_token, client_id, user_id)

Get information about the user by their id (channel)

{
  :ok,
   %{
   "data" => [
     %{
       "broadcaster_type" => _,
       "created_at" => _,
       "description" => _,
       "display_name" => _,
       "email" => _,
       "id" => _,
       "login" => _,
       "offline_image_url" => _,
       "profile_image_url" => _,
       "type" => _,
       "view_count" => _,
     }
   ]
  }}
}

get_username_by_user_id!(user_access_token, client_id, user_id)

Get the username by their user id (channel)

is_banned_for_channel?(user_access_token, client_id, channel, user_id)

Check whether this user is banned for a channel

is_installed?(client_id, access_token)

Check whether the extension is installed for a user Using the user access token directly

is_installed?(client_id, app_access_token, user_id)

Check whether the extension is installed for a user Using the extensions app_access_token

is_live?(user_access_token, client_id, user_id)

Is the user or streamer live?