TwitchApi.Clips.GetClips (TwitchApi v0.1.2) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

This gets information for clip AwkwardHelplessSalamanderSwiftRage. This gets the top 5 clips from broadcaster 1234.

requests:

curl -X GET 'https://api.twitch.tv/helix/clips?broadcaster_id=1234&first=5'
-H'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2' curl -X GET 'https://api.twitch.tv/helix/clips?id=AwkwardHelplessSalamanderSwiftRage'
-H'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'

Example response from twitch api docs:

descriptions:

responses:

{"data":[{"id":"RandomClip1","url":"https://clips.twitch.tv/AwkwardHelplessSalamanderSwiftRage","embed_url":"https://clips.twitch.tv/embed?clip=RandomClip1","broadcaster_id":"1234","broadcaster_name":"JJ","creator_id":"123456","creator_name":"MrMarshall","video_id":"1234567","game_id":"33103","language":"en","title":"random1","view_count":10,"created_at":"2017-11-30T22:34:18Z","thumbnail_url":"https://clips-media-assets.twitch.tv/157589949-preview-480x272.jpg","duration":12.9},...],"pagination":{"cursor":"eyJiIjpudWxsLCJhIjoiIn0"}} {"data":[{"id":"AwkwardHelplessSalamanderSwiftRage","url":"https://clips.twitch.tv/AwkwardHelplessSalamanderSwiftRage","embed_url":"https://clips.twitch.tv/embed?clip=AwkwardHelplessSalamanderSwiftRage","broadcaster_id":"67955580","broadcaster_name":"ChewieMelodies","creator_id":"53834192","creator_name":"BlackNova03","video_id":"205586603","game_id":"488191","language":"en","title":"babymetal","view_count":10,"created_at":"2017-11-30T22:34:18Z","thumbnail_url":"https://clips-media-assets.twitch.tv/157589949-preview-480x272.jpg","duration":60}]}

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 specifying broadcaster_id or game_id. The cursor value specified here is from the pagination response field of a prior query.

Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. This applies only to queries specifying broadcaster_id or game_id. The cursor value specified here is from the pagination response field of a prior query.

ID of the broadcaster for whom clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.

Ending date/time for returned clips, in RFC3339 format. (Note that the seconds value is ignored.) If this is specified, started_at also must be specified; otherwise, the time period is ignored.

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

ID of the game for which clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.

ID of the clip being queried. Limit: 100.

Starting date/time for returned clips, in RFC3339 format. (The seconds value is ignored.) If this is specified, ended_at also should be specified; otherwise, the ended_at date/time will be 1 week after the started_at value.

Functions

Description:

Gets clip information by clip ID (one or more), broadcaster ID (one only), or game ID (one only).

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 specifying broadcaster_id or game_id. The cursor value specified here is from the pagination response field of a prior query.

Specs

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

Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response. This applies only to queries specifying broadcaster_id or game_id. The cursor value specified here is from the pagination response field of a prior query.

Specs

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

ID of the broadcaster for whom clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.

Specs

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

Ending date/time for returned clips, in RFC3339 format. (Note that the seconds value is ignored.) If this is specified, started_at also must be specified; otherwise, the time period is ignored.

Specs

first() :: %{first: integer()}

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

Specs

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

ID of the game for which clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.

Specs

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

ID of the clip being queried. Limit: 100.

Specs

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

Starting date/time for returned clips, in RFC3339 format. (The seconds value is ignored.) If this is specified, ended_at also should be specified; otherwise, the ended_at date/time will be 1 week after the started_at value.

Link to this section Functions

Specs

call(
  broadcaster_id()
  | game_id()
  | id()
  | after_query_param()
  | before()
  | ended_at()
  | first()
  | started_at()
) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

Gets clip information by clip ID (one or more), broadcaster ID (one only), or game ID (one only).

Required authentication:

OAuth or App Access Token required.

Required authorization: