TwitchApi.Videos.GetVideos (TwitchApi v0.1.3) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
This gets information about the video with ID 335921245.
requests:
curl -X GET 'https://api.twitch.tv/helix/videos?id=335921245'
-H'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'
Example response from twitch api docs:
descriptions:
responses:
{"data":[{"id":"335921245","stream_id":null,"user_id":"141981764","user_login":"twitchdev","user_name":"TwitchDev","title":"Twitch Developers 101","description":"Welcome to Twitch development! Here is a quick overview of our products and information to help you get started.","created_at":"2018-11-14T21:30:18Z","published_at":"2018-11-14T22:04:30Z","url":"https://www.twitch.tv/videos/335921245","thumbnail_url":"https://static-cdn.jtvnw.net/cf_vods/d2nvs31859zcd8/twitchdev/335921245/ce0f3a7f-57a3-4152-bc06-0c6610189fb3/thumb/index-0000000000-%{width}x%{height}.jpg","viewable":"public","view_count":1863062,"language":"en","type":"upload","duration":"3m21s","muted_segments":[{"duration":30,"offset":120}]}],"pagination":{}}
![https://www.twitch.tv/videos/335921245","thumbnail_url":"https://static-cdn.jtvnw.net/cf_vods/d2nvs31859zcd8/twitchdev/335921245/ce0f3a7f-57a3-4152-bc06-0c6610189fb3/thumb/index-0000000000-%{width}x%{height}.jpg","viewable":"public","view_count":1863062,"language":"en","type":"upload","duration":"3m21s","muted_segments":[{"duration":30,"offset":120}]}],"pagination":{}}](https://www.twitch.tv/videos/335921245%22,%22thumbnail_url%22:%22https://static-cdn.jtvnw.net/cf_vods/d2nvs31859zcd8/twitchdev/335921245/ce0f3a7f-57a3-4152-bc06-0c6610189fb3/thumb/index-0000000000-%25%7Bwidth%7Dx%25%7Bheight%7D.jpg%22,%22viewable%22:%22public%22,%22view_count%22:1863062,%22language%22:%22en%22,%22type%22:%22upload%22,%22duration%22:%223m21s%22,%22muted_segments%22:[%7B%22duration%22:30,%22offset%22:120%7D]%7D],%22pagination%22:%7B%7D%7D){kind=link}
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. 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. The cursor value specified here is from the pagination response field of a prior query.
Number of values to be returned when getting videos by user or game ID. Limit: 100. Default: 20.
ID of the game the video is of. Limit 1.
ID of the video being queried. Limit: 100. If this is specified, you cannot use any of the optional query parameters below.
Language of the video being queried. Limit: 1. A language value must be either the ISO 639-1 two-letter code for a supported stream language or “other”.
Period during which the video was created. Valid values: "all", "day", "week", "month". Default: "all".
Sort order of the videos. Valid values: "time", "trending", "views". Default: "time".
Type of video. Valid values: "all", "upload", "archive", "highlight". Default: "all".
ID of the user who owns the video. Limit 1.
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. 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. The cursor value specified here is from the pagination response field of a prior query.
Specs
first() :: %{first: String.t()}
Number of values to be returned when getting videos by user or game ID. Limit: 100. Default: 20.
Specs
game_id() :: %{game_id: String.t()}
ID of the game the video is of. Limit 1.
Specs
id() :: %{id: String.t()}
ID of the video being queried. Limit: 100. If this is specified, you cannot use any of the optional query parameters below.
Specs
language() :: %{language: String.t()}
Language of the video being queried. Limit: 1. A language value must be either the ISO 639-1 two-letter code for a supported stream language or “other”.
Specs
period() :: %{period: String.t()}
Period during which the video was created. Valid values: "all", "day", "week", "month". Default: "all".
Specs
sort() :: %{sort: String.t()}
Sort order of the videos. Valid values: "time", "trending", "views". Default: "time".
Specs
type() :: %{type: String.t()}
Type of video. Valid values: "all", "upload", "archive", "highlight". Default: "all".
Specs
user_id() :: %{user_id: String.t()}
ID of the user who owns the video. Limit 1.
Link to this section Functions
Specs
call( id() | user_id() | game_id() | after_query_param() | before() | first() | language() | period() | sort() | type() ) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}
Description:
Gets video information by one or more video IDs, user ID, or game ID.
Required authentication:
User OAuth Token or App Access Token