Skip to content

Latest commit

 

History

History
86 lines (69 loc) · 2.58 KB

teams.md

File metadata and controls

86 lines (69 loc) · 2.58 KB

Teams

Teams are an organization of channels.

Endpoint Description
GET /teams Get list of active team objects
GET /teams/:team Get team object

GET /teams/

Returns a list of active teams.

Parameters

Name Required? Type Description
limit optional integer Maximum number of objects in array. Default is 25. Maximum is 100.
offset optional integer Object offset for pagination. Default is 0.

Example Request

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

Example Response

{
  "_links": {
    "next": "https://api.twitch.tv/kraken/teams?limit=25&offset=25",
    "self": "https://api.twitch.tv/kraken/teams?limit=25&offset=0"
  },
  "teams": [
    {
      "info": "<p>Team Info</p>",
      "_links": {
        "self": "https://api.twitch.tv/kraken/teams/testteam"
      },
      "background": "http://static-cdn.jtvnw.net/jtv_user_pictures/team-testteam-background_image-c72e038f428c9c7d.png",
      "banner": "http://static-cdn.jtvnw.net/jtv_user_pictures/team-testteam-banner_image-cc318b0f084cb67c-640x125.jpeg",
      "name": "testteam",
      "_id": 1,
      "updated_at": "2012-11-14T01:30:00Z",
      "display_name": "test",
      "created_at": "2011-10-11T22:49:05Z",
      "logo": "http://static-cdn.jtvnw.net/jtv_user_pictures/team-testteam-team_logo_image-46943237490be5e7-300x300.jpeg"
    },
    ...
  ]
}

GET /teams/:team/

Returns a team object for :team.

Example Request

curl -H 'Accept: application/vnd.twitchtv.v3+json' \
-X GET https://api.twitch.tv/kraken/teams/eg

Example Response

{
  "info": "<p>Team Info</p>",
  "_links": {
    "self": "https://api.twitch.tv/kraken/teams/testteam"
  },
  "background": "http://static-cdn.jtvnw.net/jtv_user_pictures/team-testteam-background_image-c72e038f428c9c7d.png",
  "banner": "http://static-cdn.jtvnw.net/jtv_user_pictures/team-testteam-banner_image-cc318b0f084cb67c-640x125.jpeg",
  "name": "testteam",
  "_id": 1,
  "updated_at": "2012-11-14T01:30:00Z",
  "display_name": "test",
  "created_at": "2011-10-11T22:49:05Z",
  "logo": "http://static-cdn.jtvnw.net/jtv_user_pictures/team-testteam-team_logo_image-46943237490be5e7-300x300.jpeg"
}