Endpoints

/achievements

get /achievements

/broadcasts

GET /broadcasts/{broadcastId}

Returns information about the requested broadcast.

URI Parameters

  • broadcastId:  UUID

    The ID of the broadcast to retrieve.

200 OK

Body

  • Media Type: application/json
  • Data Type: Broadcast

404 Not Found

Returned if the broadcast is not found.

GET /broadcasts/{broadcastId}/manifest.{type}

This endpoint is identical to /channels/{id}/manifest.{format}. See that for more information.

URI Parameters

  • broadcastId:  UUID

    The ID of the broadcast to retrieve.

  • type:  string

    The manifest format to retrieve.

get /broadcasts/current
get /broadcasts/{broadcastId}
get /broadcasts/{broadcastId}/manifest.{type}

/channels

GET /channels/{channelIdOrToken}

Gets a single channel.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelIdOrToken:  string ∪ uint

    The ID or token of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

GET /channels/{channelIdOrToken}/details

Attempts to get channel details, including private ones. Please note that this will not explicitly fail but instead omit private properties if the user does not have the appropriate permission scopes to read them.

  • The channel:streamKey permission is required for the streamKey property to be included.
  • The channel:details permission is required for the numSubscribers property to be included.

URI Parameters

  • channelIdOrToken:  string ∪ uint

    The ID or token of the channel.

200 OK

Body

  • Media Type: application/json
  • Data Type: ExpandedChannel
    • streamKey:  string

      The users stream key.

    • numSubscribers:  uint

      The current amount of subscribers the channel has.

    • maxConcurrentSubscribers:  uint

      The maximum amount of concurrent subscribers.

    • totalUniqueSubscribers:  uint

      The total amount of unique subscribers the user has had.

PUT /channels/{channelId}

This method is deprecated. Use `patch` instead.

URI Parameters

  • channelId:  uint

    The ID of the channel.

PATCH /channels/{channelId}

Updates a channel, responds with the updated channel.

Secured by OAuth 2.0 Scopes: 
channel:update:self
This endpoint is rate-limited with the channel-write bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Body

  • Media Type: application/json
  • Data Type: Channel

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: Channel

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update:self

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/viewers

This method is deprecated. Use `/channel/{id}/analytics/tsdb` instead.

Fetches the viewer count over time in a given interval, limited to the last 24 hours.

Secured by OAuth 2.0 Scopes: 
channel:analytics

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate

    End of the analytics interval.

200 OK

Body

  • Media Type: application/json
  • Data Type: Array<ViewerCount>

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/viewers

Displays viewer counts over time for a channel.

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/viewersMetrics

Displays information about individual viewers of a channel.

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/streamSessions

Displays information about when the channel started and stopped streaming, and what they steamed.

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/streamHosts

Displays when other channels hosted this channel. This endpoint should not be used for hosting alerts. Instead, check out Constellation or our web hook system.

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/subscriptions

Displays when users subscribed to this channel and subscriber number changes over time. This endpoint should not be used for subscription alerts. Instead, check out Constellation or our web hook system.

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/followers

Displays when users followed to this channel and follower number changes over time. This endpoint should not be used for follower alerts. Instead, check out Constellation or our web hook system.

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/gameRanksGlobal

Returns a list of game views, shares, and the number of streams over the time interval across the platform, grouped per game type.

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/subRevenue

Returns a summary of revenue earned from subscriptions over the time period

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/cpm

Returns payments awarded via synthetic advertisement impressions.

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: Array<CPMAnalytic>

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/analytics/tsdb/viewerSessionCount

Returns counts of unique sessions over the period.

Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /channels/{channelId}/badge

Sets the thumbnail for this channel.

Secured by OAuth 2.0 Scopes: 
channel:update
This endpoint is rate-limited with the upload bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • badge:  file

      The file to upload.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/follow

Paginated listing of the channel's followers.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=25≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

429 Too Many Requests

API rate limit exceeded.

PUT /channels/{channelId}/follow

This method is deprecated. Use `post` instead.

URI Parameters

  • channelId:  uint

    The ID of the channel.

POST /channels/{channelId}/follow

Follows the channel as a user, whose id is supplied in the request body.

Secured by OAuth 2.0 Scopes: 
channel:follow
This endpoint is rate-limited with the channel-follow bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Body

  • Media Type: application/json
  • Data Type: object
    • user:  uint

      The userid for the user you want to follow the channel with.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: Follow

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:follow

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /channels/{channelId}/follow

Un-follows the channel as a user, whose id is supplied in query parameters

Secured by OAuth 2.0 Scopes: 
channel:follow
This endpoint is rate-limited with the channel-follow bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • user:  uint

    The userid for the user you want to un-follow the channel with.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

204 No Content

Sent on a successful un-follow.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:follow

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/emoticons

Retrieves a sprite sheet and coordinates of this channel's emoticons.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • user:  uint?

    The id of the user to retrieve the emoticons for, will add user specific emotes if present.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

PATCH /channels/{channelId}/emoticons

Changes the channel's emoticons.

Secured by OAuth 2.0 Scopes: 
channel:update
This endpoint is rate-limited with the channel-write bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Body

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/hostee

Redirects to the channel that is being hosted, if this channel is actively hosting.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

302 Found

Redirect to hosting channel.

404 Not Found

The channel is not hosting.

429 Too Many Requests

API rate limit exceeded.

PUT /channels/{channelId}/hostee

Sets the hosted channel.

Secured by OAuth 2.0 Scopes: 
channel:update
This endpoint is rate-limited with the channel-write bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • (internal):  string
  • suppressNotify:  number

    Suppresses hostee notifications if set.

Body

  • Media Type: application/json
  • Data Type: object
    • id:  uint

      The id of the channel to host.

    • auto:  boolean?

      Whether this is a regular host or auto-host.

    • layout:  PlayerLayout?

      Layout to use for the hosting display.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: Channel

404 Not Found

Channel not found.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /channels/{channelId}/hostee

Stops hosting another channel.

Secured by OAuth 2.0 Scopes: 
channel:update
This endpoint is rate-limited with the channel-write bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

204 No Content

Sent on success.

404 Not Found

Channel not found.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/hostee/layout

Returns the layout used in this hosting session.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Body

404 Not Found

Given if there's no hosting session currently.

PATCH /channels/{channelId}/hostee/layout

Applies an update to the hosting session layout.

Secured by OAuth 2.0 Scopes: 
channel:update
This endpoint is rate-limited with the channel-write bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

404 Not Found

Given if there's no hosting session currently.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/hosters

Gets a list of channels hosting this channel.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

404 Not Found

Channel not found.

429 Too Many Requests

API rate limit exceeded.

GET /channels/{channelId}/manifest.light2

Gets a stream light2 manifest.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: object
    • hlsSrc:  string

      A URL for the HLS manifest for this channel.

    • ftlSrc:  string

      A URL for the FTL manifest of this channel.

    • now:  IsoDate

      The UTC timestamp that the request was made.

    • startedAt:  IsoDate

      The UTC timestamp for when the stream started.

429 Too Many Requests

API rate limit exceeded.

GET /channels/{channelId}/manifest.m3u8

Gets a stream m3u8 manifest

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • showAudioOnly:  [string (0,1,2)=0

    Optionally display audio-only transcodes. 0, the default, will hide them. 1 will include audio-only transcodes alongside video transcodes. 2 will show only audio transcodes.

  • cdn:  boolean?

    Return manifest with CDN hosts instead of our own dist nodes.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/x-mpegURL
  • Data Type: object

    A standard m3u8 manifest.

429 Too Many Requests

API rate limit exceeded.

GET /channels/{channelId}/manifest.ftl

Gets a stream FTL manifest

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: object
    • server:  string

      FTL Server address

    • resolutions:  Array<object>

      A list of transcodes available for this channel

    • iceServers:  Array<object>

      A list of ICE servers.

429 Too Many Requests

API rate limit exceeded.

GET /channels/{channelId}/preferences

Reads the channels preferences.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Body

POST /channels/{channelId}/preferences

Sets the channels preferences.

Secured by OAuth 2.0 Scopes: 
channel:update

URI Parameters

  • channelId:  uint

    The ID of the channel.

Body

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/related

Finds related channels.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • count:  [1≤integer=10≤50]

    Max item channel count.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: Array<Channel>

429 Too Many Requests

API rate limit exceeded.

DELETE /channels/{channelId}/streamKey

Resets this channel's stream key.

Secured by OAuth 2.0 Scopes: 
channel:update
Secured by OAuth 2.0 Scopes: 
channel:streamKey
This endpoint is rate-limited with the channel-write bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: object
    • streamKey:  string

      The new stream key.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:streamKey

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/relationship

Gets the relationship of the channel to a user.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • user:  uint

    The user ID to get the relationship to.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: object
    • id:  uint

      The ID of the channel.

    • status:  object

      Object containing information.

      • roles:  Array<Role>

        The Roles this user has in the channel

      • follows:  Follow?

        A follows object, given the user follows the channel.

429 Too Many Requests

API rate limit exceeded.

POST /channels/{channelId}/thumbnail

Sets the thumbnail of the channel.

Secured by OAuth 2.0 Scopes: 
channel:update
This endpoint is rate-limited with the upload bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • thumbnail:  file

      The file to upload.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/users

Gets all users with roles assigned in the channel. Including Subscribers if you have the channels:details:self permission for this user.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

GET /channels/{channelId}/users/{role}

Lists all users assigned a certain role in the channel, like "mod" or "subscriber". Case-insensitive. Retrieving subscribers requires the channel:details:self permission.

URI Parameters

  • channelId:  uint

    The ID of the channel.

  • role:  string

    The role to get.

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

PATCH /channels/{channelId}/users/{userId}

Updates a user's roles on this channel. This can be used to make a user in a channel a moderator or to ban them from the channel.

Secured by OAuth 2.0 Scopes: 
channel:update

URI Parameters

  • channelId:  uint

    The ID of the channel.

  • userId:  uint

    The ID the user to update the roles for.

Body

  • Media Type: application/json
  • Data Type: object
    • add:  Array<Role>?

      List of groups to add the user to.

    • remove:  Array<Role>?

      List of groups to remove the user from.

204 No Content

The role change request was executed successfully.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/discord

Returns Discord settings for the channel.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: DiscordBot

429 Too Many Requests

API rate limit exceeded.

PUT /channels/{channelId}/discord

Updates Discord settings on the channel.

Secured by OAuth 2.0 Scopes: 
channel:details
This endpoint is rate-limited with the channel-write bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Body

  • Media Type: application/json
  • Data Type: DiscordBot

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: DiscordBot

403 Forbidden

Sent if the user does not have permission to edit the channel.

404 Not Found

Sent if the channel owner has not linked their Discord account, or the channel is not found.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:details

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/discord/channels

Lists all voice and text channels in the Discord chat.

Secured by OAuth 2.0 Scopes: 
channel:details
This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

404 Not Found

No discord server is linked to the channel.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:details

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/discord/roles

Lists all roles available on a channel. This can be used to display a selection for channel administors when updating their Discord settings.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: Array<DiscordRole>

403 Forbidden

Sent when the user does not have access to view the channel roles.

404 Not Found

No Discord server is linked to the channel.

429 Too Many Requests

API rate limit exceeded.

GET /channels/{channelId}/discord/invite

Checks if the user can be invited to the channel's Discord server.

Secured by OAuth 2.0 Scopes: 
user:getDiscordInvite
This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • user:  uint

    User receiving the invite.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

204 No Content

The user is able to get an invite to the Discord server.

403 Forbidden

The user is not able to get an invite to the server. Returns the current invite settings of the server.

Body

  • Media Type: application/json
  • Data Type: object
    • eligibility:  string (everyone,followers,subs,noone)

404 Not Found

No Discord server is linked to the channel.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:getDiscordInvite

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /channels/{channelId}/discord/invite

Attempts to create an invite to the Discord Server.

Secured by OAuth 2.0 Scopes: 
user:getDiscordInvite
This endpoint is rate-limited with the channel-write bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • user:  uint

    User receiving the invite.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: object
    • redirectUri:  string

      Example: 

      https://discord.gg/1234567asdf

403 Forbidden

The user is not able to get an invite to the server. Returns the current invite settings of the server.

Body

  • Media Type: application/json
  • Data Type: object
    • eligibility:  string (everyone,followers,subs,noone)

404 Not Found

No Discord server is linked to the channel.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:getDiscordInvite

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/recordings

Returns a list of video recordings owned by the channel.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: Array<Recording>

404 Not Found

Sent if the channel is not found.

429 Too Many Requests

API rate limit exceeded.

POST /channels/{channelId}/transcodes/unlock

Unlocks transcodes for the channel. Requires the channel to owned by the currently authed user, and this will also require and remove 2500 sparks from the user.

Secured by OAuth 2.0 Scopes: 
channel:update

URI Parameters

  • channelId:  uint

    The ID of the channel.

204 No Content

400 Bad Request

Not enough sparks to spend.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/confetti

Returns the confetti the user has created for their channel.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Body

  • Media Type: application/json
  • Data Type: Confetti

404 Not Found

Returned if they have not created custom confetti.

GET /channels/{channelId}/banner

Returns the banner image the user has selected for their channel.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Body

  • Media Type: application/json
  • Data Type: string

POST /channels/{channelId}/banner

Adds a banner url to the channel.

Secured by OAuth 2.0 Scopes: 
channel:update
This endpoint is rate-limited with the upload bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: string

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /channels/{channelId}/banner

Deletes channel banner.

Secured by OAuth 2.0 Scopes: 
channel:update
This endpoint is rate-limited with the upload bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

204 No Content

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /channels/{channelId}/broadcast

Returns the latest or ongoing broadcast from the channel.

URI Parameters

  • channelId:  uint

    The ID of the channel.

200 OK

Body

  • Media Type: application/json
  • Data Type: Broadcast

404 Not Found

Returned if the channel is not online.

get /channels
get /channels/{channelIdOrToken}
get /channels/{channelIdOrToken}/details
put /channels/{channelId}
patch /channels/{channelId}
get /channels/{channelId}/analytics/viewers
get /channels/{channelId}/analytics/tsdb/viewers
get /channels/{channelId}/analytics/tsdb/viewersMetrics
get /channels/{channelId}/analytics/tsdb/streamSessions
get /channels/{channelId}/analytics/tsdb/streamHosts
get /channels/{channelId}/analytics/tsdb/subscriptions
get /channels/{channelId}/analytics/tsdb/followers
get /channels/{channelId}/analytics/tsdb/gameRanksGlobal
get /channels/{channelId}/analytics/tsdb/subRevenue
get /channels/{channelId}/analytics/tsdb/cpm
get /channels/{channelId}/analytics/tsdb/viewerSessionCount
post /channels/{channelId}/badge
get /channels/{channelId}/follow
put /channels/{channelId}/follow
post /channels/{channelId}/follow
delete /channels/{channelId}/follow
get /channels/{channelId}/emoticons
patch /channels/{channelId}/emoticons
get /channels/{channelId}/hostee
put /channels/{channelId}/hostee
delete /channels/{channelId}/hostee
get /channels/{channelId}/hostee/layout
patch /channels/{channelId}/hostee/layout
get /channels/{channelId}/hosters
get /channels/{channelId}/manifest.light2
get /channels/{channelId}/manifest.m3u8
get /channels/{channelId}/manifest.ftl
get /channels/{channelId}/preferences
post /channels/{channelId}/preferences
get /channels/{channelId}/related
delete /channels/{channelId}/streamKey
get /channels/{channelId}/relationship
post /channels/{channelId}/thumbnail
get /channels/{channelId}/users
get /channels/{channelId}/users/{role}
patch /channels/{channelId}/users/{userId}
get /channels/{channelId}/discord
put /channels/{channelId}/discord
get /channels/{channelId}/discord/channels
get /channels/{channelId}/discord/roles
get /channels/{channelId}/discord/invite
post /channels/{channelId}/discord/invite
get /channels/{channelId}/recordings
post /channels/{channelId}/transcodes/unlock
get /channels/{channelId}/confetti
get /channels/{channelId}/banner
post /channels/{channelId}/banner
delete /channels/{channelId}/banner
get /channels/{channelId}/broadcast

/chats

GET /chats/{channelId}

Prepares the user to join a chat channel. It returns the channel's chatroom settings, available chat servers, and an authentication key that the user (if authenticated) should use to authenticate with the chat servers over websockets.

If you wish to connect to chat as an authenticated user, you must have the chat:connect permission.

This endpoint is rate-limited with the chats bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel you wish to chat in.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: object
    • endpoints:  Array<string>

      List of chat server websocket urls.

    • authkey:  string

      The auth key required to join a channel's chatroom.

    • roles:  Array<Role>

      List of roles he user will have once joined.

    • permissions:  Array<string>

      List of permissions the user will have once joined.

    • isLoadShed:  boolean

      Whether the channel is in load shedding mode.

429 Too Many Requests

API rate limit exceeded.

GET /chats/{channelId}/joinIfNotBigEvent

During big events, chat enters a special mode and frontend clients connect lazily. This endpoint will either return a 409 Conflict code if the channel is a big event, or return the same response code as /chats/{id}.

Generally, using /chats/{id} for building client integrations is sufficient.

This endpoint is rate-limited with the chats bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel you wish to chat in.

200 OK

See /chats/{id} for an example of a response.

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

409 Conflict

Returned if the channel is in big event mode.

429 Too Many Requests

API rate limit exceeded.

GET /chats/{channelId}/anonymous

See /chats/{channelId}, effectively the same but for anonymous users.

This endpoint is rate-limited with the chats bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel you wish to chat in.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: object
    • endpoints:  Array<string>

      List of chat server websocket urls.

    • isLoadShed:  boolean

      Whether the channel is in load shedding mode.

429 Too Many Requests

API rate limit exceeded.

GET /chats/{channelId}/friends

Gets a list of friends for a user currently active in this channel's chatroom.

Secured by OAuth 2.0 Scopes: 
user:details
This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • channelId:  uint

    The ID of the channel you wish to chat in.

Query Parameters

  • user:  uint

    The user to find the friends for.

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: Array<User>

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:details

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /chats/{channelId}/users

Returns a paginated list of users who are currently in this channel's chatroom.

Users who have opted into "lurk mode" will not be returned. (Only Mixer staff members with the chat:view_lurkers scope can view users in lurk mode.)

URI Parameters

  • channelId:  uint

    The ID of the channel you wish to chat in.

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

  • Media Type: application/json
  • Data Type: Array<ChatUser>

GET /chats/{channelId}/users/{userId}

Retrieves a single chat user by user ID.

URI Parameters

  • channelId:  uint

    The ID of the channel you wish to chat in.

  • userId:  uint

    The unique ID of the user.

200 OK

Body

  • Media Type: application/json
  • Data Type: ChatUser

GET /chats/{channelId}/users/search

Search for a user in a channel's chatroom.

URI Parameters

  • channelId:  uint

    The ID of the channel you wish to chat in.

Query Parameters

  • username:  string

    Name fragment to search users by.

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

  • Media Type: application/json
  • Data Type: Array<ChatUser>

GET /chats/{channelId}/history

Returns the most recent chat messages for the channel

URI Parameters

  • channelId:  uint

    The ID of the channel you wish to chat in.

Query Parameters

  • enhanced:  boolean

    Enabling enhanced history will make the history return moderation events in their respective event wrappers.

200 OK

Body

  • Media Type: application/json
  • Data Type: object

    A list of chat message objects. See our chat documentation for more information on what this looks like!

get /chats/{channelId}
get /chats/{channelId}/joinIfNotBigEvent
get /chats/{channelId}/anonymous
get /chats/{channelId}/friends
get /chats/{channelId}/users
get /chats/{channelId}/users/{userId}
get /chats/{channelId}/users/search
get /chats/{channelId}/history

/clips

GET /clips/broadcasts/{broadcastId}/canClip

Checks if a clip can be created on a given broadcast.

Secured by OAuth 2.0 Scopes: 
channel:clip:create

URI Parameters

  • broadcastId:  string

    ID of the broadcast

200 OK

The clip can be created.

400 Bad Request

The request is invalid for the reason indicated in the response body.

Body

  • Media Type: application/json
  • Data Type: ClipError

403 Forbidden

The user does not have permission to create clip.

404 Not Found

The broadcast is not found.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:clip:create

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /clips/create

Creates a clip.

Secured by OAuth 2.0 Scopes: 
channel:clip:create

Body

200 OK

Body

400 Bad Request

The request is invalid for the reason indicated in the response body.

Body

  • Media Type: application/json
  • Data Type: ClipError

403 Forbidden

The user does not have permission to create clip.

404 Not Found

The broadcast is not found.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:clip:create

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /clips/{shareableId}

Deletes a clip.

Secured by OAuth 2.0 Scopes: 
channel:clip:delete

URI Parameters

  • shareableId:  string

    ID of the clip

202 Accepted

The delete clip request is accepted.

400 Bad Request

The request is invalid for the reason indicated in the response body.

Body

  • Media Type: application/json
  • Data Type: ClipError

403 Forbidden

The user does not have permission to delete the clip.

404 Not Found

The clip is not found.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:clip:delete

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /clips/{shareableId}

Gets a clip.

URI Parameters

  • shareableId:  string

    ID of the clip

200 OK

Body

400 Bad Request

The request is invalid for the reason indicated in the response body.

Body

  • Media Type: application/json
  • Data Type: ClipError

404 Not Found

The clip is not found.

POST /clips/{shareableId}/metadata

Changes the title of the clip.

Secured by OAuth 2.0 Scopes: 
channel:clip:delete

URI Parameters

  • shareableId:  string

    ID of the clip

Body

202 Accepted

The change clip metadata request is accepted.

400 Bad Request

The request is invalid for the reason indicated in the response body.

Body

  • Media Type: application/json
  • Data Type: ClipError

403 Forbidden

The user does not have permission to change clip metadata.

404 Not Found

The clip is not found.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:clip:delete

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /clips/channels/{channelId}

Returns all clips for the channel.

URI Parameters

  • channelId:  number

    ID of the channel

200 OK

Body

400 Bad Request

The request is invalid for the reason indicated in the response body.

Body

  • Media Type: application/json
  • Data Type: ClipError
get /clips/broadcasts/{broadcastId}/canClip
post /clips/create
delete /clips/{shareableId}
get /clips/{shareableId}
post /clips/{shareableId}/metadata
get /clips/channels/{channelId}

/confetti

GET /confetti/{confettiId}

Returns confetti specified by the ID.

URI Parameters

  • confettiId:  uint

    The ID of the confetti record.

200 OK

Body

  • Media Type: application/json
  • Data Type: Confetti

PATCH /confetti/{confettiId}

Update confetti for a channel.

Secured by OAuth 2.0 Scopes: 
channel:update

URI Parameters

  • confettiId:  uint

    The ID of the confetti record.

Body

  • Media Type: application/json
  • Data Type: Confetti

200 OK

Body

  • Media Type: application/json
  • Data Type: Confetti

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /confetti/{confettiId}

Deletes custom channel confetti, reverting to the default effect.

Secured by OAuth 2.0 Scopes: 
channel:update

URI Parameters

  • confettiId:  uint

    The ID of the confetti record.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

put /confetti
get /confetti/{confettiId}
patch /confetti/{confettiId}
delete /confetti/{confettiId}

/costreams

GET /costreams/{costreamId}

Displays information about the costream and its members.

URI Parameters

  • costreamId:  UUID

    The ID of the costream.

200 OK

Body

  • Media Type: application/json
  • Data Type: Costream

PATCH /costreams/{costreamId}

Updates costream data. Only usable by the host of the costream.

URI Parameters

  • costreamId:  UUID

    The ID of the costream.

Body

  • Media Type: application/json
  • Data Type: Costream

200 OK

Body

  • Media Type: application/json
  • Data Type: Costream

DELETE /costreams/{costreamId}/channels/{channelId}

Removes the channel from the costream. The costream host may also use this endpoint.

Secured by OAuth 2.0 Scopes: 
channel:costream

URI Parameters

  • costreamId:  UUID

    The ID of the costream.

  • channelId:  uint

    The channel Id we're removing from the costream

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:costream

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /costreams/invite

Invites one channel to costream with another.

Secured by OAuth 2.0 Scopes: 
channel:costream

Body

  • Media Type: application/json
  • Data Type: object
    • validFor:  uint

      Length of time the invite should be valid for, in milliseconds.

    • layout:  PlayerLayout?

      Default costream layout to use when this invite is accepted.

    • inviteeIds:  Array<uint>?

      The user IDs to be invited to the costream.

    • inviteeXUIDs:  Array<uint>?

      The XUIDs to be invited to the costream.

    • inviterId:  uint?

      The user ID doing the inviting. Defaults to the requesting user.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:costream

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

get /costreams/{costreamId}
patch /costreams/{costreamId}
delete /costreams/{costreamId}/channels/{channelId}
post /costreams/invite
get /costreams/current
delete /costreams/current

/delve

get /delve/home
get /delve/mixPlayFilters
get /delve/onlyOnMixer

/frontendVersions

get /frontendVersions

/hooks

POST /hooks

Creates a webhook.

Secured by OAuth Secret

Requires that you have an OAuth client with a secret token, and calls against this endpoint will be made in the context of your application, rather than a particular user. OAuth clients without secret tokens will not be able to call endpoints secured using this scheme.

Body

  • Media Type: application/json
  • Data Type: object
    • events:  Array<string>

      A list of liveloading events to subscribe to.

    • kind:  string

      Must be set to "web".

    • url:  string

      A fully-qualified URL to call when this event happens.

    • secret:  string?

      An optional secret string that will be used to sign webhook requets. You can use this to verify that the webhooks you get are legitimate.

OAuth Secret Authentication

Requires that you have an OAuth client with a secret token, and calls against this endpoint will be made in the context of your application, rather than a particular user. OAuth clients without secret tokens will not be able to call endpoints secured using this scheme.

Headers

  • Client-ID:  string

    Your OAuth application's client ID.

    Example: 

    da400f1a81d7efc477920b5d686e95be6f92c88af09c2342

    • pattern: 
      [0-9a-f]{48}
  • Authorization:  string

    Contains your OAuth application's secret token in the form "Secret mylongtokenhere"

    Example: 

    Secret c51ff3c4e44e7be32be2f639b28e3569f1775f8530b95a5d972ace2cb9310ab8

    • pattern: 
      ^Secret [0-9a-f]{64}$

GET /hooks/{hookId}

Returns details about the webhook by ID.

URI Parameters

  • hookId:  UUID

    The ID of the webhook.

200 OK

Body

  • Media Type: application/json
  • Data Type: Webhook

404 Not Found

Given if the webhook is not found.

POST /hooks/{hookId}/deactivate

Deactivates a webhook. The webhook will be updated and, after a few days, will be deleted.

Secured by OAuth Secret

Requires that you have an OAuth client with a secret token, and calls against this endpoint will be made in the context of your application, rather than a particular user. OAuth clients without secret tokens will not be able to call endpoints secured using this scheme.

URI Parameters

  • hookId:  UUID

    The ID of the webhook.

200 OK

Body

  • Media Type: application/json
  • Data Type: Webhook

OAuth Secret Authentication

Requires that you have an OAuth client with a secret token, and calls against this endpoint will be made in the context of your application, rather than a particular user. OAuth clients without secret tokens will not be able to call endpoints secured using this scheme.

Headers

  • Client-ID:  string

    Your OAuth application's client ID.

    Example: 

    da400f1a81d7efc477920b5d686e95be6f92c88af09c2342

    • pattern: 
      [0-9a-f]{48}
  • Authorization:  string

    Contains your OAuth application's secret token in the form "Secret mylongtokenhere"

    Example: 

    Secret c51ff3c4e44e7be32be2f639b28e3569f1775f8530b95a5d972ace2cb9310ab8

    • pattern: 
      ^Secret [0-9a-f]{64}$

POST /hooks/{hookId}/renew

Renews a webhook, increasing its expiry date.

Secured by OAuth Secret

Requires that you have an OAuth client with a secret token, and calls against this endpoint will be made in the context of your application, rather than a particular user. OAuth clients without secret tokens will not be able to call endpoints secured using this scheme.

URI Parameters

  • hookId:  UUID

    The ID of the webhook.

200 OK

Body

  • Media Type: application/json
  • Data Type: Webhook

OAuth Secret Authentication

Requires that you have an OAuth client with a secret token, and calls against this endpoint will be made in the context of your application, rather than a particular user. OAuth clients without secret tokens will not be able to call endpoints secured using this scheme.

Headers

  • Client-ID:  string

    Your OAuth application's client ID.

    Example: 

    da400f1a81d7efc477920b5d686e95be6f92c88af09c2342

    • pattern: 
      [0-9a-f]{48}
  • Authorization:  string

    Contains your OAuth application's secret token in the form "Secret mylongtokenhere"

    Example: 

    Secret c51ff3c4e44e7be32be2f639b28e3569f1775f8530b95a5d972ace2cb9310ab8

    • pattern: 
      ^Secret [0-9a-f]{64}$
get /hooks
post /hooks
get /hooks/{hookId}
post /hooks/{hookId}/deactivate
post /hooks/{hookId}/renew

/ingests

get /ingests
get /ingests/best

/interactive

GET /interactive/{channel}

Initiates the connection to a MixPlay Project. This should only be called by an actual browser.

URI Parameters

  • channel:  uint

    The unique ID of the channel.

200 OK

Body

400 Bad Request

Body

  • Media Type: text/html
  • Data Type: string

    Either "Channel is not interactive." or "Interactive version is unsupported", the latter being when the channel has an interactive v1 game running.

POST /interactive/games

Creates a new MixPlay Project.

Secured by OAuth 2.0 Scopes: 
interactive:manage

Body

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /interactive/games/{projectId}

Retrieves a single MixPlay projects's info.

URI Parameters

  • projectId:  uint

    The unique ID of the MixPlay Project.

200 OK

Body

PUT /interactive/games/{projectId}

Updates a MixPlay Project.

Secured by OAuth 2.0 Scopes: 
interactive:manage

URI Parameters

  • projectId:  uint

    The unique ID of the MixPlay Project.

Body

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /interactive/games/{projectId}

Deletes a MixPlay Project.

Secured by OAuth 2.0 Scopes: 
interactive:manage

URI Parameters

  • projectId:  uint

    The unique ID of the MixPlay Project.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /interactive/games/{projectId}/versions

Lists a MixPlay Project's versions.

URI Parameters

  • projectId:  uint

    The unique ID of the MixPlay Project.

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

POST /interactive/games/{projectId}/cover

Sets the cover image for the MixPlay project.

Secured by OAuth 2.0 Scopes: 
interactive:manage
This endpoint is rate-limited with the upload bucket.

URI Parameters

  • projectId:  uint

    The unique ID of the MixPlay Project.

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • cover:  file

      The file to upload.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /interactive/games/{projectId}/editors

Adds the InteractiveEditor group to the user for the MixPlay Project.

Secured by OAuth 2.0 Scopes: 
interactive:manage

URI Parameters

  • projectId:  uint

    The unique ID of the MixPlay Project.

Body

  • Media Type: application/json
  • Data Type: object
    • user:  uint

      The unique ID of the user to make an editor.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /interactive/games/{projectId}/editors

Lists users that have the InteractiveEditor group for the MixPlay Project.

Secured by OAuth 2.0 Scopes: 
interactive:manage

URI Parameters

  • projectId:  uint

    The unique ID of the MixPlay Project.

200 OK

Body

  • Media Type: application/json
  • Data Type: Array<User>

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /interactive/games/{projectId}/editors/{user}

Removes the InteractiveEditor group for the MixPlay Project.

Secured by OAuth 2.0 Scopes: 
interactive:manage

URI Parameters

  • projectId:  uint

    The unique ID of the MixPlay Project.

  • user:  uint

    The unique ID of the user.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /interactive/versions

Creates a new MixPlay Project version.

Secured by OAuth 2.0 Scopes: 
interactive:manage

Body

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /interactive/versions/{versionId}

Retrieves a version's info.

URI Parameters

  • versionId:  uint

    The unique ID of the MixPlay project version.

200 OK

Body

PUT /interactive/versions/{versionId}

Updates a MixPlay Project version.

Secured by OAuth 2.0 Scopes: 
interactive:manage

URI Parameters

  • versionId:  uint

    The unique ID of the MixPlay project version.

Body

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /interactive/versions/{versionId}

Deletes a MixPlay Project version.

Secured by OAuth 2.0 Scopes: 
interactive:manage

URI Parameters

  • versionId:  uint

    The unique ID of the MixPlay project version.

204 No Content

Sent when the MixPlay Project Version is successfully deleted.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /interactive/versions/{versionId}/analytics/performance

Returns time-series information about the Interactive project over the given period.

Secured by OAuth 2.0 Scopes: 
interactive:manage
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • versionId:  uint

    The unique ID of the MixPlay project version.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /interactive/versions/{versionId}/analytics/viewersMetrics

Returns time-series information about the Interactive project over the given period.

Secured by OAuth 2.0 Scopes: 
interactive:manage
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • versionId:  uint

    The unique ID of the MixPlay project version.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

interactive:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

get /interactive/{channel}
get /interactive/hosts
get /interactive/hosts/vnext
get /interactive/games
post /interactive/games
get /interactive/games/{projectId}
put /interactive/games/{projectId}
delete /interactive/games/{projectId}
get /interactive/games/{projectId}/versions
post /interactive/games/{projectId}/cover
post /interactive/games/{projectId}/editors
get /interactive/games/{projectId}/editors
delete /interactive/games/{projectId}/editors/{user}
get /interactive/games/owned
get /interactive/games/shared
get /interactive/games/editor
post /interactive/versions
get /interactive/versions/{versionId}
put /interactive/versions/{versionId}
delete /interactive/versions/{versionId}
get /interactive/versions/{versionId}/analytics/performance
get /interactive/versions/{versionId}/analytics/viewersMetrics

/invoices

GET /invoices/{invoice}

Gets a single invoice.

Secured by OAuth 2.0 Scopes: 
invoice:view

URI Parameters

  • invoice:  uint

    The invoice id.

200 OK

Body

  • Media Type: application/json
  • Data Type: Invoice

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

invoice:view

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /invoices/{invoice}/capture

Captures the payment processor?

URI Parameters

  • invoice:  uint

    The invoice id.

Body

  • Media Type: application/json
  • Data Type: object
    • nonce:  string

      The security nonce.

    • gateway:  string

      The name of the payment gateway.

200 OK

Body

  • Media Type: application/json
  • Data Type: object
    • status:  string

      Always "success"

get /invoices/{invoice}
post /invoices/{invoice}/capture

/jwt

POST /jwt/authorize

Generates a JWT Grant to be used in requests. These tokens can be used in requests. A useful benefit of using a JWT Grant is that no CSRF token is needed for requests. JWT Grants are generally only valid for a few hours at a time and should thus not be stored on disk as authorization method, instead each time you start making requests you should hit this enpoint to get a new JWT. (NOT on every request) Since JWT's are not encrypted, but signed you can inspect the remaining time the token is valid by checking the exp field of the JWT data.

204 No Content

Provides grant when authenticated and not returning in body.

Headers

  • X-JWT:  string

    JWT Grant that can be used in the Authorization for requests.

401 Unauthorized

When not authenticated this will return an error.

Body

  • Media Type: application/json
  • Data Type: object
    • statusCode:  uint

      The error code (401).

    • error:  string

      A one word error reason (Unauthorized)

    • message:  string

      A human readable error description.

post /jwt/authorize

/notifications

GET /notifications/{notificationId}

Displays information about the invite, if any.

URI Parameters

  • notificationId:  uint

    The ID of the notification.

200 OK

Body

404 Not Found

Sent if the notification was not found.

POST /notifications/{notificationId}/shareSub

Shares a sub anniversary notification, sending a chat message in the channel that the anniversary is with. Such a notification may only be shared once and must be shared within five days of when it was sent.

Secured by OAuth 2.0 Scopes: 
user:notification:self

URI Parameters

  • notificationId:  uint

    The ID of the notification.

204 No Content

400 Bad Request

Sent if the notification is the wrong type, if it was already sent, or if the notification is too old to share.

404 Not Found

Sent if the notification was not found.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:notification:self

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /notifications/{notificationId}/shareSub

Ignores a sub anniversary notification, marking it as sent without sending any chat message or liveloading event.

Secured by OAuth 2.0 Scopes: 
user:notification:self

URI Parameters

  • notificationId:  uint

    The ID of the notification.

204 No Content

400 Bad Request

Sent if the notification is the wrong type, if it was already sent, or if the notification is too old to share.

404 Not Found

Sent if the notification was not found.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:notification:self

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /notifications/{notificationId}/costream/{state}

Accepts or denies a costream invite.

Secured by OAuth 2.0 Scopes: 
user:notification:self

URI Parameters

  • notificationId:  uint

    The ID of the notification.

  • state:  string

    Should be one of "accepted" or "denied".

204 No Content

400 Bad Request

Sent if the notification is the wrong type, if it was already sent, or if the notification was already accepted or denied.

404 Not Found

Sent if the notification was not found.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:notification:self

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /notifications/emailUnsubscribe

Deletes email transport settings (for non-transactional email) corresponding to a user ID/unsubscription code combination.

Body

  • Media Type: application/json
  • Data Type: object
    • code:  string

      Unsubscription code in the format userId-randomCharacters

204 No Content

400 Bad Request

Sent on an invalid unsubscription code.

get /notifications/{notificationId}
post /notifications/{notificationId}/shareSub
delete /notifications/{notificationId}/shareSub
post /notifications/{notificationId}/costream/{state}
post /notifications/emailUnsubscribe

/oauth

DELETE /oauth/authorized/{client}

Revokes access rights for this client.

Secured by OAuth 2.0 Scopes: 
oauth:manage

URI Parameters

  • client:  uint

    The OAuth client id.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

oauth:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /oauth/clients

Creates a new client.

Secured by OAuth 2.0 Scopes: 
oauth:manage

Body

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

oauth:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /oauth/clients/{client}

Retrieves a client.

URI Parameters

  • client:  uint

    The OAuth client id.

200 OK

Body

PUT /oauth/clients/{client}

Updates a client.

Secured by OAuth 2.0 Scopes: 
oauth:manage

URI Parameters

  • client:  uint

    The OAuth client id.

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • logo:  file

      The file to upload.

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

oauth:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /oauth/clients/{client}

Deletes a client.

Secured by OAuth 2.0 Scopes: 
oauth:manage

URI Parameters

  • client:  uint

    The OAuth client id.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

oauth:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /oauth/clients/{client}/logo

Sets the OAuth client logo.

Secured by OAuth 2.0 Scopes: 
oauth:manage

URI Parameters

  • client:  uint

    The OAuth client id.

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • logo:  file

      The file to upload.

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

oauth:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /oauth/token

Retrieves an OAuth token. For more information see our OAuth Page!

Body

  • Media Type: application/json
  • Data Type: object
    • grant_type:  string (refresh_token,authorization_code)
    • refresh_token:  string?

      Only required when grant_type is refresh_token

    • client_id:  string

      The OAuth client id.

    • client_secret:  string?

      The OAuth client secret, only required if the OAuth client in use has one.

    • code:  string?

      The authorization code received from the /authorize endpoint. Not required for token refreshing.

    • redirect_uri:  string?

      The OAuth redirect uri. Must be identical to the one used with the /authorize endpoint. Not required for token refreshing.

200 OK

Body

  • Media Type: application/json
  • Data Type: object
    • access_token:  string

      The access token.

    • token_type:  string

      Always "Bearer".

    • expires_in:  uint

      The lifetime in seconds of the access token.

    • refresh_token:  string

      The refresh token, valid for one year.

POST /oauth/token/introspect

Implements token introspection, listing the token scopes and various other information about the grant.

Body

  • Media Type: application/json
  • Data Type: object
    • token:  string

      The access or refresh token to look up.

200 OK

Body

  • Media Type: application/json
  • Data Type: object
    • active:  boolean

      True if the token is valid and usable, false otherwise. When false, no other values will be returned.

    • scope:  string

      Space-delimited list of scopes the token is granted.

    • client_id:  string

      The client ID associated with the token.

    • username:  string

      Username of the user to whom this token is granted.

    • token_type:  string

      The type of the token, "access_token" or "refresh_token"

    • exp:  number

      Second timestamp when the token expired.

    • sub:  number

      User ID of the user to whom this token belongs.

POST /oauth/shortcode

Initializes the "shortcode" auth flow. The endpoint takes a client_id, client_secret, and scope similarly to the initial authorization request. It returns a short, six-digit code to be displayed to the user to link their account in addition to a longer "handle" that can be used for polling its status in POST /oauth/code/{handle}.

Body

  • Media Type: application/json
  • Data Type: object
    • client_id:  string

      The OAuth client ID.

    • client_secret:  string?

      The OAuth client secret, only required if the OAuth client in use has one.

    • scope:  string

      List of permissions separated by whitespace.

200 OK

Body

  • Media Type: application/json
  • Data Type: object
    • code:  string

      The short six-digit code to be displayed to the user.

    • handle:  string

      A longer, random string to use while checking the code's status in POST /oauth/code

    • expires_in:  uint

      The amount of time until the code expires, in seconds.

GET /oauth/shortcode/check/{handle}

Checks the status of a previously issued code and, after it's been activated, returns an OAuth authorization code to be passed to GET /oauth/token to exchange it for an access and refresh token. Once again, the client ID and secret (if any) are required.

URI Parameters

  • handle:  string

    The code handle as returned in POST /oauth/code

200 OK

Sent once after authorization succeeds

Body

  • Media Type: application/json
  • Data Type: object
    • code:  string

      The OAuth code to exchange for access and refresh tokens.

204 No Content

Send if the code is still valid but the user hasn't granted it yet.

403 Forbidden

Sent if the user denied the user denied the requested permission.

404 Not Found

Sent if the code handle is not found or expired, or if the client_id mismatches that of a discovered token.

POST /oauth/twitter/check

Same as get

POST /oauth/twitter/link

Links an OAuth account to the user's current account.

POST /oauth/twitter/login

Attempts to login using the provider oauth. Like normal login, except that it returns a 404 if the provider account is not yet linked to any Mixer account.

200 OK

POST /oauth/twitter/register

Attempts to register using the provider's oauth. It takes a post request body like the normal register endpoint, but fills in all properties by default.

POST /oauth/discord/check

Same as get

POST /oauth/discord/link

Links an OAuth account to the user's current account.

POST /oauth/discord/login

Attempts to login using the provider oauth. Like normal login, except that it returns a 404 if the provider account is not yet linked to any Mixer account.

200 OK

POST /oauth/discord/register

Attempts to register using the provider's oauth. It takes a post request body like the normal register endpoint, but fills in all properties by default.

delete /oauth/authorized/{client}
post /oauth/clients
get /oauth/clients/{client}
put /oauth/clients/{client}
delete /oauth/clients/{client}
post /oauth/clients/{client}/logo
post /oauth/token
post /oauth/token/introspect
post /oauth/shortcode
get /oauth/shortcode/check/{handle}
get /oauth/twitter/check
post /oauth/twitter/check
post /oauth/twitter/link
delete /oauth/twitter/link
post /oauth/twitter/login
get /oauth/twitter/profile
post /oauth/twitter/register
get /oauth/discord/check
post /oauth/discord/check
post /oauth/discord/link
delete /oauth/discord/link
post /oauth/discord/login
get /oauth/discord/profile
post /oauth/discord/register

/recordings

GET /recordings/{recording}

Returns details about a single channel recording. This will increment the number of views the recording has.

URI Parameters

  • recording:  uint

    The ID of the recording.

Query Parameters

  • user:  number?

    The current user. If provided recordings will include the seen boolean.

200 OK

Body

  • Media Type: application/json
  • Data Type: Recording

404 Not Found

Sent when the Recording is not found.

PATCH /recordings/{recording}

Allows updating Recording information.

Secured by OAuth 2.0 Scopes: 
recording:manage

URI Parameters

  • recording:  uint

    The ID of the recording.

Body

  • Media Type: application/json
  • Data Type: Recording

200 OK

Body

  • Media Type: application/json
  • Data Type: Recording

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

recording:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /recordings/{recording}

Schedules a channel recording for deletion.

Secured by OAuth 2.0 Scopes: 
recording:manage

URI Parameters

  • recording:  uint

    The ID of the recording.

204 No Content

Sent when the recording is successfully deleted.

403 Forbidden

Sent if the user does not have permission to delete the recording.

404 Not Found

Sent if the recording is not found.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

recording:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /recordings/{recording}/seen

Marks the current user has having viewed the VOD, if they haven't already.

URI Parameters

  • recording:  uint

    The ID of the recording.

Body

  • Media Type: application/json
  • Data Type: object
    • user:  number

      User ID who viewed the video.

    • duration:  number

      The length of time the user viewed for, in seconds.

204 No Content

Send on success.

403 Forbidden

Sent if the user does not have permission to mark the recording as viewed.

404 Not Found

Sent if the recording is not found.

PATCH /recordings/{recording}/chat

Changes the chat log of the recording. Currently not functioning.

Secured by OAuth 2.0 Scopes: 
recording:manage

URI Parameters

  • recording:  uint

    The ID of the recording.

Body

  • Media Type: application/json
  • Data Type: object
    • splice:  Array<string>

      Provides a list of line numbers to delete from the log.

      • Item type: string

204 No Content

404 Not Found

Sent if the recording is not found.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

recording:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

get /recordings
get /recordings/{recording}
patch /recordings/{recording}
delete /recordings/{recording}
post /recordings/{recording}/seen
patch /recordings/{recording}/chat

/redeemables

POST /redeemables

Creates a new redeemable.

Secured by OAuth 2.0 Scopes: 
redeemable:create

Body

  • Media Type: application/json
  • Data Type: object
    • type:  string

      The type of the redeemable to create.

200 OK

Body

  • Media Type: application/json
  • Data Type: Invoice

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

redeemable:create

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /redeemables/{redeemable}

Retrieves a single redeemable.

Secured by OAuth 2.0 Scopes: 
redeemable:view

URI Parameters

  • redeemable:  uint

    The unique ID of the redeemable.

200 OK

Body

  • Media Type: application/json
  • Data Type: Redeemable

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

redeemable:view

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /redeemables/redeem

Redeems are redeemable by code.

Secured by OAuth 2.0 Scopes: 
redeemable:redeem

Body

  • Media Type: application/json
  • Data Type: object
    • code:  string

      Reedemable code.

    • channel:  number?

      When redeeming a Subscription code, the channel you want to subscribe to.

200 OK

Body

  • Media Type: application/json
  • Data Type: Invoice

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

redeemable:redeem

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

post /redeemables
get /redeemables/{redeemable}
post /redeemables/redeem

/resources

GET /resources/{resource}

Retrieves a resource.

Secured by OAuth 2.0 Scopes: 
resource:find

URI Parameters

  • resource:  uint

    The unique ID of the resource.

200 OK

Body

  • Media Type: application/json
  • Data Type: Resource

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

resource:find

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /resources/{resource}

Deletes a resource.

Secured by OAuth 2.0 Scopes: 
resource:find

URI Parameters

  • resource:  uint

    The unique ID of the resource.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

resource:find

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

get /resources/{resource}
delete /resources/{resource}

/seen

GET /seen/{bucket}/{thing}

Checks if the user has seen something.

Secured by OAuth 2.0 Scopes: 
user:seen

URI Parameters

  • bucket:  string

    The bucket name.

  • thing:  string

    What has been seen.

Query Parameters

  • user:  uint

    User id.

200 OK

Body

  • Media Type: application/json
  • Data Type: object
    • seen:  boolean

      Indicates whether thing was seen or not.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:seen

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

PUT /seen/{bucket}/{thing}

Marks something as seen by the user.

Secured by OAuth 2.0 Scopes: 
user:seen

URI Parameters

  • bucket:  string

    The bucket name.

  • thing:  string

    What has been seen.

Body

  • Media Type: application/json
  • Data Type: object
    • user:  uint

      Id of the user.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:seen

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

get /seen/{bucket}/{thing}
put /seen/{bucket}/{thing}

/shares

GET /shares/{type}

Retrieves a list of shares.

URI Parameters

  • type:  string (interactiveGameDraft)

    If interactiveGameDraft: requires the "interactive:manage" permission.

Query Parameters

  • relid:  uint?

    Filter for share subject.

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

POST /shares/{type}

Creates a new share.

URI Parameters

  • type:  string (interactiveGameDraft)

    If interactiveGameDraft: requires the "interactive:manage" permission.

Body

  • Media Type: application/json
  • Data Type: object
    • relid:  uint

      The share subject id.

    • code:  boolean?

      Generate access code.

    • user:  uint?

      User ID to share with.

200 OK

Body

DELETE /shares/{type}

Deletes a share.

URI Parameters

  • type:  string (interactiveGameDraft)

    If interactiveGameDraft: requires the "interactive:manage" permission.

Body

  • Media Type: application/json
  • Data Type: object
    • relid:  uint

      The share subject id.

204 No Content

Sent on successful deletion

DELETE /shares/{type}/{share}

Deletes a share with a specific type and id.

URI Parameters

  • type:  string (interactiveGameDraft)

    If interactiveGameDraft: requires the "interactive:manage" permission.

  • share:  uint

    The share id.

Body

  • Media Type: application/json
  • Data Type: object
    • relid:  uint

      The share subject id.

204 No Content

Sent on successful deletion

get /shares/{type}
post /shares/{type}
delete /shares/{type}
delete /shares/{type}/{share}

/subscriptions

POST /subscriptions

Creates a new subscription.

Secured by OAuth 2.0 Scopes: 
subscription:create

Body

  • Media Type: application/json
  • Data Type: object
    • user:  uint

      The ID of the user.

    • group:  Role

      The group name.

    • terms:  [1≤uint=1]

      The amount of terms this subscription should run for.

    • channel:  uint?

      The channel id, only if the subscription is for a channel.

200 OK

Body

  • Media Type: application/json
  • Data Type: Invoice

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

subscription:create

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /subscriptions/{subscription}

Retrieves a subscription.

Secured by OAuth 2.0 Scopes: 
subscription:view

URI Parameters

  • subscription:  uint

    The unique ID of the subscription.

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

subscription:view

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

PATCH /subscriptions/{subscription}

Renews a subscription.

Secured by OAuth 2.0 Scopes: 
subscription:renew

URI Parameters

  • subscription:  uint

    The unique ID of the subscription.

Body

  • Media Type: application/json
  • Data Type: object
    • terms:  [1≤uint=1]

      The amount of terms this subscription be renewed run for.

200 OK

Body

  • Media Type: application/json
  • Data Type: Invoice

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

subscription:renew

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /subscriptions/{subscription}

Cancels a subscription.

Secured by OAuth 2.0 Scopes: 
subscription:cancel

URI Parameters

  • subscription:  uint

    The unique ID of the subscription.

Body

  • Media Type: application/json
  • Data Type: object
    • immediate:  boolean?

      Make the subscription expire immediately.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

subscription:cancel

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

post /subscriptions
get /subscriptions/{subscription}
patch /subscriptions/{subscription}
delete /subscriptions/{subscription}

/suggestions

get /suggestions/channels

/teams

POST /teams

Creates a new team, requires the authenticated user to own 5000 sparks.

Secured by OAuth 2.0 Scopes: 
team:manage

Body

  • Media Type: application/json
  • Data Type: object
    • token:  string

      The internal name.

    • name:  string

      The display name.

    • description:  string

      The description.

200 OK

Body

  • Media Type: application/json
  • Data Type: Team

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /teams/{teamIdOrToken}

Retrieves a single team or by token.

URI Parameters

  • teamIdOrToken:  string ∪ uint

    The channel token or ID.

200 OK

Body

  • Media Type: application/json
  • Data Type: Team

PUT /teams/{team}

Updates the team information.

Secured by OAuth 2.0 Scopes: 
team:administer

URI Parameters

Body

  • Media Type: application/json
  • Data Type: Team

200 OK

Body

  • Media Type: application/json
  • Data Type: Team

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:administer

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /teams/{team}

Deletes a team.

Secured by OAuth 2.0 Scopes: 
team:administer

URI Parameters

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:administer

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /teams/{team}/background

Sets a new background for the group.

Secured by OAuth 2.0 Scopes: 
team:administer

URI Parameters

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • image:  file

      The file to upload.

200 OK

Body

  • Media Type: application/json
  • Data Type: Team

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:administer

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

POST /teams/{team}/logo

Sets a new logo for the group.

Secured by OAuth 2.0 Scopes: 
team:administer

URI Parameters

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • image:  file

      The file to upload.

200 OK

Body

  • Media Type: application/json
  • Data Type: Team

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:administer

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

PUT /teams/{team}/owner

Transfers ownership of the group.

Secured by OAuth 2.0 Scopes: 
team:administer

URI Parameters

Body

  • Media Type: application/json
  • Data Type: object
    • userId:  uint

      The ID of the new owner.

200 OK

Body

  • Media Type: application/json
  • Data Type: Team

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:administer

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /teams/{team}/users

Lists members of the team. Additionally lists invited members if the currently authenticated user is the group admin. Also list the currently authed user when invited.

URI Parameters

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

POST /teams/{team}/users

Invites a user to the team.

Secured by OAuth 2.0 Scopes: 
team:administer

URI Parameters

Body

  • Media Type: application/json
  • Data Type: object
    • userId:  uint

      The ID of the user to invite.

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:administer

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /teams/{team}/users/{user}

Removes a user from the team. A member can always remove themselves. Only the owner of the team can remove other members. The owner cannot be removed from the team.

Secured by OAuth 2.0 Scopes: 
team:manage

URI Parameters

  • team:  uint
  • user:  uint

    The ID of the user.

204 No Content

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

PUT /teams/{team}/users/{user}

Accepts a team invitation.

Secured by OAuth 2.0 Scopes: 
team:manage

URI Parameters

  • team:  uint
  • user:  uint

    The ID of the user.

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

get /teams
post /teams
get /teams/{teamIdOrToken}
put /teams/{team}
delete /teams/{team}
post /teams/{team}/background
post /teams/{team}/logo
put /teams/{team}/owner
get /teams/{team}/users
post /teams/{team}/users
delete /teams/{team}/users/{user}
put /teams/{team}/users/{user}

/testStreams

GET /testStreams/{channelId}

Returns the test stream settings for the channel.

Secured by OAuth 2.0 Scopes: 
channel:update

URI Parameters

  • channelId:  uint

    The channel ID to edit test streams form.

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

PUT /testStreams/{channelId}

Updates the channel's test stream settings.

Secured by OAuth 2.0 Scopes: 
channel:update

URI Parameters

  • channelId:  uint

    The channel ID to edit test streams form.

Body

200 OK

Body

400 Bad Request

Returns if input is invalid.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

get /testStreams/{channelId}
put /testStreams/{channelId}

/transcodes

get /transcodes

/types

GET /types/{type}

Gets the information for a particular type.

URI Parameters

  • type:  uint

    The unique ID of the type.

200 OK

Body

PUT /types/{type}

Updates the type's information. Requires the Publisher role.

Secured by OAuth 2.0 Scopes: 
gameType:edit

URI Parameters

  • type:  uint

    The unique ID of the type.

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

gameType:edit

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

PUT /types/{type}/thumbnail

Updates the thumbnail for this game type. Should be a square, 200x200 image.

Secured by OAuth 2.0 Scopes: 
gameType:edit

URI Parameters

  • type:  uint

    The unique ID of the type.

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • thumbnail:  file

      The file to upload.

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

gameType:edit

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

PUT /types/{type}/background

Updates the background image for the game. Should be a 1920x1080 image.

Secured by OAuth 2.0 Scopes: 
gameType:edit

URI Parameters

  • type:  uint

    The unique ID of the type.

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • background:  file

      The file to upload.

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

gameType:edit

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /types/{type}/channels

Finds channels by online their type.

URI Parameters

  • type:  uint

    The unique ID of the type.

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • q:  string

    The search string to be used.

  • scope:  string (all,names)

    Specifies what properties to search in, note that all and names combined.

200 OK

Body

  • Media Type: application/json
  • Data Type: Array<GameType>

GET /types/{type}/analytics/viewersMetrics

Displays information about individual viewers of a channel.

Secured by OAuth 2.0 Scopes: 
gameType:analytics
Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • type:  uint

    The unique ID of the type.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

gameType:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /types/{type}/analytics/rank

Returns a list of the count of streams, views, and shares for this game over time.

Secured by OAuth 2.0 Scopes: 
gameType:analytics
Secured by OAuth 2.0 Scopes: 
channel:analytics
This endpoint is rate-limited with the analytics bucket.

URI Parameters

  • type:  uint

    The unique ID of the type.

Query Parameters

  • from:  IsoDate

    Start of the analytics interval.

  • to:  IsoDate?

    End of the analytics interval. If not provided, defaults to the current date.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

gameType:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

channel:analytics

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

get /types
get /types/lookup
get /types/published
get /types/{type}
put /types/{type}
put /types/{type}/thumbnail
put /types/{type}/background
get /types/{type}/channels
get /types/{type}/analytics/viewersMetrics
get /types/{type}/analytics/rank

/users

GET /users/{user}

Gets public user info.

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

PUT /users/{user}

This method is deprecated. Use `patch` instead.

URI Parameters

  • user:  uint

    The ID of the user

PATCH /users/{user}

Updates a user, only writeable properties can be used.

Secured by OAuth 2.0 Scopes: 
user:update
This endpoint is rate-limited with the user-write bucket.

URI Parameters

  • user:  uint

    The ID of the user

Body

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/achievements

Gets the achievement earnings of a user.

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

GET /users/{user}/avatar

Gets the user's avatar.

URI Parameters

  • user:  uint

    The ID of the user

Query Parameters

  • w:  uint?

    The width of the image, can be scaled optionally.

  • h:  uint?

    The height of the image, optional if w is specified.

302 Found

Redirect to the location of the user's avatar.

POST /users/{user}/avatar

Changes the users avatar.

Secured by OAuth 2.0 Scopes: 
user:update
This endpoint is rate-limited with the upload bucket.

URI Parameters

  • user:  uint

    The ID of the user

Body

  • Media Type: multipart/form-data
  • Data Type: object
    • avatar:  file

      The file to upload.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: User

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

DELETE /users/{user}/avatar

Deletes the user's avatar.

Secured by OAuth 2.0 Scopes: 
user:update

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

  • Media Type: application/json
  • Data Type: User

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/follows

Paginates list of the channels the channel user is following.

This endpoint is rate-limited with the channel-read bucket.

URI Parameters

  • user:  uint

    The ID of the user

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=25≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

429 Too Many Requests

API rate limit exceeded.

PATCH /users/{user}/frontendVersion

Updates a user's frontend version.

Secured by OAuth 2.0 Scopes: 
user:update
This endpoint is rate-limited with the user-write bucket.

URI Parameters

  • user:  uint

    The ID of the user

Body

  • Media Type: application/json
  • Data Type: string

    The requested frontend version.

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: object
    • version:  string

      The frontend version's name.

    • hash:  string

      The frontend version's hash.

429 Too Many Requests

API rate limit exceeded.

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/invoices

Gets invoices for the user.

Secured by OAuth 2.0 Scopes: 
invoice:view

URI Parameters

  • user:  uint

    The ID of the user

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

  • Media Type: application/json
  • Data Type: Array<Invoice>

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

invoice:view

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/links

Attempts to retrieve the associated OAuth provider link. The provider may be something like "twitter" or "discord".

Secured by OAuth 2.0 Scopes: 
user:details

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

  • Media Type: application/json
  • Data Type: Array<OAuthLink>

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:details

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/notifications

Returns a list of notifications for the user.

Secured by OAuth 2.0 Scopes: 
user:notification

URI Parameters

  • user:  uint

    The ID of the user

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

  • Media Type: application/json
  • Data Type: Array<Notification>

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:notification

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/notifications/preferences

Displays the user's notification preferences.

Secured by OAuth 2.0 Scopes: 
user:notification

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:notification

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

PATCH /users/{user}/notifications/preferences

Updates the user's notification preferences.

Secured by OAuth 2.0 Scopes: 
user:notification

URI Parameters

  • user:  uint

    The ID of the user

Body

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:notification

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/oauth/authorized

Lists authorized oauth applications.

Secured by OAuth 2.0 Scopes: 
oauth:manage

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

oauth:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/oauth/clients

Lists all OAuth clients created by the user.

Secured by OAuth 2.0 Scopes: 
oauth:manage

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

  • Media Type: application/json
  • Data Type: Array<OAuthClient>

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

oauth:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/preferences

Gets the user's preferences.

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

POST /users/{user}/preferences

Sets the user's preferences.

Secured by OAuth 2.0 Scopes: 
user:update

URI Parameters

  • user:  uint

    The ID of the user

Body

200 OK

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

user:update

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/recurringPayments

Lists all recurring payments, paginated.

Secured by OAuth 2.0 Scopes: 
subscription:view

URI Parameters

  • user:  uint

    The ID of the user

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

subscription:view

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/redeemables

Lists redeemables for this user.

URI Parameters

  • user:  uint

    The ID of the user

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

GET /users/{user}/resources

List of all resources the user owns or has access to.

Secured by OAuth 2.0 Scopes: 
resource:find

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

  • Media Type: application/json
  • Data Type: Array<Resource>

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

resource:find

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/sessions

Retrieves a list of all active sessions of that user.

This endpoint is rate-limited with the user-read bucket.

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Headers

  • x-rate-limit:  uint

    How many requests you can make before hitting the limit.

  • x-ratelimit-remaining:  uint

    How many requests until you meet the limit.

  • x-ratelimit-reset:  UnixTimestampMillis

    When this rate limit bucket expires.

Body

  • Media Type: application/json
  • Data Type: Array<Session>

429 Too Many Requests

API rate limit exceeded.

GET /users/{user}/subscriptions

Retrieves a list of subscriptions for this user.

Secured by OAuth 2.0 Scopes: 
subscription:view

URI Parameters

  • user:  uint

    The ID of the user

Query Parameters

  • order:  string?

    Allows specifying an ordering over one or more columns.

    Example: 

    someColumn:ASC,anotherColumn:DESC

  • page:  uint?

    The index of the page.

  • limit:  [1≤integer=50≤100]

    Amount of items per page.

  • where:  string?

    Allows specifying a where clause with 3 operations:

    • eq: The value is equal to.
    • ne: The value is not equal.
    • Deprecated: neq: The value is not equal. Use ne instead.
    • in: The value is in the list of semicolon seperated values.
    • notIn: The value is not in the list of semicolon separated values.
    • between: The value is between two semicolon separated numeric values.
    • notBetween: The value is not between two semicolon separated numeric values.
    • gt: The value is greater than.
    • gte: The value is greater than or equal to.
    • lt: The value is smaller than.
    • lte: The value is smaller than or equal to.

    Note: Previously we used . to delimit columns, operations, and values. This usage is now deprecated, we recommend using colons : instead, as shown in the example.

    Example: 

    someColumn:eq:myValue,someOtherColumn:ne:myOtherValue,foo:in:a;b;c,bar:between:1;10

  • fields:  string?

    Allows specifying a projection. Additionally, you can exclude certain properties by prefixing them with a -.

    Example: 

    someColumn,anotherColumn,aThirdColumn

  • noCount:  boolean?

    If specified, the x-total-count header will be omitted. Please use this if you do not require the total count.

200 OK

Headers

  • link:  string

    RFC5988 links, which contains links to first, next, prev and last page.

    Example: 

    <some/path?page=0>; rel="first",<some/path?page=1>; rel="next",<some/path?page=0>; rel="prev",<some/path?page=4>; rel="last"

  • x-total-count:  uint

    Describes the total amount of items.

Body

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

subscription:view

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/teams

Retrieves an expanded list of teams the user belongs to.

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

GET /users/{user}/teams/limit

Returns the maximum amount of teams a given user can be in.

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

  • Media Type: application/json
  • Data Type: uint

PUT /users/{user}/teams/primary

Sets the user's primary team.

Secured by OAuth 2.0 Scopes: 
team:manage

URI Parameters

  • user:  uint

    The ID of the user

Body

  • Media Type: application/json
  • Data Type: object
    • teamId:  uint

      The team ID of the new primary.

200 OK

Body

  • Media Type: application/json
  • Data Type: User

OAuth 2.0 Authentication

Scopes

Requires the following OAuth Scopes:

team:manage

Headers

  • Authorization:  string

    Used to send a valid OAuth 2 access token. Prefixed by "Bearer". Do not use with the "access_token" query string parameter. Alternatively can be used to send an xbl authorization header.

    Example: 

    `Bearer ttlpmeOT5QuNbdN2c2IvHz8KY0VAwhrorc1o8BshdyxUGSoYLU1dpz8B5MaP28lR` or `XBL3.0 x=userHash;xtoken`

401 Unauthorized

Bad or expired token. This can happen if the user or Mixer revoked or expired an access token. To fix, you should re- authenticate the user.

403 Forbidden

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. Can also indicate a missing permission for the action attempted.

GET /users/{user}/details

Gets a user including all private details like email, etc.

URI Parameters

  • user:  uint

    The ID of the user

200 OK

Body

GET /users/{user}/recentlyViewedChannels

Retrieve user's recently viewed channels.

URI Parameters

  • user:  uint

    The ID of the user

Query Parameters

  • page:  uint

    Page number for pagination.

  • limit:  uint

    Number of channels to retrieve.

200 OK

Body

  • Media Type: application/json
  • Data Type: object
    • channels:  Array<ChannelAdvanced>

      Recently viewed channels.

    • page:  uint

      Page number for next round retrieve.

get /users/current
get /users/current/frontendVersion
get /users/search
get /users/{user}
put /users/{user}
patch /users/{user}
get /users/{user}/achievements
get /users/{user}/avatar
post /users/{user}/avatar
delete /users/{user}/avatar
get /users/{user}/follows
patch /users/{user}/frontendVersion
get /users/{user}/invoices
get /users/{user}/links
get /users/{user}/notifications
get /users/{user}/notifications/preferences
patch /users/{user}/notifications/preferences
get /users/{user}/oauth/authorized
get /users/{user}/oauth/clients
get /users/{user}/preferences
post /users/{user}/preferences
get /users/{user}/recurringPayments
get /users/{user}/redeemables
get /users/{user}/resources
get /users/{user}/sessions
get /users/{user}/subscriptions
get /users/{user}/teams
get /users/{user}/teams/limit
put /users/{user}/teams/primary
get /users/{user}/details
get /users/{user}/recentlyViewedChannels

Models & Types

Achievement

Achievements are earnt by users and have various requirements.

  • slug:  string

    Unique string identifier for the achievement.

    • maxLength: 100
  • name:  string

    Human readable name for the achievement.

  • description:  string

    The description of the achievement, usually describes requirements for earning it.

  • sparks:  uint

    The number of sparks awarded to a user when this achievement is earnt.

AchievementEarning extends TimeStamped

An AchievementEarning represents a user's progress towards an achievement.

  • id:  uint

    The unique ID of the earning.

  • earned:  boolean

    Indicates whether the achievement was earned.

  • progress:  number≤1

    Unit interval indicating the progress.

  • achievement:  string

    The name of the achievement.

  • user:  uint

    The ID of the user this earning belongs to.

  • Achievement:  Achievement

    Contains the details of the earnt achievement.

Announcement

Announcements are triggered by Mixer staff and inform users of important information and news on Mixer.

  • message:  string

    Message to display in the toast / desktop notification.

  • timeout:  number?

    How long the message should appear for, defaults to 10 seconds.

  • sound:  string (whoosh,chimes,click,dudup,harp,heads-up,here-you-go,hi,incoming,ping,ring,urgent,powers)?

    Any sound that should be played with the announcement, like "whoosh", defaults to null.

  • level:  string (error,warning,info,success)?

    Level of the toast to display, defaults to success.

  • confetti:  number ∪ boolean

    ID of confetti to display, or true to use the default.

Broadcast

A broadcast represents a single broadcast from a Channel.

  • id:  UUID

    Unique ID for this broadcast.

  • channelId:  uint

    ID of the Channel this broadcast belongs to.

  • online:  boolean

    True if this broadcast is online and in progress.

  • isTestStream:  boolean

    True if this broadcast is running in test stream mode.

  • startedAt:  IsoDate

    The date that this broadcast started at.

CPMAnalytic extends ChannelAnalytic

A metric showing the impressions and payout for a period.

  • impressions:  uint

    The number of unique ad impressions.

  • payout:  number

    The amount of money awarded from the impressions, in cents.

Channel extends TimeStamped

A single channel within Mixer. Each channel is owned by a user, and a channel can be broadcasted to.

  • id:  uint

    The unique ID of the channel.

  • userId:  uint

    The ID of the user owning the channel.

  • token:  string

    The name and url of the channel.

  • online:  boolean

    Indicates if the channel is streaming.

  • featured:  boolean

    True if featureLevel is > 0.

  • featureLevel:  -1≤integer

    The featured level for this channel. Its value controls the position and order of channels in the featured carousel.

  • partnered:  boolean

    Indicates if the channel is partnered.

  • transcodingProfileId:  uint?

    The id of the transcoding profile.

  • suspended:  boolean

    Indicates if the channel is suspended.

  • name:  string

    The title of the channel.

  • audience:  string (family,teen,18+)

    The target audience of the channel.

  • viewersTotal:  uint

    Amount of unique viewers that ever viewed this channel.

  • viewersCurrent:  uint

    Amount of current viewers.

  • numFollowers:  uint

    Amount of followers.

  • description:  string

    The description of the channel, can contain HTML.

  • typeId:  uint?

    The ID of the game type.

  • interactive:  boolean

    Indicates if that channel is interactive.

  • interactiveGameId:  uint?

    The ID of the interactive game used.

  • ftl:  uint

    The ftl stream id.

  • hasVod:  boolean

    Indicates if the channel has vod saved.

  • languageId:  string?

    ISO 639 language id.

  • coverId:  uint?

    The ID of the cover resource.

  • thumbnailId:  uint?

    The resource ID of the thumbnail.

  • badgeId:  uint

    The resource ID of the subscriber badge.

  • bannerUrl:  string

    The URL of the the banner image.

  • hosteeId:  uint

    The ID of the hostee channel.

  • hasTranscodes:  boolean

    Indicates if the channel has transcodes enabled.

  • vodsEnabled:  boolean

    Indicates if the channel has vod recording enabled.

  • costreamId:  UUID?

    The costream that the channel is in, if any.

ChannelAdvanced extends Channel

Augmented regular channel with additional data.

  • type:  GameType?

    A nested type showing information about this channel's currently selected type.

  • user:  UserWithGroups

    This channel's owner

ChannelAnalytic

A base analytics type for channel based analytical metrics.

  • channel:  uint

    The channel.

  • time:  IsoDate

    Timestamp for when this metric was recorded.

ChannelFeatures

A list of channel features.

ChannelPreferences

Channel preferences are a list of options and attributes which control behaviour for the channel. Please see each property for more details.

  • sharetext:  string?

    The text used when sharing the stream. The template parameter %URL% will be replaced with the channel's URL. The template parameter %USER% will be replaced with the channel's name.

  • channel:links:allowed:  boolean?

    Specifies whether links are allowed in the chat.

  • channel:links:clickable:  boolean?

    Specifies whether links are clickable in the chat.

  • channel:slowchat:  number?

    Interval required between each chat message.

  • channel:notify:directPurchaseMessage:  string?

    The message to be sent when a user completes a direct purchase on the channel. The template parameter %USER% will be replaced with the name of the user who completed direct purchase. The template parameter %CHANNEL% will be replaced with the name of the channel. The template parameter %GAMETITLE% will be replaced with the name of the game purchased.

  • channel:notify:subscribemessage:  string?

    The message to be sent when a user subscribes to the channel. The template parameter %USER% will be replaced with the subscriber's name.

  • channel:notify:subscribe:  boolean?

    Indicates whether a notification should be shown upon subscription.

  • channel:notify:followmessage:  string?

    The message to be sent when a user follows the channel. The template parameter "%USER%" will be replaced with the follower's name.

  • channel:notify:follow:  boolean?

    Indicates whether a notification should be shown upon follow.

  • channel:notify:hostedBy:  string?

    The message to be sent when a user hosts the channel. The template parameter "%USER%" will be replaced with the hoster's name.

  • channel:notify:autoHostedBy:  string?

    The message to be sent when a user auto-hosts the channel. The template parameter "%USER%" will be replaced with the hoster's name.

  • channel:notify:hosting:  string?

    The message to be sent when the channel hosts another. The template parameter "%USER%" will be replaced with the hostee's name.

  • channel:partner:submail:  string?

    The text to be added to the subscription email.

  • channel:player:muteOwn:  boolean?

    Indicates whether to mute when the streamer opens his own stream.

  • channel:tweet:enabled:  boolean?

    Indicates whether the tweet button should be shown.

  • channel:tweet:body:  string?

    The message to be used when a user tweets about the channel. The template parameter %URL% will be replaced with the share url.

  • hypezone:allow:  boolean

    Indicates if the channel allows HypeZone to host it.

  • hosting:allow:  boolean

    Indicates if the channel allows other channels to host it.

  • costream:allow:  boolean

    Allows other streamers to join you in a costream.

  • channel:offline:autoplayVod:  boolean?

    When a user visits the channel while the channel is offline, the most recent VOD will be automatically played if this preference is enabled.

ChannelSuggestions

Suggested channels with their beacon URLs

  • channels:  Array<Channel>

    Suggested channels for the user.

  • impressionUrl:  string

    URL to call when the suggested content is shown to the user

  • actionsUrl:  string

    URL to call when the user performs any action on the suggested content

ChatEventRequest

Data required to create a Chat event.

  • type:  string

    Type of event

  • data:  object

    Event data JSON object

ChatUser

Represents a user within chat for a channel and provides details about their status within the channel.

  • userId:  uint

    The user ID that this chat user belongs to.

  • userName:  string

    The username.

  • userRoles:  Array<Role>

    The roles the user has in this chat.

  • user:  object

    A partial User model.

    • experience:  uint

      The user's experience points.

    • level:  uint

      The user's current level on Mixer, as determined by the number of experience points the user has.

CheckoutItem

One item within an user's Order.

  • id:  uint

    The ID of the item to be purchased.

  • quantity:  uint

    The amount of items to be purchased.

ClipError

Error information for an unsuccesful clip request

  • errorCode:  uint

    An error code corresponding to the reason for request failure

  • errorMessage:  string

    A message explaining the reason for request failure

ClipMetadata

Metadata about a clip which can be updated

  • title:  string

    The title of the clip

ClipProperties

Information about a clip.

  • contentId:  UUID

    The content ID of this clip.

  • contentLocators:  Array<Locator>

    Locator information for this highlight (including the thumbnail and content)

  • durationInSeconds:  uint

    Duration of this highlight in seconds

  • expirationDate:  IsoDate

    Date, in string format, this content will be deleted

  • title:  string

    Title of the highlight (default is the title of the live broadcast the highlight was created from)

  • ownerChannelId:  uint

    Channel ID of the owner of this highlight

  • typeId:  uint

    Mixer title id of source material (as opposed to xbox title id)

  • shareableId:  string

    ID to get the clip and share with users

  • streamerChannelId:  uint

    Channel ID of the streamer this highlight was clipped from

  • uploadDate:  IsoDate

    Date time, in string format, at which this highlight completed upload

  • viewCount:  uint

    Number of views associated with this highlight

  • contentMaturity:  uint

    Maturity of the clip (Family = 1, Teen = 2, EighteenPlus = 3)

  • tags:  Array<string>

    Tag for clips

ClipRequest

Information required to create a clip.

  • broadcastId:  string

    Unique id for the broadcast being clipped

  • highlightTitle:  string?

    Title of the clip being created (default is the broadcast title)

  • finalStreamTimeMs:  number?

    The stream time at the end of the clip being created (default is the latest stream time)

  • clipDurationInSeconds:  number?

    Length of the clip to create (default 30s, min 15s, max 300s)

Confetti

Represents a confetti cannon configuration. Each channel can have is own customized confetti. The confetti cannon is triggered on subscription or direct purchase events on a channel.

  • id:  uint

    The Confetti's ID.

  • channelId:  uint?

    The owner of the Confetti; this channel can edit it.

  • settings:  object

    The settings configure the confetti. Most options are customizable math expressions parsed with expr-eval.

    • count:  string

      Expression to be evaluated to determine the number of generated confetti particles. The window height and width will be passed into the expression. The number of confetti particles will be capped based on the device profile, however. For example: "count": "35 * width / 100".

    • particles:  Array<object>

      Array of particle configurations.

      • Item properties:
        • probability:  number

          Weighted probability that a generated confetti particle will be this particle. Weighting is done based on the sum all probabilities.

        • velocity:  string

          Expression to be evaluated to determine the vertical velocity, in pixels per millisecond, of the particle. It's called with the window width and height. For example: "velocity": "height / 1000 / 4".

        • zdepth:  string

          Expression to be evaluated to determine the "depth" of the particle, which will be used to scale its size and velocity to achieve a pseudo-3d effect. It's called with the window width and height. For example: "zdepth": "1 + random(3)".

        • wiggleMagnitude:  string

          Expression to determine the magnitude of the wave, in pixels, that each particle follows on its horizontal axis as it floats down. It's called with the window width and height. For example: "wiggleMagnitude": "15 + random(10)".

        • wigglePeriod:  string

          Expression to determine the period of the wave, in milliseconds, that each particle follows on its horizontal axis as it floats down. It's called with the window width and height. For example: "wigglePeriod": "1000 + random(500)".

        • lifetime:  string

          Expression to determine how long each particle lives for, in milliseconds, before being destroyed. It's called with the window width and height. For example: "lifetime": "1200 + random(2000)".

        • fader:  string

          Expression called continuously to determine the opacity. It's called a lifetime values, which starts at zero and goes to one as the time passes, and should return an opacity value in the range from zero to one. For example: "fader": "1 - lifetime^3".

        • draw:  ConfettiCircle ∪ ConfettiRectangle ∪ ConfettiImage

          Describes the confetti graphic to be drawn.

ConfettiCircle

A definition for a circle within a Confetti configuration.

  • shape:  string

    Must be set to circle.

  • size:  string

    Expression to determine the diameter of the confetti circle in pixels. For example: "size": "4 + random(2)"

  • flipPeriod:  string

    Expression to determine the length of time the circle takes to do a vertical, pseudo-3d spin around the x axis. For example: "flipPeriod": "500 + random(1000)"

  • colors:  Array<object>

    A color configuration for this item.

    • Item properties:
      • probability:  number

        Weighted probability that a generated confetti particle will be this color. Weighting is done based on the sum all probabilities.

      • r:  string

        Expression used to generate the red color component, should return a value between 0 and 255 inclusive.

      • g:  string

        Expression used to generate the red color component, should return a value between 0 and 255 inclusive.

      • b:  string

        Expression used to generate the red color component, should return a value between 0 and 255 inclusive.

ConfettiImage

A definition for an image within a Confetti configuration.

  • shape:  string

    Must be set to image.

  • scale:  string

    Expression to determine the scale of the image. For example: "scale": "0.5 + random(1)"

  • spinPeriod:  string

    Expression to determine the length of time the images takes to do a full spin around the z axis. For example: "spinPeriod": "1000 + random(1000)"

  • data:  string

    Base-64 encoded image data. This will usually be a long string that starts with data:image/png;base64,. Make sure to minify the image before inserting it here to prevent exceeding size limits.

ConfettiRectangle

A definition for a rectangle within a Confetti configuration.

  • shape:  string

    Must be set to rectangle.

  • width:  string

    Expression to determine the width of the confetti circle in pixels. For example: "size": "8 + random(2)"

  • height:  string

    Expression to determine the height of the confetti circle in pixels. For example: "size": "4 + random(1)"

  • flipPeriod:  string

    Expression to determine the length of time the circle takes to do a vertical, pseudo-3d spin around the x axis. For example: "flipPeriod": "500 + random(1000)"

  • colors:  Array<object>

    A color configuration for this item.

    • Item properties:
      • probability:  number

        Weighted probability that a generated confetti particle will be this color. Weighting is done based on the sum all probabilities.

      • r:  string

        Expression used to generate the red color component, should return a value between 0 and 255 inclusive.

      • g:  string

        Expression used to generate the red color component, should return a value between 0 and 255 inclusive.

      • b:  string

        Expression used to generate the red color component, should return a value between 0 and 255 inclusive.

Costream

A co-stream is a set of channels grouped together and displayed on Mixer together.

  • channels:  Array<object>

    The members of the costream. The first member in this array is the "host" and has some special permissions regarding kicking other members and changing layout.

    • Item properties:
      • id:  uint

        The unique ID of the channel.

      • userId:  uint

        The ID of the user owning the channel.

      • token:  string

        The name and url of the channel.

  • startedAt:  IsoDate

    The time the costream started.

  • capacity:  uint

    The total number of people who may join this costream.

  • layout:  PlayerLayout

    The layout of a costream, configurable by the host or inviter.

DelveBackground

Dictates what background to display on the homepage.

  • fullWidthSrc:  string

    URL for the background to display full-width, used on mobile and on screens narrower than the max content width.

  • leftSrc:  string?

    Optional left-flanking background for use on screens larger than the max content width.

  • rightSrc:  string?

    Optional right-flanking background for use on screens larger than the max content width.

DelveCarousel

A large carousel for display on the homepage.

  • type:  string (carousel)

    Set to carousel.

  • channels:  Array<object>

    List of partial Channel objects for display.

    • Item properties:
      • id:  uint

        The unique ID of the channel.

      • name:  string?

        The title of the channel.

      • viewersCurrent:  uint

        Amount of current viewers.

      • token:  string

        The name and url of the channel.

      • userId:  uint

        The ID of the user owning the channel.

      • type:  GameType?

        The game/type the channel is playing.

DelveChannels

A list of channel on Mixer.

  • type:  string (channels)

    Set to channels.

  • title:  object

    A map of locales like en-us to the respective translation for the title of the channel row. Not all localizations may be returned in every case, clients MUST gracefully fall back if the ideal locale is unavailable.

  • morePath:  string

    The URL the frontend can navigate to in order to see more for this content. Different client implementations may treat or parse this differently. Clients MAY fall back to a more generic interface if they are unable to parse a specific URL, or the display is unavailable.

  • style:  string?

    The style variant for this row of channels.

  • hydration:  object?

    Returned only if the hydrate is given in the request.

    • apiPath:  string

      The API path the client can iterate upon to retrieve more contents like this.

    • continuation:  string?

      The continuation token, if any. If not return, the API is assumed to page using the standard zero-indexed page parameter.

    • results:  Array<object>

      List of partial GameType objects for display.

      • Item properties:
        • id:  uint

          The unique ID of the channel.

        • name:  string?

          The title of the channel.

        • interactive:  boolean

          Whether the channel is currently interactive.

        • online:  boolean

          Indicates if the channel is streaming.

        • viewersCurrent:  uint

          Amount of current viewers.

        • token:  string

          The name and url of the channel.

        • userId:  uint

          The ID of the user owning the channel.

        • type:  GameType?

          The game/type the channel is playing.

DelveError

Returned when we tried to get some contents for this row, but encountered an error doing so.

  • type:  string (error)

    Set to error.

  • originalType:  string

    The type of row that we originally tried to display here.

DelveGames

A list of games streamed on Mixer.

  • type:  string (games)

    Set to games.

  • title:  object

    A map of locales like en-us to the respective translation for the title of the game row. Not all localizations may be returned in every case, clients MUST gracefully fall back if the ideal locale is unavailable.

  • morePath:  string

    The URL the frontend can navigate to in order to see more for this content. Different client implementations may treat or parse this differently. Clients MAY fall back to a more generic interface if they are unable to parse a specific URL, or the display is unavailable.

  • hydration:  object?

    Returned only if the hydrate is given in the request.

    • apiPath:  string

      The API path the client can iterate upon to retrieve more contents like this.

    • continuation:  string?

      The continuation token, if any. If not return, the API is assumed to page using the standard zero-indexed page parameter.

    • results:  Array<object>

      List of partial GameType objects for display.

      • Item properties:
        • id:  uint

          The unique ID of the game type.

        • name:  string

          The title of the channel.

        • viewersCurrent:  uint

          Amount of current viewers.

        • coverUrl:  string?

          The URL for the game type thumbnail, if available.

DelveMixPlayFilters

Dictates the MixPlay games which are filterable on the browse page.

  • name:  object

    A map of locales like en-us to the respective translation for the title of the game row. Not all localizations may be returned in every case, clients MUST gracefully fall back if the ideal locale is unavailable.

  • description:  object

    A map of locales like en-us to the respective translation for the title of the game row. Not all localizations may be returned in every case, clients MUST gracefully fall back if the ideal locale is unavailable.

  • integrationIds:  Array<uint>

    The IDs to filter for.

DelveOnlyOnMixer

Returned when we tried to get some contents for this row, but encountered an error doing so.

  • id:  number

    Channel ID for the content.

  • type:  string

    Defines the archetype of this channel.

  • typeId:  number?

    Certain originals, like HypeZones, are bound to a specific game type.

  • channel:  object?

    Returned only if the hydrate is given in the request. Contains the truncated channel information as seen in DelveChannels.

DiscordBot

Lists the configuration for this Discord bot.

  • id:  uint

    The unique ID of the Discord bot.

  • channelId:  uint

    The channel ID linked to this Discord integration.

  • guildId:  string

    The server ID that this bot belongs to.

  • inviteSetting:  string (EVERYONE,FOLLOWERS,SUBS,NOONE)

    Determines which users can get invites to the Discord channel. It can be set to "everyone", "followers", "subs", or "noone" to disable invites. Defaults to "noone".

  • inviteChannel:  string

    The ID of the server channel that new users are invited to.

  • liveUpdateState:  boolean

    Whether the user state should be changed to "Playing GAME on Mixer" when the user goes live.

  • liveChatChannel:  string

    Channel ID that chat messages will be mirrored to by the bot. If this is null, chat messages will not be mirrored.

  • liveAnnounceChannel:  string

    Channel ID that chat announcements will be mirrored to by the bot. If this is null, chat messages will not be mirrored.

  • syncEmoteRoles:  Array<uint>

    A list of Discord roles who will be able to use subscriber emotes. (This only has an effect for partnered channels.)

  • roles:  Array<object>

    A list of roles which this DiscordBot controls.

    • Item properties:
      • id:  uint
      • type:  string (SUBS,FOLLOWERS)

        Describes what group of people are given this role.

      • roleId:  string
      • gracePeriod:  uint

        Number of days subscribers have until they're kicked from the server if their subscription expires. It defaults to 14 days and may be set to null to disable kicking. Violence is never the answer.

DiscordChannel

Represents a single channel within a Discord server.

  • id:  string

    The unique ID of the Discord channel.

  • name:  string

    The human name of the channel.

  • type:  string

    Either "voice", "text" or "category".

  • private:  boolean

    This field is deprecated.

DiscordRole

Represents a role within a Discord server.

  • id:  string

    The unique ID of the Discord role.

  • name:  string

    The human name of the role.

  • color:  string

    Hex color code for the channel, starting with a pound # symbol

  • assignable:  boolean

    Whether the bot has permission to assign users to this role. This depends on the role's position on Discord.

EmojiRankAnalytic extends ChannelAnalytic

A channel metric showing how many times an emoji was used in a period.

  • emoji:  string

    The Emoji's string representation. E.g. mappa.

  • count:  uint

    The number of times this emoji was used in the queried time period.

EmoticonGroup

A list of emoticons and their coordinates within an EmoticonPack.

  • Keys matching the RegEx /^:\w+$/:  object

    A single emote within this Group.

    • x:  uint

      X coordinate of the emote.

    • y:  uint

      Y coordinate of the emote.

    • width:  uint

      Width of the emote.

    • height:  uint

      Height of the emote.

EmoticonPack

An emoticon pack is a list of emoticons that belong to a channel.

  • url:  string

    The url to the sprite sheet.

  • emoticons:  EmoticonGroup

    An emoticon group, lists emoticons in this pack.

  • channelId:  uint

    The ID of the channel that owns this EmoticonPack.

ExpandedChannel extends ChannelAdvanced

Augmented ChannelAdvanced with additional properties.

  • thumbnail:  Resource?

    A resource object representing the thumbnail.

  • cover:  Resource?

    A resource object representing the cover.

  • badge:  Resource?

    A resource object representing the badge.

  • cache:  Array<object>

    Unused, deprecated.

  • preferences:  ChannelPreferences

    The channel preferences.

ExpandedRedeemable extends Redeemable

Augmented Redeemable with additional properties

  • owner:  User

    Embedded owner of this redeemable.

  • redeemedBy:  User

    Embedded redeemer of this redeemable.

ExpandedShare extends Share

Augmented share with additional properties.

  • user:  User?

    The embedded user the share targets.

ExpandedTranscodingProfile extends TranscodingProfile

Augments a regular transcoding profile by listing the transcodes available on this profile.

FTLVideoManifest

Provides details and information about an FTL Broadcast.

  • resolutions:  Array<VideoManifestResolution>

    A list of resoloutions for this FTL Broadcast.

    • Item properties:
      • iceServers:  Array<object>
        • Item properties:
          • url:  string

            The url of the ice server, can be stun or turn.

          • username:  string?

            Only set when url protocol is turn.

          • credentials:  string?

            Only set when url protocol is turn.

      • rtcId:  uint

        The ID of the channel.

  • since:  IsoDate

    Time the stream started.

Follow extends TimeStamped

Represents a follow relationship between a user and a channel.

  • user:  uint

    The follower user id.

  • channel:  uint

    The followee channel id.

FollowersAnalytic extends ChannelAnalytic

A channel metric showing how many followers the channel had at this time and the change in that metric.

  • total:  uint

    The total number of followers the channel now has.

  • delta:  number

    Increment that the total changed as a result of this event.

  • user:  number?

    The ID of the user who followed, may not be present in aggregations.

FrontendVersion

Describes an available FrontendVersion. Users can sometime swap between frontend versions to test out new features on Mixer.

  • version:  string

    The version name.

  • displayName:  string

    The version's display name for the frontend.

GameRankAnalytic extends ChannelAnalytic

A channel metric showing details about the type this channel is broadcasting.

  • streams:  uint

    The number of streams playing this game in the time period. Note that this is recorded once per unique stream when it ends.

  • views:  uint

    The number of views the game received in the time period

  • shared:  uint

    The number of times the game was shared in the time period

GameType extends GameTypeSimple

A GameType can be set on a channel and represents the title they are broadcasting.

  • parent:  string

    The name of the parent type.

  • description:  string

    The description of the type.

  • source:  string

    The source where the type has been imported from.

  • viewersCurrent:  uint

    Total amount of users watching this type of stream.

  • online:  uint

    Amount of streams online with this type.

GameTypeLookup extends GameTypeSimple

The result from looking up a game type.

  • exact:  boolean

    Whether this game type is an exact match to the query.

GameTypeSimple

Base game type.

  • id:  uint

    The unique ID of the game type.

  • name:  string

    The name of the type.

  • coverUrl:  string?

    The url to the type's cover.

  • backgroundUrl:  string?

    The url to the type's background.

HostingSession

Base game type.

  • hostees:  Array<uint>

    The channel(s) being hosted. Always at least one channel.

  • layout:  PlayerLayout

    The arrangement of players in the hosting context.

Ingest

An ingest definition. Ingests are used by streaming software to send video to Mixer.

Example:

{
   "name": "US: Dallas, TX",
   "host": "ingest-dal.mixer.com",
   "pingTest": "ingest-dal.mixer.com",
   "protocols": [
      {
         "type": "ftl"
      },
      {
         "type": "rtmp"
      }
   ]
}
  • name:  string

    The name and location of the ingest.

  • host:  string

    Url of the host.

  • pingTest:  string

    A websocket address that is used for ping tests.

  • protocols:  Array<object>

    List of supported protocols

    • Item properties:
      • type:  string (ftl,rtmp)

        The protocol name.

IngestStreamAnalytic

A metric providing video details about a broadcast.

  • ingest_id:  uint

    A unique id per ingest

  • channel_id:  uint

    The channel ID of the streamer

  • subscribed_dist_nodes:  uint

    How many dist nodes are watching

  • video_packet_loss:  number

    The packet loss percent for the last 5 seconds

  • video_packet_recovered:  number

    The percentage of packets recovered in the last 5 seconds

  • video_avg_recovery_delay:  uint

    The delay to recover a packet

  • video_avg_nack_delay:  uint

    The delay in the nack

  • video_bitrate:  uint

    The video bitrate for the last 5 seconds

  • video_jitter_buffer_size:  uint

    The jitter buffer size

  • audiovo_packet_loss:  number

    The packet loss percent for the last 5 seconds

  • audiov_packet_recovered:  number

    The percentage of packets recovered in the last 5 seconds

  • audiov_avg_recovery_delay:  uint

    The delay to recover a packet

  • audio_avg_nack_delay:  uint

    The delay in the nack.

  • audiov_bitrate:  uint

    The audio bitrate for the last 5 seconds

  • audioo_jitter_buffer_size:  uint

    The jitter buffer size

InteractiveAnalytic extends ChannelAnalytic

A channel metric showing details about the type this channel is broadcasting.

  • inputsGiven:  uint

    The number of inputs users gave in the interaction over the time window.

  • playtime:  uint

    The total length of time participants played for, in seconds.

  • streams:  uint

    The number of Interactive game client sessions run on stream during this window.

  • viewers:  uint

    The number of Interactive viewer sessions run on stream during this window.

  • streamLength:  uint

    The total duration of Interactive stream sessions.

  • timeToInteractive:  object

    Analytics detailing the number of seconds between when the page loaded and a participant interacted with the integration.

    • avg:  number

      Average value

    • max:  number

      Max value

    • min:  number

      Min value

    • std:  number

      Standard deviation

  • sparksSpent:  object

    Analytics detailing how many Sparks users spent in this period.

    • avg:  number

      Average value

    • max:  number

      Max value

    • min:  number

      Min value

    • std:  number

      Standard deviation

InteractiveConnectionInfo

Provides connection details that can be used to connect to an interactive session on a channel.

  • address:  string

    Websocket url to connect to.

  • key:  string

    The connection key required for connecting to interactive.

  • influence:  number

    Influence multiplier. This field is unused.

  • version:  InteractiveVersionExpanded

    The interactive game the channel is using.

InteractiveControls

Specifies the Interactive V1 Controls that an InteractiveVersion has.

  • reportInterval:  50≤uint≤10000

    How often frontend should report the state of the controls to the Interactive service.

  • joysticks:  Array<object>?

    An array of joysticks in this control specification.

    • Maximum length: 100
    • Item properties:
      • id:  uint

        The unique ID of the control.

      • blueprint:  Array<object>
        • Minimum length: 1
        • Item properties:
          • state:  string

            The state the button belongs to.

            • maxLength: 100
          • grid:  string
            • maxLength: 100
          • x:  uint

            X coordinate of the joystick.

          • y:  uint

            Y coordinate of the joystick.

          • width:  3≤uint≤3

            Width of the joystick.

          • height:  3≤uint≤3

            Height of the joystick.

      • analysis:  InteractiveJoyStickAnalysis

        The analysis types enabled on this joystick.

  • screens:  Array<object>?

    An array of screen controls in this control specification.

    • Maximum length: 100
    • Item properties:
      • id:  uint

        The unique ID of the control.

      • blueprint:  Array<object>
        • Item properties:
          • state:  string

            The state the button belongs to.

            • maxLength: 100
      • analysis:  InteractiveScreenAnalysis

        The analysis types enabled on this screen control.

  • tactiles:  Array<object>?

    An array of tactiles in this control specification.

    • Maximum length: 100
    • Item properties:
      • id:  uint

        The unique ID of the control.

      • blueprint:  Array<object>
        • Item properties:
          • state:  string

            The state the button belongs to.

            • maxLength: 100
          • grid:  string
            • maxLength: 100
          • x:  uint

            X coordinate of the tactile.

          • y:  uint

            Y coordinate of the tactile.

          • width:  1≤uint≤4

            Width of the tactile.

          • height:  1≤uint≤2

            Height of the tactile.

      • key:  uint

        The key to be bound to the tactile.

      • text:  string?

        The text to show on the tactile.

      • cost:  object
        • press:  object
          • cost:  uint

            Cost, in sparks, for a tactile press.

      • cooldown:  object
        • press:  uint?

          Length of cooldown started when a user pushes this tactile. In milliseconds.

      • analysis:  InteractiveTactileAnalysis

        The analysis types enabled on this tactile.

InteractiveGame extends TimeStamped

An InteractiveGame is owned by a Channel and provides details about an Interactive experience or game on Mixer.

  • id:  uint

    The unique ID of the game.

  • ownerId:  uint

    The user ID of the creator.

  • name:  string

    The name of the game.

  • coverUrl:  string?

    The url to the cover image.

  • description:  string

    The description of the game. This may contain HTML.

  • hasPublishedVersions:  boolean

    Indicates whether the game has any public published versions.

  • typeId:  uint

    The ID of the game associated with this interactive project.

  • installation:  string

    This field is unused and will be removed in future. Please use the installation property of InteractiveVersion instead.

InteractiveGameListing extends InteractiveGame

An interactive game within a list of Interactive games. Contains additional properties to avoid extra requests.

  • versions:  Array<object>

    The versions within this Interactive game listing.

    • Item properties:
      • id:  uint

        The ID of the version.

      • version:  string

        The semantic version string.

      • state:  string (draft,pending,published)

        The current state of the version. draft: Not in review, not published. pending: In review. published: Published and available to the public.

      • versionOrder:  uint

        Value used to help ordering versions.

  • owner:  User

    The creator of the game.

InteractiveJoyStickAnalysis

Analysis settings for a Joystick. If an analysis type is enabled results will be generated and sent to the Interactive Robot.

  • coords:  object

    Analysis settings on the coordinates property of a joystick

    • mean:  boolean

      Enable joystick mean analysis on this joystick.

    • stdDev:  boolean

      Enable standard deviation analysis on this joystick.

InteractiveMetric

An interactive metric represents a record for every time a channel enables interactive for any period of time

  • id:  UUID

    Unique ID for this stream viewer document.

  • channelId:  string

    ID of the Channel this interactive metric belongs to.

  • versionId:  string

    The version of the interactive project that was run.

  • projectId:  string

    ID of the interactive project that was run.

  • published:  boolean

    Whether the interactive project was published when it was run.

  • bundle:  string

    The bundle that was run.

  • publisherUserId:  string

    ID of the user that owns the interactive project.

  • mixerTypeId:  string

    The ID of the game type that was being streamed.

  • sessionLength:  uint

    The length of the interactive session.

  • totalPlaytimeHours:  uint

    The total playtime during the interactive session.

  • timestamp:  IsoDate

    The time stamp when the document was created.

InteractiveScreenAnalysis

Analysis settings for a Screen control. If an analysis type is enabled results will be generated and sent to the Interactive Robot.

  • position:  object

    Analysis sections for the position reported from this screen control.

    • mean:  boolean

      Enable mean analysis for this screen control.

    • stdDev:  boolean

      Enable standard deviation analysis for this screen control.

  • clicks:  boolean

    Enable click event for analysis for this screen control.

InteractiveTactileAnalysis

Analysis settings for a Tactile control. If an analysis type is enabled results will be generated and sent to the Interactive Robot.

  • holding:  boolean

    Enable holding analysis for the tactile.

  • frequency:  boolean

    Enable frequency analysis for the tactile.

InteractiveVersion extends TimeStamped

A versioned instance of an InteractiveGame.

  • id:  uint

    The unique ID of the version.

  • gameId:  uint

    The game ID this version belongs to.

  • version:  string

    The semver of the game.

  • versionOrder:  uint

    Value used to help ordering versions.

  • changelog:  string

    The changelog of version.

  • state:  string (draft,pending,published)

    The current state of the version. draft: Not in review, not published. pending: In review. published: Published and available to the public.

  • installation:  string

    Installation instructions. This may contain HTML.

  • download:  string

    Download instructions, usually a url.

  • controls:  InteractiveControls

    The controls for the game.

  • controlVersion:  string (1.0,2.0)

    Indicates which version of the Interactive Controls this Interactive Version uses.

  • bundle:  string

    The InteractiveBundle and version to use, delimited by underscores. For example, my-awesome-controls_1.3.0. It may be automatically suffixed with _public or _private, indicating the control's visiblity. This property is only visible by the author of the interactive version.

InteractiveVersionExpanded extends TimeStamped

A versioned instance of an InteractiveGame.

  • id:  uint

    The unique ID of the version.

  • gameId:  uint

    The game ID this version belongs to.

  • version:  string

    The semver of the game.

  • versionOrder:  uint

    Value used to help ordering versions.

  • changelog:  string

    The changelog of version.

  • state:  string (draft,pending,published)

    The current state of the version. draft: Not in review, not published. pending: In review. published: Published and available to the public.

  • installation:  string

    Installation instructions. This may contain HTML.

  • download:  string

    Download instructions, usually a url.

  • controls:  InteractiveControls

    The controls for the game.

  • controlVersion:  string (1.0,2.0)

    Indicates which version of the Interactive Controls this Interactive Version uses.

  • bundle:  string

    The InteractiveBundle and version to use, delimited by underscores. For example, my-awesome-controls_1.3.0. It may be automatically suffixed with _public or _private, indicating the control's visiblity. This property is only visible by the author of the interactive version.

InteractiveViewerAnalytic extends ChannelAnalytic

A channel metric showing details about a participant in the Interactive game.

  • country:  string?

    The viewer's two character country code, if it can be determined.

  • referrer:  string?

    String identifying where this user came from.

  • platform:  string (desktop,tablet,mobile)?

    The viewer's platform, if it can be determined.

  • browser:  string (chr,ff,ie,ios,sf,an)?

    The viewer's browser, if it can be determined.

  • channelId:  number?

    The channel ID on which the viewer participanted.

Invoice

A user invoice.

  • id:  uint

    The ID of the invoice.

  • currency:  string

    ISO 4217 currency code

  • status:  string (paid,unpaid,errored,cancelled)

    The invoice status

  • user:  uint

    The owner of the invoice.

  • createdAt:  IsoDate

    Creation date

  • amount:  number

    The total invoice amount.

  • items:  Array<InvoiceItem>

    List of invoice items

InvoiceItem extends TimeStamped

An item on a user's invoice.

  • id:  uint

    The ID of the invoice item.

  • type:  string (subscription,redeemable)

    The purchase type

  • relid:  uint?

    The channel id

  • description:  string

    A brief summary of what has been purchased.

  • amount:  number

    The cost of the item.

  • quantity:  uint

    Item quantity.

  • status:  string (paid,unpaid,errored,cancelled)

    The invoice status

  • user:  uint

    The user ID of the invoice owner.

  • invoice:  uint

    The invoice ID the item belongs to.

IsoDate

An ISO8601 date string.

Example:

2016-06-28T04:25:45.110Z

Language

An object representing a language.

  • id:  string

    A rfc5646 language code.

  • name:  string

    The full language name.

LanguageCount

An object describing a count for a language.

  • id:  string

    A rfc5646 language code.

  • count:  uint

    The count.

LightVideoManifest

Describes a broadcast using the Light manifest structure.

  • resolutions:  Array<VideoManifestResolution>

    An array of resoloutions for this broadcast.

    • Item properties:
      • url:  string

        The source url for the stream.

  • since:  IsoDate

    Time the stream started.

LocaleAndString

An object representing a language specific string.

  • language:  string

    A rfc5646 language code.

  • value:  string

    The localized string value.

Locator

Information required to find a clip.

  • locatorType:  string

    Type of content source this is (e.g. Download, SmoothStreaming, Thumbnail etc.)

  • uri:  string

    URL for this content source

Notification

A single notification addressed to a user.

  • userId:  uint

    The user ID that this notification belongs to.

  • sentAt:  IsoDate

    The time at which the notification was sent.

  • trigger:  string

    The event that triggered the notification.

  • payload:  object

    An generally unstructured object containing information about the event. Events of the same type will share the same structure.

NotificationPreference

A user's notification preferences.

  • id:  string

    The id for this notification preference.

  • allowsEmailMarketing:  boolean

    Whether the user allows general marketing/promotional email.

  • notifyFollower:  Array<string>

    A list of transports follower notifications will be sent over.

  • notifySubscriber:  Array<string>

    A list of transports subscriber notifications will be sent over.

  • liveOnByDefault:  Array<string>

    A list of notification transport wentlive notifications are sent on by default.

  • lastRead:  IsoDate

    The time the user last read their notifications.

  • health:  object

    Controls the health notification settings for this user.

    • eat:  number≤72

      Interval, in hours, to show eating notifications.

    • stretch:  number≤72

      Interval, in hours, to show stretching notifications.

  • liveNotifications:  Array<object>

    A list of channels and transports registered on which we'll send wentlive emails.

    • Item properties:
      • channelId:  uint ∪ string

        May be "*", which will toggle on the associated transport for all channels the user follows.

      • kind:  string
  • transports:  Array<object>

    Controls the transports used to deliver notifications to this user.

    • Item type: object

OAuthAuthorization

An OAuthClient which has been authorized by the user.

  • permissions:  Array<string>

    List of permissions the authorization has.

  • userId:  uint

    The ID of the other the authorization is for.

  • client:  OAuthClient

    The OAuth client linked to this authorization.

OAuthClient

An OAuthClient is an application or tool created by a developer. They can be used to ask for access to a user's account.

  • id:  uint

    Internal client id.

  • clientId:  string

    The unique ID of the client.

    • pattern: 
      ^[a-f0-9]{48}$
  • name:  string

    The name of the client.

  • website:  string?

    The url of the website using this client.

  • logo:  string?

    The url to the logo of the website.

  • hosts:  Array<string>

    List of wildcard hosts allowed to use the client.

OAuthLink

Represents a linked account on another non-mixer service that this user has linked to their account.

  • service:  string

    The service this link is to, such as twitter or discord.

  • serviceId:  string

    The user's ID on the external service.

  • userId:  number

    The associated Mixer user ID.

PartnershipApp extends TimeStamped

Contains details about a particular partnership application.

  • status:  string (applied,accepted,denied)

    The state of this application, which may be one of:

    • applied - The Application has been submitted and is under review by the Team.
    • accepted - The Application has been accepted.
    • denied - The Application has been denied.
  • reapplies:  IsoDate?

    The date of the next possible application, only set if status is denied. If the value is null while status is denied, the channel is banned from re-applying.

  • reason:  string?

    The reason of the denial, only set if status is denied.

PartnershipCriterion extends TimeStamped

A criterion that a channel must meet in order to apply for partnership.

  • id:  number

    The ID of the criterion that was tested.

  • name:  string

    The friendly name of the criterion that was tested.

  • description:  string

    The description of the criterion that was tested.

  • type:  string

    The type of evaluation to perform.

  • comparison:  string (LT,LTEQ,EQ,GTEQ,GT)

    The type of comparison to perform between the target and actual, which may be one of:

    • LT - The target is less than the actual.
    • LTEQ - The target is less than or equal to the actual.
    • EQ - The target is equal to the actual.
    • GTEQ - The target is greater than or equal to the actual.
    • GT - The target is greater than the actual.
  • target:  number

    The target number that the channel must meet to be considered valid.

  • isEnabled:  boolean

    Whether or not the criterion is enabled. Disabled critera will not affect evaluation.

PartnershipCriterionResult

The result of evaluating a partnership criterion.

  • criterionId:  number

    The ID of the criterion that was tested.

  • type:  string

    The type of evaluation to perform.

  • comparison:  string (LT,LTEQ,EQ,GTEQ,GT)

    The type of comparison to perform between the target and actual, which may be one of:

    • LT - The target is less than the actual.
    • LTEQ - The target is less than or equal to the actual.
    • EQ - The target is equal to the actual.
    • GTEQ - The target is greater than or equal to the actual.
    • GT - The target is greater than the actual.
  • target:  number

    The target number that the channel must meet to be considered valid.

  • actual:  number

    The actual result of the evaluation.

  • succeeded:  boolean

    Whether or not the channel passed the criterion.

PartnershipEvaluationResult

The result of evaluating whether or not a channel is eligible for partnership.

PartnershipExemption extends TimeStamped

An exemption that allows a specific channel to bypass the minimum requirements check for partnership.

  • id:  number

    The ID of the exemption.

  • channelId:  number

    The ID of the channel that was granted an exemption.

  • approverId:  number

    The ID of the user that granted the exemption.

  • agency:  string?

    The agency that the partner is a part of.

  • revoked:  boolean

    Whether or not this exemption has been revoked.

  • reason:  string?

    If the exemption has been revoked this is the reasonf or the revokation.

  • revokerId:  number?

    If the exemption has been revoked this is the ID of the user that revoked it.

PartyChatCreate

Sent in the request to create a new party chat channel.

  • protocolVersion:  number

    Party chat protocol version number.

  • deviceUUID:  string

    Device-bound GUID, used for identifying this device in a party session where a user could be connected on multiple devices.

  • webRtcDtlsCertificateAlgorithm:  string?

    Provided in the WebRTC negotiation.

  • webRtcDtlsCertificateThumbprint:  string?

    Provided in the WebRTC negotiation.

  • webRtcIceUfrag:  string?

    Provided in the WebRTC negotiation.

  • webRtcIcePwd:  string?

    Provided in the WebRTC negotiation.

PartyChatLatencyRecord

Results of a latency measurement to a server.

  • serverFqdn:  string

    Domain name of the server, like foo.cloudapp.net.

  • targetLocation:  string

    Human-readable location.

PartyChatMemberRef

Reference one user session in a party chat.

  • partyId:  UUID

    GUID of the party chat instance.

  • gamertag:  string

    Xbox live gamertag of the member in the chat.

  • index:  number

    Index of the user's record in the party chat record. This is used to handle scenarios where a user might be connected on multiple devices, we need to distinguish which record is being operated on.

PartyChatServer

A server used to measure location-based latency in party chat.

  • serverFqdn:  string

    Domain name of the server, like foo.cloudapp.net.

  • targetLocation:  string

    Human-readable location.

PartyChatSession

A Party Chat voice session.

  • partyId:  UUID

    The party ID.

  • serverConnectionCandidates:  Array<string>

    Q10 relay candidates, filled in sometime after (and possibly instantly after) QoS metics are reported in POST /partyChat/handshake/qosServers.

  • members:  Array<object>

    A list of members currently in the party. This is an Xbox Party Chat, so gamertags and references are always provided, but the linked mixerUser is only provided if that Xbox user has a linked Mixer account.

    • Item properties:
      • gamertag:  string
      • simpleConnectionState:  number
      • mixerUser:  object?
        • id:  number
        • username:  string
      • ref:  PartyChatMemberRef

PartyChatSubscription

Provided to the Mixer server, then MPSD, when the client sets up an RTA subscription. See the Book of Party Chat / MPSD reference for more information about this, and how to use it.

  • active:  boolean

    Whether the subscription is active, generally always set to true.

  • connection:  UUID

    Connection ID obtained from the RTA subscription response.

  • subscriptionId:  UUID

    Globally unique random GUID generated by the local device.

  • changeTypes:  Array<string>

    The parts of the MPSD document that will result in shouldertaps.

PlayerLayout

The PlayerLayout configures the arrangement and positioning of the channels within a costream or hosting session.

  • name:  string

    Name of the layout to use for this arrangement. Possible options are mobile, grid, sidebar and chooser.

  • order:  Array<number>

    Deprecated: use settings instead.

  • players:  Array<object>

    Contains settings for channels. Channels are arranged in the layout in the order they're described here.

    • Item properties:
      • channelId:  number

        The channel shown in this player.

      • lowLatency:  boolean

        Whether to attempt to load low latency, or not. Defaults to true.

      • interactivePinned:  boolean

        If true and this channel has Interactive enabled, Interactive will be locked to this channel.

      • volume:  number

        Default volume level of the player, as a percentage from 0 to 1.

      • left:  number

        Player position from the left of the screen, as a percentage from 0 to 1.

      • top:  number

        Player position from the top of the screen, as a percentage from 0 to 1.

      • width:  number

        Player width on the screen, as a percentage from 0 to 1.

      • height:  number

        Player height on the screen, as a percentage from 0 to 1.

PrivatePopulatedUser extends PrivateUser

A fully populater user with channel, preferences, groups and private details.

PrivateUser extends User

A fully populater user with channel, preferences, groups and private details.

  • email:  string

    The users email address.

  • password:  string

    The users password.

    • minLength: 4
  • twoFactor:  object

    The 2 factor authentication settings for this user.

    • enabled:  boolean

      Indicates whether 2fa is enabled.

    • codesViewed:  boolean

      Indicates whether recovery codes have been viewed.

ProgressionActiveStorageProject

A type that contains information about progression storage that has been loaded into a channel.

  • channelId:  uint

    The target channel for the progression storage.

  • gameTypeId:  uint

    The mixer type ID of the game.

  • projectId:  UUID

    The ID of the progression storage project.

  • progressionActive:  boolean?

    If the progression storage project is currently active in the channel.

  • startTime:  IsoDate?

    The loaded date of the progression storage project into the channel.

ProgressionActiveStorageProjectList

A type that contains a page of results from an active progression project query.

  • continuationToken:  string?

    The token to use to retrieve the next page of results, if there are more results.

  • results:  Array<ProgressionActiveStorageProject>

    The list of progression storage projects for the channel.

ProgressionAppAccess

A type that contains key value pairs where the key is an app or game reference and the value is its permissions to a progression project.

  • All keys:  ProgressionGameAccess

    Each property is a mapping from an app or game to what permissions it has to a user's progression storage. Each property's name is an OAuth clientId or an Xbox game title ID.

ProgressionChannelViewerStorageLoadResult

A type that contains information about an operation to run against a player or channel viewers.

  • results:  Array<ProgressionViewerStorageLoadResult>

    The list of results of this user's load operations for any projects with storage currently loaded into the channel.

ProgressionEvent

A type that contains information about a notification event to be sent for progression storage changes.

  • id:  UUID

    The unique ID of this event.

  • name:  string

    The name of this event.

  • type:  string (unspecified,unlock,valueUpdate)

    The type of notification.

  • owningProject:  UUID?

    A project id of the project that controls rights to read, modify or delete this event.

  • awardMessages:  Array<LocaleAndString>?

    A list of language code to localized strings to be shown to the viewer when the event is recieved.

  • awardMessagesDetails:  Array<LocaleAndString>?

    A list of language code to localized strings to be shown to the viewer when they click on the event.

  • maxDisplayLengthInMilliseconds:  uint?

    Maximum time that the awardMessages string will be shown. Typically this is on the firect of these events recieved.

  • minDisplayLengthInMilliseconds:  uint?

    Minimum time that the awardMessages string will be shown to the viewer.

ProgressionEventList

A type that contains a page of results from a progression project events query.

  • continuationToken:  string?

    The token to use to retrieve the next page of results, if there are more results.

  • results:  Array<ProgressionEvent>

    The list of progression project events.

ProgressionGameAccess

Available rights in comma delimited string:

  • none - no access, should not be used with other rights.
  • readFromAudience - allows a game or app to read values from viewers' storage.
  • writeToAudience - allows a game or app to write to viewers' storage.
  • readFromPlayer - allows a game or app to read project storage of the authenticated user.
  • writeToPlayer - allows a game or app to write to project storage of the authenticated user.
  • deletePlayerStorage - allows a game or app to delete project storage of the authenticated user, if the project is not published.

ProgressionLocalizedNotification

A type that contains information about an operation to run against a player or channel viewers.

  • awardMessage:  string?

    Notification to be sent to the viewer if the operation results in a value change.

  • awardMessageDetails:  string?

    Additional details to be shown if the notificatrion is clicked.

  • id:  UUID

    Guid of this event, matches with notificationEventId of ProgressOperation

  • language:  string

    The two digit language code of the language the event should be rendered in

  • name:  string

    The non-localized friendly name of the event.

  • type:  string (unspecified,unlock,valueUpdate)

    The type of the event.

  • maxDisplayLengthInMilliseconds:  uint

    Maximum time that the awardMessages string will be shown. Typically this is on the firect of these events recieved.

  • minDisplayLengthInMilliseconds:  uint

    Minimum time that the awardMessages string will be shown to the viewer.

ProgressionOperation

A type that contains information about an operation to run against a player or channel viewers.

  • amount:  number?

    The value to modify a current value by. Required for all operations except notify.

  • awardMessage:  string?

    Notification to be sent to the viewer if the operation results in a value change.

  • awardMessageDetails:  string?

    Additional details to be shown if the notificatrion is clicked.

  • countOfOperationsPerTimeRestriction:  number

    Number of modifications to the target 'stat' that should be allowed during the 'timeRestriction' period.

  • maxVal:  number

    Maximum value restriction. The operation will not run if the result will violate this constraint.

  • minVal:  number

    Minimum value restriction. The operation will not run if the result will violate this constraint.

  • notificationEventId:  UUID

    Unique ID of this operation. Can be used to send events without a notification or for localized award messages.

  • op:  ProgressionOperationType

    The operation to perform on the current value.

  • sessionIds:  Array<UUID>

    a list of viewer session IDs to restrict this operation to executing for. Can be correlated with a Mixplay interactive participant's sessionID.

  • stat:  string

    The name of the value to operate on. Required for all operations except notify.

  • timeRestriction:  string (daily,monthly,weekly)

    Restricts this operation from running if the value has already been modified within the time interval.

ProgressionOperationError

A type that contains information a viewer session and failed operation.

  • sessionId:  UUID

    The session IS of the user that this failure occurred for. Can be correlated with a Mixplay interactive participant's sessionID

  • error:  string

    The information on the failure that occurred.

ProgressionOperationErrors

A type that contains information about failures in a partial success operation.

ProgressionOperationType

Available operations are:

  • inc - Increment, an addition operation.
  • dec - Decrement, a subtraction operations.
  • 'del' - Delete, remove that value from the users storage.
  • and - A bitwise AND operartion.
  • or - A bitwise OR operation.
  • xor - A bitwise XOR operation.
  • set - A direct overwrite of any existing value.
  • notify - Forces a notification without a corresponding value modification.

ProgressionOperations

A type that contains information about progression operations to run against a player or channel viewers.

ProgressionPlayerStorage

A type that contains information about progression storage for a player.

  • projectId:  UUID?

    The project ID of the storage. Only set when returning storages for multiple projects.

  • statistics:  Array<ProgressionStatistic>

    The target channel for the progression storage.

ProgressionPlayerStorageList

A type that contains a page of results from an progression storage query.

  • continuationToken:  string?

    The token to use to retrieve the next page of results, if there are more results.

  • results:  Array<ProgressionPlayerStorage>

    The list of storages across all projects.

ProgressionProject

A type that contains information about progression storage across users for a specific game.

  • id:  UUID

    The unique ID of this project.

  • name:  string

    The name of this project.

  • gameTypeId:  uint

    The mixer type ID of the game.

  • owningUsers:  Array<uint>

    A list of user IDs of users that have rights to read, modify or delete this project.

  • applicationAccess:  ProgressionAppAccess

    A list of OAuth applications and what rights they have to project storage.

  • xboxDecimalTitleIdAccess:  ProgressionAppAccess

    A list of Xbox games and what rights they have to project storage.

  • fiveMinuteHeartbeatOperations:  Array<ProgressionOperation>

    Operations that should be executed automatically for all viewers every five minutes any time the game is streamed.

  • isPublished:  boolean

    If the project is published. The fiveMinuteHeartbeatOperations will only execute in test streams for unpublished projects.

ProgressionProjectList

A type that contains a page of results from a progression project query.

  • continuationToken:  string?

    The token to use to retrieve the next page of results, if there are more results.

  • results:  Array<ProgressionProject>

    The list of progression projects.

ProgressionProjectType

Available rights in comma delimited string:

  • none - no type set, do not use.
  • inGameRewards - viewing on Mixer earns rewards/state that can be used or redeemed by playing the game.
  • mixerCrossChannel - viewing on Mixer writes a save game that can be used when viewing the game on other channels on Mixer.

ProgressionQueryContinuation

A type that contains continuation information for a query.

  • continuationToken:  string?

    The token to use to retrieve the next page of results, if there are more results.

  • limit:  number

    The maximum number of loaded project to return.

ProgressionStatistic

A type that contains information about a single value in progression storage.

  • stat:  string

    The name of the stored value.

  • amount:  number

    The current value for the player or viewer.

ProgressionViewerStatisticValue

A type that contains information about a single value in progression storage.

  • sessionId:  UUID

    The session ID for the viewer that has this value. Can be correlated with a Mixplay interactive participant's sessionID.

  • value:  number

    The current value for the viewer.

ProgressionViewerStorageLoadResult

A type that contains information about a single value in progression storage.

  • channelId:  uint

    The channel the viewer's storage for this project is currently loaded in.

  • project:  ProgressionActiveStorageProject

    Information about the project whose storage the load operation was run for.

  • result:  string (unspecified,activated,alreadyActive,activeOnOtherChannel,activationFailed)

    The result state of the load operation.

  • statusCode:  uint?

    The http status code associated with the load result.

ProgressionViewersStatisticValues

A type that contains information about a single value in progression storage.

  • stat:  string

    The name of the statistic for which values are being provided across the viewing audience.

  • results:  Array<ProgressionViewerStatisticValue>

    The list of connected viewer sessions and values, if the viewer has that value set.

Recording extends TimeStamped

Details about a recorded Broadcast from a channel.

  • id:  uint

    The unique ID of the recording.

  • channelId:  uint

    The channel ID this recording is a video of.

  • state:  string (PROCESSING,AVAILABLE,DELETED)

    The state of this recording, which may be one of:

    • PROCESSING - This Recording is being processed by Mixer and is unavailable to watch.
    • AVAILABLE - This Recording is available and can be watched on Mixer.
    • DELETED - This Recording has been deleted and cannot be watched.
  • viewsTotal:  uint

    The number of users who have viewed this recording.

  • expiresAt:  IsoDate

    The date this recording will be deleted at.

  • vods:  Array<VOD>

    The video formats available for this recording.

  • viewed:  boolean?

    Whether the current user has viewed the recording. This will generally only appear when the recording is looked up from an endpoint with user in the query string.

  • name:  string?

    Name of the Recording, usually the title of the channel at the time of the recording unless the creator changed it.

  • typeId:  uint

    Type id of the recording, usually the type id of the channel at the time of the recording, unless the creator changed it.

  • duration:  number

    Duration of the recording in seconds.

  • seen:  boolean?

    Defines if the video was seen by the user. Only present when the user context was given.

  • contentId:  string

    The content id of the Recording to be referenced to v2 VoD

RecurringPayment extends TimeStamped

A recurring payment is a payment which will continue to be charged to the user every period until it is canceled. These are used for subscriptions and Mixer Pro.

  • id:  uint

    The unique ID of the payment.

  • type:  string (subscription)

    The type of the product the payment is for.

  • relid:  uint

    The ID of the target the payment is for. This can be a channel or a user.

  • status:  string (active,cancelled,failed,before_gateway)

    The status of the payment.

  • cancelled:  boolean

    Indicates whether the payment has been cancelled. This is not the same as status being set to cancelled; this property indicates that the user cancelled a running payment.

  • gateway:  string (braintree,stripe)

    The internal name of the payment processsor.

  • timesPaid:  uint

    Counts the amount of times this recurring payment has recurred.

  • user:  uint

    The ID of the user the payment is for.

RecurringPaymentExpanded extends RecurringPayment

An augmented recurring payment with additional details, used in Details views. Provides nested objects such as the owner of the RecurringPayment.

Redeemable extends TimeStamped

A redeemable is an item granted to a user that can be exchanged for an item or activity. These are currently only used for Mixer Pro membership and channel subscriptions.

  • id:  uint

    The unique ID of the redeemable.

  • ownerId:  uint

    The ID of the owning user.

  • state:  string (unpaid,paid,redeemed)

    The state of this redeemable, which may be one of:

    • unpaid - This redeemable is not paid for and still requires payment.
    • paid - This redeemable has been paid for.
    • redeemed - This redeemable has been used.
  • type:  string (Pro,Subscription)

    The type of this Redeemable. Currently only two redeemables are available. Mixer Pro Membership and Channel Subscriptions.

  • code:  string?

    The redeem code.

  • redeemedById:  uint?

    The ID of the user that used the code.

  • redeemedAt:  IsoDate?

    The time the item was redeemed.

  • meta:  object

    An object containing meta information about a redeemable.

RedeemablePartner extends TimeStamped

Extra information added to a redeemable when it is a Partner's monthly subscription / Pro codes.

  • id:  uint

    The unique ID of the channel.

  • redeemableId:  uint

    The id of the related redeemable.

  • partnerId:  uint

    The id of the related partner.

Resource

Resources are general use items that are stored and linked to other entities within Mixer.They usually represent images or backgrounds for a channel or user.

  • id:  uint

    The unique ID of the resource.

  • type:  string

    The type of the resource.

  • relid:  uint

    Id linking to the parent object.

  • url:  string

    The url of the resource.

  • store:  string (s3)

    The storage type of the resource.

  • remotePath:  string

    Relative url to the resource.

  • meta:  object?

    Additional resource information.

Role

Available roles are:

  • User - A regular user. All Users have this.
  • Banned - A user who has been banned from the channel will have this role.
  • Pro - A user who has an active Mixer Pro subscription will have this role.
  • VerifiedPartner - A channel who is marked as Verified but does not have a Subscribe button will have this role.
  • Partner - A channel that has a Subscribe button will have this role.
  • Subscriber - A user who has an active subscription for the partnered channel involved in this request will have this role.
  • ChannelEditor - A user marked as a Channel Editor will be able to change that channel's title, game, and other channel properties.
  • Mod - A user will have this role if they are a moderator in the channel involved in this request.
  • GlobalMod - A user will have this role if they are a global moderator on Mixer.
  • Staff - A User will have this role if they are Mixer Staff.
  • Founder - A User will have this role if they are a Mixer Founder.
  • Owner - A user will have this role if they are the owner of the channel involved in this request.

SemVer

A semantic version number.

Example:

1.3.10

Session

Provides details about a Mixer user's session.

  • expires:  UnixTimestampMillis

    The time when the session expires.

  • meta:  object

    Session meta data.

    • device:  string

      The device type.

    • client:  string

      The client name. "Other" is web.

    • cversion:  string

      Semantic version of the client.

    • os:  string

      The operating system name of the client.

  • ip:  string

    Last IP used for that session. This can be IPv4 or IPv6.

  • id:  string

    The session ID as a UUID.

Share extends TimeStamped

A share allows a user to share an entity with another user. Currently this is only used for InteractiveGames.

  • id:  uint

    The unique ID of the share.

  • type:  string (interactiveGameDraft)

    The type of the share.

  • relid:  string

    The id of the shared resource.

  • code:  string?

    The Share code given to this Share. If available this code can be used to gain access to this resource.

  • userId:  uint?

    The user ID of the target, can be unset if code is set.

SocialInfo

The social information for a channel.

  • twitter:  string

    Twitter profile URL.

  • facebook:  string

    Facebook profile URL.

  • youtube:  string

    Youtube profile URL.

  • player:  string

    Player.me profile URL.

  • discord:  string

    Discord username and tag.

  • verified:  Array<string>

    A list of social keys which have been verified via linking the Mixer account with the account on the corresponding external service.

    • Item type: string

StreamHostsAnalytic extends ChannelAnalytic

Metric showing when a channel is hosted.

  • hoster:  uint?

    The channel doing the hoster, may be omitted if the channel is the hoster.

  • hostee:  uint?

    The channel being hosted, may be omitted if the channel is the hostee.

StreamSessionsAnalytic extends ChannelAnalytic

Metric showing a channel going online or offline.

  • online:  boolean

    Whether this event is the channel going online, or offline.

  • duration:  uint?

    The length of the last stream in seconds. This is only included in offline events.

  • type:  uint?

    The ID of the game the stream was playing. This is only included in offline events.

  • partnered:  boolean

    Whether the channel was partnered at the time of this data point.

StreamViewer

A stream viewer represents a record for every time a viewer watches a stream for any period of time

  • id:  UUID

    Unique ID for this stream viewer document.

  • broadcastId:  string

    ID of the broadcast that the user was watching.

  • channelId:  string

    ID of the Channel this stream belongs to.

  • browser:  string

    The browser the user uses to watch the stream.

  • costreamDepth:  string

    0 = not in a costream, 1 = in a costream and the primary stream the user navigated to, 2 = secondary view within a costream.

  • durationInSeconds:  number

    The duration of the viewing period.

  • platform:  string

    The platform the user uses to watch the stream.

  • startedAt:  IsoDate

    The time stamp when the document is created.

  • userId:  string

    ID of the user who is watching.

  • typeId:  string

    The ID of the game type that is being streamed.

  • country:  string

    The country where the viewer is in.

  • partnered:  boolean

    Whether the broadcaster is partnered with mixer.

SubRevenueAnalytic extends ChannelAnalytic

A channel metric that shows when a channel's subscription revenue changes.

  • gateway:  string (redeemable,stripe,braintree)

    The gateway that the subscription was made with.

  • total:  number

    The amount of revenue gained through this gateway.

  • gross:  number

    The amount of money prior to transaction fees being applied.

  • count:  uint

    The number of subscriptions made through this gateway.

Subscription extends TimeStamped

A subscription lists details about a user's subscription to a resource.

  • id:  uint

    The unique ID of the subscription.

  • resourceId:  uint?

    ID of the resource type this payment is for. Currently, this is only a channel ID.

  • resourceType:  string?

    The resource type the resourceId points to. Currently, this is only channel.

  • status:  string (active,expired,pending)

    The status of the subscription.

  • cancelled:  boolean

    Indicates whether the payment has been cancelled after completion.

  • expiresAt:  IsoDate

    The time when the subscription expires.

SubscriptionExpanded extends Subscription

The subscription belonging to this payment.

  • user:  User

    The user of the payment.

  • group:  UserGroup

    The group obtained through this payment.

SubscriptionPlan

Details on a subscription plan

  • id:  string

    Unique ID for this plan.

  • name:  string

    Name of the plan.

  • type:  string

    Type of plan.

  • currency:  string

    Currency for purchasing the plan.

  • amount:  string

    Amount to purchase this plan.

SubscriptionWithGroup extends Subscription

A subscription with added group information as a nested object.

  • group:  uint

    The group ID of the group the subscription grants the user access to.

  • Group:  UserGroup

    The embedded group assigned to the user.

SubscriptionsAnalytic extends ChannelAnalytic

A channel metric that shows when a subscription was made to a channel.

  • total:  uint

    The total number of subscribers the channel now has.

  • delta:  number

    Increment that the total changed as a result of this event.

  • user:  uint

    The ID of the user who subscribed, may not be present in aggregations.

Team extends TimeStamped

A team is a group of users.

  • id:  uint

    The unique ID of the team.

  • ownerId:  uint

    The ID of the owner user.

  • token:  string

    The internal name of the team.

    • minLength: 4
    • maxLength: 20
  • name:  string

    The display name of the team.

    • minLength: 4
    • maxLength: 36
  • description:  string?

    The description of the team.

  • logoUrl:  string?

    The url pointing to a logo image.

  • backgroundUrl:  string?

    The url pointing to a background image.

  • social:  SocialInfo?

    Social info of the team.

TeamMembership extends TimeStamped

Provides details about the membership of a user to a team.

  • id:  uint

    The unique ID of the team membership.

  • teamId:  uint

    The team ID of this membership.

  • userId:  uint

    The user ID of this membership.

  • accepted:  boolean

    If false, the user has just been invited. If true, the user has joined the team.

TeamMembershipExpanded extends TeamMembership

A team membership expanded with additional properties including nested relations.

  • isPrimary:  boolean

    Indicates that this team is the users primary.

  • owner:  User?

    Embedded user object, may be unset if the group owner's account is disabled.

  • teamMembership:  TeamMembership

    The membership object linking team and user.

TestStreamSetting

Lists the test stream settings for a Channel.

  • id:  uint

    The ID of the channel the settings are for.

  • isActive:  boolean

    Whether the next channel broadcast will be in test stream mode.

  • hoursQuota:  number

    How many test stream hours the channel gets at every internal.

  • hoursRemaining:  number

    The number of test stream hours left this period.

  • hoursResetIntervalInDays:  uint

    The interval, in days, at which hoursRemaining is set to the hoursQuota.

  • hoursLastReset:  IsoDate?

    The last date at which the user's hours were reset.

TimeStamped

A type that contains information about creation, update and deletion dates.

  • createdAt:  IsoDate

    The creation date of the channel.

  • updatedAt:  IsoDate

    The update date of the channel.

  • deletedAt:  IsoDate?

    The deletion date of the channel.

TranscodingProfile

A transcoding profile controls the transcoding options for a channel.

  • id:  uint

    The unique id of the transcoding profile.

  • name:  string

    The name of the transcoding profile.

TranscodingProfileTranscode

Represents a single transcode option for a channel.

  • id:  uint

    The unique id of the transcode.

  • name:  string

    The name of the transcode.

  • title:  string

    The display title of the transcode.

  • width:  uint

    The width (in pixels) of the transcode.

  • height:  uint

    The height (in pixels) of the transcode.

  • bitrate:  uint

    The bitrate of the transcode.

  • fps:  uint

    The FPS of the transcode.

  • requiresPartner:  boolean

    If this transcode requires to be partnered.

TypeInformation

Describes a type stored in the Mixer backend.

  • aliases:  Array<string>?

    Aliases for the type.

  • backgroundUrl:  string?

    URL to background picture.

  • coverUrl:  string?

    URL to cover picture.

  • id:  string

    The type ID.

  • name:  string?

    Name for the type.

  • titles:  Array<TypeTitle>?

    List of titles associated with the type.

  • verified:  boolean

    whether the title has been verified.

  • parent:  string

    The parent of the type

  • description:  string?

    A text description of the type

  • source:  string?

    The source of this type

  • viewersCurrent:  number

    The current number of viewers for the type

  • online:  number
  • availableAt:  IsoDate?

    The date at which the type became available

TypeTitle

Describes a title associated with a type.

  • aumId:  string?

    The "Application User Model ID" from the Modern Store catalog.

  • kglId:  string?

    The KGL ID of the application in the known games list.

  • processName:  string?

    Process name of the application.

  • productId:  string?

    Windows Store product id (aka big id).

  • titleId:  number?

    The Xbox title ID.

UUID

A universally unique identifier (UUID).

Example:

4825bcf1-9640-4d91-bf66-426731cfa717

UnixTimestampMillis extends uint

A unix timestamp with milliseconds.

User extends TimeStamped

A user is a person on Mixer; they can sign in and interact with the site. Each user owns a channel, which they can broadcast to.

  • id:  uint

    The unique ID of the user.

  • level:  uint

    The user's current level on Mixer, as determined by the number of experience points the user has.

  • social:  SocialInfo?

    Social links.

  • username:  string

    The user's name. This is unique on the site and is also their channel name.

    • minLength: 1
    • maxLength: 20
  • email:  string?

    The user's email address. This is only shown if apropriate permissions are present.

    • maxLength: 190
  • verified:  boolean

    Indicates whether the user has verified their e-mail.

  • experience:  uint

    The user's experience points.

  • sparks:  uint

    The amount of sparks the user has.

  • avatarUrl:  string?

    The user's profile URL.

  • bio:  string?

    The user's biography. This may contain HTML.

  • primaryTeam:  uint?

    The ID of user's main team.

UserGroup extends TimeStamped

A Group which a user can belong to can control features or access controls throughout Mixer.

  • id:  uint

    The unique ID of the group.

  • name:  Role

    The name of the group.

UserInteractiveMetric

A user interactive metric represents a record for every time a user views an channel with interactive running for any period of time

  • id:  UUID

    Unique ID for this stream viewer document.

  • versionId:  string

    The version of the interactive project that was run.

  • channelId:  string

    ID of the Channel this the user was viewing.

  • userId:  string

    ID of the user that joined the interactive session.

  • sparksSpent:  uint

    The total sparks the user spend during the interactive session.

  • inputsGiven:  uint

    The total number of inputs from the user during the interactive session.

  • timeToInteract:  uint

    The amount of time between the user joining the session and when the user sent their first input.

  • playtime:  uint

    The amount of time the user spend in the interactive session.

  • region:  string

    The user's region.

  • platform:  string

    The user's platform.

  • browser:  string

    The user's browser.

  • referrer:  string

    The referrer.

  • timestamp:  IsoDate

    The time stamp when the document was created.

UserLog

A UserLog entry lists events and changes made to a user.

  • id:  uint

    The unique ID of the log entry.

  • userId:  uint

    User ID of the log entry.

  • event:  string

    A unique identifier for the log entry.

  • eventData:  object?

    Unstructured data describing the event.

  • source:  string (GUEST,SELF,APP,INTERNAL,ADMIN)

    Source data for the event action. This may be one of:

    • GUEST: a change by an unauthenticated user
    • SELF: a change by the user themselves
    • APP: a change by an external OAuth app
    • INTERNAL: a change by some internal Mixer system
    • ADMIN: a change by a user who was permitted to administer the user's account
  • sourceData:  object?

    Unstructured data containing more information about the event's source.

    • SELF and GUEST sources will include an ip address
    • APP sources will contain the OAuth app ID
    • INTERNAL and ADMIN sources will omit this attribute
  • createdAt:  IsoDate

    The date the log entry occurred at.

UserPreferences

Object containing user preferences.

  • chat:sounds:html5:  boolean?

    Use html5 to play chat sounds.

  • chat:sounds:play:  boolean?

    Play sounds in chat.

  • chat:whispers:  boolean?

    Allow receiving whispers.

  • chat:timestamps:  boolean?

    Show timestamps in chat.

  • chat:chromakey:  boolean?

    Set the chat color to a certain color so it can be easily replaced.

  • chat:tagging:  boolean?

    Enable chat tagging via @username.

  • chat:sounds:volume:  number≤1?

    Chat sound volume as unit interval.

  • chat:colors:  boolean?

    Use colors in chat.

  • chat:lurkmode:  boolean?

    Hide while in chats.

  • channel:notifications:  object?

    Notification settings.

    • ids:  Array<string>

      List of sources notifications are allowed from.

    • transports:  Array<string>

      Allowed notification transports.

      • Item type: string (notify,email)
  • channel:mature:allowed:  boolean?

    Confirmed mature channels.

  • channel:player:forceflash:  boolean?

    Force the player to the flash version.

UserWithChannel extends User

A User object with an embedded Channel.

  • channel:  Channel

    The user's channel.

UserWithGroups extends User

A User object with an embedded array of groups they belong to.

  • groups:  Array<UserGroup>

    The groups of the user.

VOD extends TimeStamped

A VOD is a recorded broadcast which can be watched again on Mixer.

  • id:  uint

    The unique ID of the VOD.

  • baseUrl:  string

    The base URL of a VOD

  • format:  string (hls,raw,dash,thumbnail,chat)

    The format of the recording. It can be in:

  • data:  object?

    Format-specific information about the VOD. Is null when type is chat.

    • Width:  uint

      Present for hls, raw, dash and thumbnail.

    • Height:  uint

      Present for hls, raw, dash and thumbnail.

    • Fps:  number?

      Present for hls, raw and dash.

    • Bitrate:  uint?

      Present for hls, raw and dash.

  • recordingId:  uint

    Id of the parent recording.

VideoManifestResolution

A resoloution available for a video manifest.

  • name:  string

    The name of the resolution.

  • slug:  string

    The slug of the resolution.

  • width:  uint?

    The width of the stream, only set if hasVideo is true.

  • height:  uint?

    The height of the stream, only set if hasVideo is true.

  • hasVideo:  boolean

    Indicates whether the manifest includes video.

  • bitrate:  uint

    The total bitrate.

VideoSettings

Video settings linked to a user's channel

  • isLightstreamEnabled:  boolean

    Indicates whether the user has enabled Lightstream studio integration

ViewerAnalytic extends ChannelAnalytic

A channel metric, which contains the number of anonymous and authenticated Mixer users at a point in time.

  • anon:  uint

    Number of anonymous viewers watching the channel at a point in time.

  • authed:  uint

    Number of authenticated viewers, including lurkers, watching the channel at a point in time.

ViewerCount

A channel metric showing how many viewers and of what type were watching the channel at a set point in time.

  • time:  IsoDate

    The time of the sample.

  • anon:  uint

    Amount of anonymous viewers.

  • authed:  uint

    Amount registered viewers.

ViewerMetricAnalytic extends ChannelAnalytic

A channel metric showing details about a viewer on a channel.

  • country:  string?

    The viewer's two character country code, if it can be determined.

  • browser:  string (chr,ff,ie,ios,sf,an)?

    The viewer's browser, if it can be determined.

  • platform:  string (desktop,tablet,mobile)?

    The viewer's platform, if it can be determined.

ViewerSessionCountAnalytic extends ChannelAnalytic

A metric showing the number of viewers in a period on a channel.

  • count:  uint

    Number of viewers in the period.

Webhook

A registered webhook. For more information about webhooks, see aka.ms/mixrpokr.

  • id:  UUID

    The ID of the webhook.

  • kind:  string (web)

    The kind of hook this is, always set to "web" currently.

  • events:  Array<string>

    A list of events the webhook is subscribe to.

  • isActive:  boolean

    Whether the webhook is currently active.

  • url:  string

    The URL this webhook will send data to.

  • expiresAt:  IsoDate

    THe date the webhook will expire if not renewed using POST /hooks/{hookId}/renew.

  • renewUrl:  string

    The URL to hit to renew the webhook.

  • deactivationReason:  object?

    If the webhook was deactivation, the deactivationReason will be present and explain why.

    • code:  uint (0,1,2)

      Machine-readable reason this hook was deactivated.

      • 0 if it was deactivated by a manual call to the deactivate endpoint
      • 1 if it was deactivated because it was subscribed to an event which will fire at most one time, ever, and has now done so.
      • 2 if it was deactivated because the remote website repeatedly failed when we tried to send events to it.
    • reason:  string

      Human-readable reason describing why the webhook was deactivated.

XblFriendsResponse

Response data for call to get Xbox Live friends

  • userId:  uint

    Unique user id

  • username:  string

    Username of user

  • avatarUrl:  string

    Link to the avatar of user

  • level:  uint

    Mixer level of user

  • channelId:  uint

    Mixer channel id

  • online:  boolean

    Indicates whether the user is online

uint

Unsigned integer.