channels

/:channel

Changed on Feb 7, 2021

Get channel details for provided channel id or channel name

get/channels/{channel}

Request

Base URL
https://api.streamelements.com/kappa/v2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://api.streamelements.com/oauth2/authorize
  Token URLhttps://api.streamelements.com/oauth2/token
- or HTTP bearer
TypeScript
https://skmtc.dev/streamelements/apis/se-api-docs/docs/channels/:channel/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channelstring required

Example:leeeeex

String|guid - Channel name or channel id

Headers

Acceptstring required

Example:application/json

Response

providerstring required

_idstring required

avatarstring required

usernamestring required

aliasstring required

displayNamestring required

providerIdstring required

isPartnerboolean required

broadcasterTypestring required

inactiveboolean required

Example response

{
  "profile": {
    "headerImage": "https://cdn.streamelements.com/static/user/profile_header_default.png",
    "title": "leeeeex's profile"
  },
  "provider": "twitch",
  "_id": "5b2e2007760aeb7729487dab",
  "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/b21a7fa5-4f3f-4402-b68f-3545dcc68b90-profile_image-300x300.jpg",
  "username": "leeeeex",
  "alias": "leeeeex",
  "displayName": "leeeeex",
  "providerId": "85827806",
  "isPartner": false,
  "broadcasterType": "",
  "inactive": false
}

Changes

Feb 7, 20218c745ed2e9e4 Revision changes
- warning
  the optional response header Access-Control-Allow-Credentials removed for the status 200
- warning
  the optional response header Access-Control-Expose-Headers removed for the status 200
- warning
  the optional response header ETag removed for the status 200
- warning
  the optional response header Server removed for the status 200
- warning
  the optional response header Strict-Transport-Security removed for the status 200
- warning
  the optional response header X-Content-Type-Options removed for the status 200
- warning
  the optional response header X-DNS-Prefetch-Control removed for the status 200
- warning
  the optional response header X-Download-Options removed for the status 200
- warning
  the optional response header X-Frame-Options removed for the status 200
- warning
  the optional response header X-Requested-From removed for the status 200
- warning
  the optional response header X-XSS-Protection removed for the status 200
- warning
  deleted the header request parameter Content-Type

Operation history