TwitchApi.Subscriptions.GetBroadcasterSubscriptions (TwitchApi v0.1.2) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

requests:

curl -X GET 'https://api.twitch.tv/helix/subscriptions?broadcaster_id=141981764'
-H'Authorization: Bearer cfabdegwdoklmawdzdo98xt2fo512y'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'

Example response from twitch api docs:

descriptions:

responses:

{"data":[{"broadcaster_id":"141981764","broadcaster_login":"twitchdev","broadcaster_name":"TwitchDev","gifter_id":"12826","gifter_login":"twitch","gifter_name":"Twitch","is_gift":true,"tier":"1000","plan_name":"Channel Subscription (twitchdev)","user_id":"527115020","user_name":"twitchgaming","user_login":"twitchgaming"},...],"pagination":{"cursor":"xxxx"},"total":13}

Link to this section Summary

Types

Cursor for forward pagination: tells the server where to start fetching the next set of results in a multi-page response. This applies only to queries without user_id. If a user_id is specified, it supersedes any cursor/offset combinations. The cursor value specified here is from the pagination response field of a prior query.

User ID of the broadcaster. Must match the User ID in the Bearer token.

Maximum number of objects to return. Maximum: 100. Default: 20.

Filters results to only include potential subscriptions made by the provided user IDs. Accepts up to 100 values.

Functions

Description:

Gets all of a broadcaster’s subscriptions.

Link to this section Types

Specs

after_query_param() :: %{after_query_param: String.t()}

Cursor for forward pagination: tells the server where to start fetching the next set of results in a multi-page response. This applies only to queries without user_id. If a user_id is specified, it supersedes any cursor/offset combinations. The cursor value specified here is from the pagination response field of a prior query.

Specs

broadcaster_id() :: %{broadcaster_id: String.t()}

User ID of the broadcaster. Must match the User ID in the Bearer token.

Specs

first() :: %{first: String.t()}

Maximum number of objects to return. Maximum: 100. Default: 20.

Specs

user_id() :: %{user_id: String.t()}

Filters results to only include potential subscriptions made by the provided user IDs. Accepts up to 100 values.

Link to this section Functions

Specs

call(broadcaster_id() | user_id() | after_query_param() | first()) ::
  {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

Gets all of a broadcaster’s subscriptions.

Required authentication:

OAuth token required Required scope: channel:read:subscriptions Subscriptions can be requested on behalf of a broadcaster with a user access token or by a Twitch Extension with an app access token if the broadcaster has granted the channel:read:subscriptions scope from within the Twitch Extensions manager.

Required authorization: