Skip to content

Latest commit

 

History

History
242 lines (213 loc) · 8.49 KB

videos.md

File metadata and controls

242 lines (213 loc) · 8.49 KB
Raw

Videos

Videos are broadcasts or highlights owned by a channel. Broadcasts are unedited videos that are saved after a streaming session. Highlights are videos edited from broadcasts by the channel's owner.

Endpoint Description
GET /videos/:id Get video object
GET /videos/top Get top videos by number of views
GET /channels/:channel/videos Get list of video objects belonging to channel

GET /videos/:id

Returns a video object.

Example Request

curl -H 'Accept: application/vnd.twitchtv.v2+json' \
-X GET https://api.twitch.tv/kraken/videos/a328087483

Example Response

{
  "recorded_at": "2012-08-09T20:49:47Z",
  "title": "VanillaTV - Sweden vs Russia - ETF2L Nations Cup - Snakewater [Map3] - Part 3",
  "url": "http://www.twitch.tv/vanillatv/b/328087483",
  "_id": "a328087483",
  "_links": {
      "self": "https://api.twitch.tv/kraken/videos/a328087483",
      "owner": "https://api.twitch.tv/kraken/channels/vanillatv"
  },
  "embed": "<object type="application/x-shockwave-flash" height="300" width="400" id="clip_embed_player_flash" data="http://www.justin.tv/widgets/archive_embed_player.swf" bgcolor="#000000">
      <param name="movie" value="http://www.justin.tv/widgets/archive_embed_player.swf" />
      <param name="allowScriptAccess" value="always" />
      <param name="allowNetworking" value="all" />
      <param name="allowFullScreen" value="true" />
      <param name="flashvars" value="channel=vanillatv&title=VanillaTV - Sweden vs Russia - ETF2L Nations Cup - Snakewater [Map3] - Part 3&auto_play=false&archive_id=328087483&start_volume=25" />
  </object>",
  "views": 93,
  "description": "VanillaTV - Sweden vs Russia - ETF2L Nations Cup - Snakewater [Map3] - Part 3",
  "length": 204,
  "game": null,
  "preview": "http://static-cdn.jtvnw.net/jtv.thumbs/archive-328087483-320x240.jpg"
}

GET /videos/top

Returns a list of videos created in a given time period sorted by number of views, most popular first.

Parameters

Name Required? Type Description
limit optional integer Maximum number of objects in array. Default is 10. Maximum is 100.
offset optional integer Object offset for pagination. Default is 0.
game optional string Returns only videos from game.
period optional string Returns only videos created in time period. Valid values are week, month, or all. Default is week.

Example Request

curl -H 'Accept: application/vnd.twitchtv.v2+json' \
-X GET https://api.twitch.tv/kraken/videos/top?game=League+of+Legends&period=month

Example Response

{
  "_links": {
    "next": "https://api.twitch.tv/kraken/videos/top?game=League+of+Legends&limit=10&offset=10&period=month",
    "self": "https://api.twitch.tv/kraken/videos/top?game=League+of+Legends&limit=10&offset=0&period=month"
  },
  "videos": [
    {
      "recorded_at": "2013-03-13T09:51:31Z",
      "preview": "http://static-cdn.jtvnw.net/jtv.thumbs/archive-377199700-320x240.jpg",
      "description": "dat trist jump",
      "url": "http://www.twitch.tv/chaoxlol/c/2023831",
      "title": "Almost the great escape",
      "channel": {
        "name": "chaoxlol",
        "display_name": "chaoxlol"
      },
      "length": 71,
      "game": "League of Legends",
      "views": 66436,
      "_id": "c2023831",
      "_links": {
        "channel": "https://api.twitch.tv/kraken/channels/chaoxlol",
        "self": "https://api.twitch.tv/kraken/videos/c2023831"
      }
    },
    ...
  ]
}

GET /channels/:channel/videos

Returns an list of videos ordered by time of creation, starting with the most recent from :channel.

Parameters

Name Required? Type Description
limit optional integer Maximum number of objects in array. Default is 10. Maximum is 100.
offset optional integer Object offset for pagination. Default is 0.
broadcasts optional bool Returns only broadcasts when true. Otherwise only highlights are returned. Default is false.

Example Request

curl -H 'Accept: application/vnd.twitchtv.v2+json' \
-X GET https://api.twitch.tv/kraken/channels/vanillatv/videos?limit=10

Example Response

{
  "videos": [
      {
          "title": "ETF2L Week 1: Epsilon vs. Dignitas",
          "recorded_at": "2011-10-02T19:57:06Z",
          "_id": "a296529186",
          "_links": {
              "self": "https://api.twitch.tv/kraken/videos/a296529186",
              "owner": "https://api.twitch.tv/kraken/channels/vanillatv"
          },
          "embed": "<object type="application/x-shockwave-flash" height="300" width="400" id="clip_embed_player_flash" data="http://www.justin.tv/widgets/archive_embed_player.swf" bgcolor="#000000">
              <param name="movie" value="http://www.justin.tv/widgets/archive_embed_player.swf" />
              <param name="allowScriptAccess" value="always" />
              <param name="allowNetworking" value="all" />
              <param name="allowFullScreen" value="true" />
              <param name="flashvars" value="channel=vanillatv&title=VanillaTV - Sweden vs Russia - ETF2L Nations Cup - Snakewater [Map3] - Part 3&auto_play=false&archive_id=328087483&start_volume=25" />
          </object>",
          "url": "http://www.twitch.tv/vanillatv/b/296529186",
          "views": 1,
          "preview": "http://static-cdn.jtvnw.net/jtv.thumbs/archive-296529186-320x240.jpg",
          "length": 23,
          "game": "Team Fortress 2",
          "description": null
      },
      {
          "title": "ETF2L Week 1: Epsilon vs. Dignitas",
          "recorded_at": "2011-10-02T19:01:23Z",
          "_id": "a296526250",
          "_links": {
              "self": "https://api.twitch.tv/kraken/videos/a296526250",
              "owner": "https://api.twitch.tv/kraken/channels/vanillatv"
          },
          "embed": "<object type="application/x-shockwave-flash" height="300" width="400" id="clip_embed_player_flash" data="http://www.justin.tv/widgets/archive_embed_player.swf" bgcolor="#000000">
              <param name="movie" value="http://www.justin.tv/widgets/archive_embed_player.swf" />
              <param name="allowScriptAccess" value="always" />
              <param name="allowNetworking" value="all" />
              <param name="allowFullScreen" value="true" />
              <param name="flashvars" value="channel=vanillatv&title=VanillaTV - Sweden vs Russia - ETF2L Nations Cup - Snakewater [Map3] - Part 3&auto_play=false&archive_id=328087483&start_volume=25" />
          </object>",
          "url": "http://www.twitch.tv/vanillatv/b/296526250",
          "views": 1,
          "preview": "http://static-cdn.jtvnw.net/jtv.thumbs/archive-296526250-320x240.jpg",
          "length": 1296,
          "game": "Team Fortress 2",
          "description": null
      },
      ...
  ],
  "_links": {
      "self": "https://api.twitch.tv/kraken/channels/vanillatv/videos?limit=10&offset=0",
      "next": "https://api.twitch.tv/kraken/channels/vanillatv/videos?limit=10&offset=10"
  }
}

Embedding

See here for embedding.