# Twitch Channel API Reference Canonical: https://monsterapi.co/docs/api/twitch-channel Read the Twitch Channel reference. Review parameters, response fields, examples, and current credit prices. OpenAPI specification: [Twitch](https://monsterapi.co/docs/openapi/platforms/twitch.yaml). --- Current operation prices: [public catalog](https://monsterapi.co/account/api/v1/public/api-prices). Prices use credits per request. --- # Twitch: Channel profile `GET /twitch/api/channel/{login}` Documentation: https://monsterapi.co/docs/api/twitch#channel-profile Operation ID: `twitch_channel_profile` Returns the profile of one channel by its account name, together with the broadcast it is airing. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `login` (path, required): Required account username: 1 to 25 ASCII letters, digits or underscores. Use `users[].username` from [GET /twitch/api/users](https://monsterapi.co/docs/api/twitch-channel#accounts-by-identifier). ## Responses - 200: Channel profile - 400: bad_request: a path or query parameter has the wrong format or value Refused at the gateway: the request target, path and query string together, is longer than 8,192 bytes; or the headers, the target counted among them, exceed 16,384 bytes or 64 fields - 401: Refusal envelope Refused at the gateway: the `Authorization` header carries no API key, or a malformed one - 402: Refusal envelope Refused at the gateway: the credits of the account do not cover the price of the operation - 403: Refusal envelope Refused at the gateway: the API key is unknown or revoked - 404: not_found: requested resource does not exist or is unavailable - 405: `method_not_allowed`: the endpoint answers GET alone, and any other method, HEAD included, is refused Refused at the gateway: the path exists, but no operation on it takes the method of the request, HEAD included; `Allow` names the methods that do - 409: Refusal envelope Refused at the gateway: a repeat of a request the gateway already checked differs from the original - 429: Refusal envelope Refused at the gateway: the account calls faster than its rate limit allows - 500: upstream_shape: unexpected response; this does not indicate the end of a listing - 501: requires_auth: requested information is unavailable to anonymous viewers - 503: rate_limited or upstream_error: retry after Retry-After; upstream_stale or no_proxies: service temporarily unavailable; overloaded: capacity temporarily unavailable Refused at the gateway: the check could not complete, the account is suspended, or the platform did not answer; each may pass later, and `Retry-After` comes only when the platform did not answer - default: Refusal envelope ## Credits Check the live price in the documentation before sending. Platform 2xx and 4xx responses can use credits, including empty data. Gateway refusals and 5xx responses do not use credits. Each pagination request is a separate call. https://monsterapi.co/docs/pricing ## Request template Replace path placeholders and add the required query parameters from the Inputs section before sending. ```shell curl --get 'https://api.monsterapi.co/twitch/api/channel/{login}' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Sponsored-content flag `GET /twitch/api/channel/{login}/branded` Documentation: https://monsterapi.co/docs/api/twitch#sponsored-content-flag Operation ID: `twitch_channel_branded` Reports whether the channel declares the broadcast it is airing as sponsored. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `login` (path, required): Required account username: 1 to 25 ASCII letters, digits or underscores. Use `users[].username` from [GET /twitch/api/users](https://monsterapi.co/docs/api/twitch-channel#accounts-by-identifier). ## Responses - 200: Sponsorship flag - 400: bad_request: a path or query parameter has the wrong format or value Refused at the gateway: the request target, path and query string together, is longer than 8,192 bytes; or the headers, the target counted among them, exceed 16,384 bytes or 64 fields - 401: Refusal envelope Refused at the gateway: the `Authorization` header carries no API key, or a malformed one - 402: Refusal envelope Refused at the gateway: the credits of the account do not cover the price of the operation - 403: Refusal envelope Refused at the gateway: the API key is unknown or revoked - 404: not_found: requested resource does not exist or is unavailable - 405: `method_not_allowed`: the endpoint answers GET alone, and any other method, HEAD included, is refused Refused at the gateway: the path exists, but no operation on it takes the method of the request, HEAD included; `Allow` names the methods that do - 409: Refusal envelope Refused at the gateway: a repeat of a request the gateway already checked differs from the original - 429: Refusal envelope Refused at the gateway: the account calls faster than its rate limit allows - 500: upstream_shape: unexpected response; this does not indicate the end of a listing - 501: requires_auth: requested information is unavailable to anonymous viewers - 503: rate_limited or upstream_error: retry after Retry-After; upstream_stale or no_proxies: service temporarily unavailable; overloaded: capacity temporarily unavailable Refused at the gateway: the check could not complete, the account is suspended, or the platform did not answer; each may pass later, and `Retry-After` comes only when the platform did not answer - default: Refusal envelope ## Credits Check the live price in the documentation before sending. Platform 2xx and 4xx responses can use credits, including empty data. Gateway refusals and 5xx responses do not use credits. Each pagination request is a separate call. https://monsterapi.co/docs/pricing ## Request template Replace path placeholders and add the required query parameters from the Inputs section before sending. ```shell curl --get 'https://api.monsterapi.co/twitch/api/channel/{login}/branded' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Moderator roster `GET /twitch/api/channel/{login}/mods` Documentation: https://monsterapi.co/docs/api/twitch#moderator-roster Operation ID: `twitch_channel_moderators` Returns one page of moderators when Twitch discloses it. A roster withheld from guests returns requires_auth (501). ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `login` (path, required): Required account username: 1 to 25 ASCII letters, digits or underscores. Use `users[].username` from [GET /twitch/api/users](https://monsterapi.co/docs/api/twitch-channel#accounts-by-identifier). - `cursor` (query, optional): Continuation from `next_cursor` in the preceding response of the same GET path; omit for the first page. Use [GET /twitch/api/channel/{login}/mods](https://monsterapi.co/docs/api/twitch-channel#moderator-roster), [GET /twitch/api/channel/{login}/vips](https://monsterapi.co/docs/api/twitch-channel#vip-roster) or [GET /twitch/api/team/{name}](https://monsterapi.co/docs/api/twitch-channel#twitch-team); keep the same channel or team. ## Responses - 200: Moderator roster - 400: bad_request: a parameter or continuation cursor has the wrong format or value Refused at the gateway: the request target, path and query string together, is longer than 8,192 bytes; or the headers, the target counted among them, exceed 16,384 bytes or 64 fields - 401: Refusal envelope Refused at the gateway: the `Authorization` header carries no API key, or a malformed one - 402: Refusal envelope Refused at the gateway: the credits of the account do not cover the price of the operation - 403: Refusal envelope Refused at the gateway: the API key is unknown or revoked - 404: not_found: resource absent, or no records and no next_cursor; an empty page with next_cursor returns 200 - 405: `method_not_allowed`: the endpoint answers GET alone, and any other method, HEAD included, is refused Refused at the gateway: the path exists, but no operation on it takes the method of the request, HEAD included; `Allow` names the methods that do - 409: Refusal envelope Refused at the gateway: a repeat of a request the gateway already checked differs from the original - 429: Refusal envelope Refused at the gateway: the account calls faster than its rate limit allows - 500: upstream_shape: unexpected response; this does not indicate the end of a listing - 501: requires_auth: requested information is unavailable to anonymous viewers - 503: rate_limited or upstream_error: retry after Retry-After; upstream_stale or no_proxies: service temporarily unavailable; overloaded: capacity temporarily unavailable Refused at the gateway: the check could not complete, the account is suspended, or the platform did not answer; each may pass later, and `Retry-After` comes only when the platform did not answer - default: Refusal envelope ## Credits Check the live price in the documentation before sending. Platform 2xx and 4xx responses can use credits, including empty data. Gateway refusals and 5xx responses do not use credits. Each pagination request is a separate call. https://monsterapi.co/docs/pricing ## Request template Replace path placeholders and add the required query parameters from the Inputs section before sending. ```shell curl --get 'https://api.monsterapi.co/twitch/api/channel/{login}/mods' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Channel info panels `GET /twitch/api/channel/{login}/panels` Documentation: https://monsterapi.co/docs/api/twitch#channel-info-panels Operation ID: `twitch_channel_panels` Returns the information panels a channel shows under its player. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `login` (path, required): Required account username: 1 to 25 ASCII letters, digits or underscores. Use `users[].username` from [GET /twitch/api/users](https://monsterapi.co/docs/api/twitch-channel#accounts-by-identifier). ## Responses - 200: Information panels - 400: bad_request: a path or query parameter has the wrong format or value Refused at the gateway: the request target, path and query string together, is longer than 8,192 bytes; or the headers, the target counted among them, exceed 16,384 bytes or 64 fields - 401: Refusal envelope Refused at the gateway: the `Authorization` header carries no API key, or a malformed one - 402: Refusal envelope Refused at the gateway: the credits of the account do not cover the price of the operation - 403: Refusal envelope Refused at the gateway: the API key is unknown or revoked - 404: not_found: resource absent or the requested list is empty - 405: `method_not_allowed`: the endpoint answers GET alone, and any other method, HEAD included, is refused Refused at the gateway: the path exists, but no operation on it takes the method of the request, HEAD included; `Allow` names the methods that do - 409: Refusal envelope Refused at the gateway: a repeat of a request the gateway already checked differs from the original - 429: Refusal envelope Refused at the gateway: the account calls faster than its rate limit allows - 500: upstream_shape: unexpected response; this does not indicate the end of a listing - 501: requires_auth: requested information is unavailable to anonymous viewers - 503: rate_limited or upstream_error: retry after Retry-After; upstream_stale or no_proxies: service temporarily unavailable; overloaded: capacity temporarily unavailable Refused at the gateway: the check could not complete, the account is suspended, or the platform did not answer; each may pass later, and `Retry-After` comes only when the platform did not answer - default: Refusal envelope ## Credits Check the live price in the documentation before sending. Platform 2xx and 4xx responses can use credits, including empty data. Gateway refusals and 5xx responses do not use credits. Each pagination request is a separate call. https://monsterapi.co/docs/pricing ## Request template Replace path placeholders and add the required query parameters from the Inputs section before sending. ```shell curl --get 'https://api.monsterapi.co/twitch/api/channel/{login}/panels' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Recommended channels `GET /twitch/api/channel/{login}/recommended` Documentation: https://monsterapi.co/docs/api/twitch#recommended-channels Operation ID: `twitch_channel_recommended` Returns the channels one channel recommends on its page, and the team it belongs to. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `login` (path, required): Required account username: 1 to 25 ASCII letters, digits or underscores. Use `users[].username` from [GET /twitch/api/users](https://monsterapi.co/docs/api/twitch-channel#accounts-by-identifier). ## Responses - 200: Recommended channels - 400: bad_request: a path or query parameter has the wrong format or value Refused at the gateway: the request target, path and query string together, is longer than 8,192 bytes; or the headers, the target counted among them, exceed 16,384 bytes or 64 fields - 401: Refusal envelope Refused at the gateway: the `Authorization` header carries no API key, or a malformed one - 402: Refusal envelope Refused at the gateway: the credits of the account do not cover the price of the operation - 403: Refusal envelope Refused at the gateway: the API key is unknown or revoked - 404: not_found: resource absent or the requested list is empty - 405: `method_not_allowed`: the endpoint answers GET alone, and any other method, HEAD included, is refused Refused at the gateway: the path exists, but no operation on it takes the method of the request, HEAD included; `Allow` names the methods that do - 409: Refusal envelope Refused at the gateway: a repeat of a request the gateway already checked differs from the original - 429: Refusal envelope Refused at the gateway: the account calls faster than its rate limit allows - 500: upstream_shape: unexpected response; this does not indicate the end of a listing - 501: requires_auth: requested information is unavailable to anonymous viewers - 503: rate_limited or upstream_error: retry after Retry-After; upstream_stale or no_proxies: service temporarily unavailable; overloaded: capacity temporarily unavailable Refused at the gateway: the check could not complete, the account is suspended, or the platform did not answer; each may pass later, and `Retry-After` comes only when the platform did not answer - default: Refusal envelope ## Credits Check the live price in the documentation before sending. Platform 2xx and 4xx responses can use credits, including empty data. Gateway refusals and 5xx responses do not use credits. Each pagination request is a separate call. https://monsterapi.co/docs/pricing ## Request template Replace path placeholders and add the required query parameters from the Inputs section before sending. ```shell curl --get 'https://api.monsterapi.co/twitch/api/channel/{login}/recommended' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Stream schedule `GET /twitch/api/channel/{login}/schedule` Documentation: https://monsterapi.co/docs/api/twitch#stream-schedule Operation ID: `twitch_channel_schedule` Returns the schedule a channel published, with the entry it is airing now and the one it aired last. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `login` (path, required): Required account username: 1 to 25 ASCII letters, digits or underscores. Use `users[].username` from [GET /twitch/api/users](https://monsterapi.co/docs/api/twitch-channel#accounts-by-identifier). ## Responses - 200: Published schedule - 400: bad_request: a path or query parameter has the wrong format or value Refused at the gateway: the request target, path and query string together, is longer than 8,192 bytes; or the headers, the target counted among them, exceed 16,384 bytes or 64 fields - 401: Refusal envelope Refused at the gateway: the `Authorization` header carries no API key, or a malformed one - 402: Refusal envelope Refused at the gateway: the credits of the account do not cover the price of the operation - 403: Refusal envelope Refused at the gateway: the API key is unknown or revoked - 404: not_found: requested resource does not exist or is unavailable - 405: `method_not_allowed`: the endpoint answers GET alone, and any other method, HEAD included, is refused Refused at the gateway: the path exists, but no operation on it takes the method of the request, HEAD included; `Allow` names the methods that do - 409: Refusal envelope Refused at the gateway: a repeat of a request the gateway already checked differs from the original - 429: Refusal envelope Refused at the gateway: the account calls faster than its rate limit allows - 500: upstream_shape: unexpected response; this does not indicate the end of a listing - 501: requires_auth: requested information is unavailable to anonymous viewers - 503: rate_limited or upstream_error: retry after Retry-After; upstream_stale or no_proxies: service temporarily unavailable; overloaded: capacity temporarily unavailable Refused at the gateway: the check could not complete, the account is suspended, or the platform did not answer; each may pass later, and `Retry-After` comes only when the platform did not answer - default: Refusal envelope ## Credits Check the live price in the documentation before sending. Platform 2xx and 4xx responses can use credits, including empty data. Gateway refusals and 5xx responses do not use credits. Each pagination request is a separate call. https://monsterapi.co/docs/pricing ## Request template Replace path placeholders and add the required query parameters from the Inputs section before sending. ```shell curl --get 'https://api.monsterapi.co/twitch/api/channel/{login}/schedule' \ -H 'Authorization: Bearer ' ``` --- # Twitch: VIP roster `GET /twitch/api/channel/{login}/vips` Documentation: https://monsterapi.co/docs/api/twitch#vip-roster Operation ID: `twitch_channel_vips` Returns one page of VIPs of one channel, with Twitch's continuation cursor when available. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `login` (path, required): Required account username: 1 to 25 ASCII letters, digits or underscores. Use `users[].username` from [GET /twitch/api/users](https://monsterapi.co/docs/api/twitch-channel#accounts-by-identifier). - `cursor` (query, optional): Continuation from `next_cursor` in the preceding response of the same GET path; omit for the first page. Use [GET /twitch/api/channel/{login}/mods](https://monsterapi.co/docs/api/twitch-channel#moderator-roster), [GET /twitch/api/channel/{login}/vips](https://monsterapi.co/docs/api/twitch-channel#vip-roster) or [GET /twitch/api/team/{name}](https://monsterapi.co/docs/api/twitch-channel#twitch-team); keep the same channel or team. ## Responses - 200: VIP roster - 400: bad_request: a parameter or continuation cursor has the wrong format or value Refused at the gateway: the request target, path and query string together, is longer than 8,192 bytes; or the headers, the target counted among them, exceed 16,384 bytes or 64 fields - 401: Refusal envelope Refused at the gateway: the `Authorization` header carries no API key, or a malformed one - 402: Refusal envelope Refused at the gateway: the credits of the account do not cover the price of the operation - 403: Refusal envelope Refused at the gateway: the API key is unknown or revoked - 404: not_found: resource absent, or no records and no next_cursor; an empty page with next_cursor returns 200 - 405: `method_not_allowed`: the endpoint answers GET alone, and any other method, HEAD included, is refused Refused at the gateway: the path exists, but no operation on it takes the method of the request, HEAD included; `Allow` names the methods that do - 409: Refusal envelope Refused at the gateway: a repeat of a request the gateway already checked differs from the original - 429: Refusal envelope Refused at the gateway: the account calls faster than its rate limit allows - 500: upstream_shape: unexpected response; this does not indicate the end of a listing - 501: requires_auth: requested information is unavailable to anonymous viewers - 503: rate_limited or upstream_error: retry after Retry-After; upstream_stale or no_proxies: service temporarily unavailable; overloaded: capacity temporarily unavailable Refused at the gateway: the check could not complete, the account is suspended, or the platform did not answer; each may pass later, and `Retry-After` comes only when the platform did not answer - default: Refusal envelope ## Credits Check the live price in the documentation before sending. Platform 2xx and 4xx responses can use credits, including empty data. Gateway refusals and 5xx responses do not use credits. Each pagination request is a separate call. https://monsterapi.co/docs/pricing ## Request template Replace path placeholders and add the required query parameters from the Inputs section before sending. ```shell curl --get 'https://api.monsterapi.co/twitch/api/channel/{login}/vips' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Team `GET /twitch/api/team/{name}` Documentation: https://monsterapi.co/docs/api/twitch#twitch-team Operation ID: `twitch_team_details` Returns one Twitch team by its slug and one page of its members, with Twitch's continuation cursor when available. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `name` (path, required): Required team slug: 1 to 100 ASCII letters, digits, underscores or hyphens. Use `team.slug` from [GET /twitch/api/channel/{login}/recommended](https://monsterapi.co/docs/api/twitch-channel#recommended-channels). - `cursor` (query, optional): Continuation from `next_cursor` in the preceding response of the same GET path; omit for the first page. Use [GET /twitch/api/channel/{login}/mods](https://monsterapi.co/docs/api/twitch-channel#moderator-roster), [GET /twitch/api/channel/{login}/vips](https://monsterapi.co/docs/api/twitch-channel#vip-roster) or [GET /twitch/api/team/{name}](https://monsterapi.co/docs/api/twitch-channel#twitch-team); keep the same channel or team. ## Responses - 200: Team and its members - 400: bad_request: a parameter or continuation cursor has the wrong format or value Refused at the gateway: the request target, path and query string together, is longer than 8,192 bytes; or the headers, the target counted among them, exceed 16,384 bytes or 64 fields - 401: Refusal envelope Refused at the gateway: the `Authorization` header carries no API key, or a malformed one - 402: Refusal envelope Refused at the gateway: the credits of the account do not cover the price of the operation - 403: Refusal envelope Refused at the gateway: the API key is unknown or revoked - 404: not_found: resource absent, or no records and no next_cursor; an empty page with next_cursor returns 200 - 405: `method_not_allowed`: the endpoint answers GET alone, and any other method, HEAD included, is refused Refused at the gateway: the path exists, but no operation on it takes the method of the request, HEAD included; `Allow` names the methods that do - 409: Refusal envelope Refused at the gateway: a repeat of a request the gateway already checked differs from the original - 429: Refusal envelope Refused at the gateway: the account calls faster than its rate limit allows - 500: upstream_shape: unexpected response; this does not indicate the end of a listing - 501: requires_auth: requested information is unavailable to anonymous viewers - 503: rate_limited or upstream_error: retry after Retry-After; upstream_stale or no_proxies: service temporarily unavailable; overloaded: capacity temporarily unavailable Refused at the gateway: the check could not complete, the account is suspended, or the platform did not answer; each may pass later, and `Retry-After` comes only when the platform did not answer - default: Refusal envelope ## Credits Check the live price in the documentation before sending. Platform 2xx and 4xx responses can use credits, including empty data. Gateway refusals and 5xx responses do not use credits. Each pagination request is a separate call. https://monsterapi.co/docs/pricing ## Request template Replace path placeholders and add the required query parameters from the Inputs section before sending. ```shell curl --get 'https://api.monsterapi.co/twitch/api/team/{name}' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Accounts by identifier `GET /twitch/api/users` Documentation: https://monsterapi.co/docs/api/twitch#accounts-by-identifier Operation ID: `twitch_users_by_ids` Returns account profiles for the comma-separated numeric IDs in `ids`. Unknown IDs retain null positions; an all-unknown list returns not_found (404). ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `ids` (query, required): Numeric account identifiers, separated by commas. At most 100 in one call; no empty entries. Surrounding whitespace is ignored for each ID; order and duplicates are preserved. Use non-null `channel.id` from [GET /twitch/api/channel/{login}](https://monsterapi.co/docs/api/twitch-channel#channel-profile) or `users[].id` from [GET /twitch/api/users](https://monsterapi.co/docs/api/twitch-channel#accounts-by-identifier). ## Responses - 200: Resolved accounts - 400: bad_request: a path or query parameter has the wrong format or value Refused at the gateway: the request target, path and query string together, is longer than 8,192 bytes; or the headers, the target counted among them, exceed 16,384 bytes or 64 fields - 401: Refusal envelope Refused at the gateway: the `Authorization` header carries no API key, or a malformed one - 402: Refusal envelope Refused at the gateway: the credits of the account do not cover the price of the operation - 403: Refusal envelope Refused at the gateway: the API key is unknown or revoked - 404: not_found: empty result because all requested account identifiers are unknown; unknown accounts retain null slots beside known accounts in a 200 response - 405: `method_not_allowed`: the endpoint answers GET alone, and any other method, HEAD included, is refused Refused at the gateway: the path exists, but no operation on it takes the method of the request, HEAD included; `Allow` names the methods that do - 409: Refusal envelope Refused at the gateway: a repeat of a request the gateway already checked differs from the original - 429: Refusal envelope Refused at the gateway: the account calls faster than its rate limit allows - 500: upstream_shape: unexpected response; this does not indicate the end of a listing - 501: requires_auth: requested information is unavailable to anonymous viewers - 503: rate_limited or upstream_error: retry after Retry-After; upstream_stale or no_proxies: service temporarily unavailable; overloaded: capacity temporarily unavailable Refused at the gateway: the check could not complete, the account is suspended, or the platform did not answer; each may pass later, and `Retry-After` comes only when the platform did not answer - default: Refusal envelope ## Credits Check the live price in the documentation before sending. Platform 2xx and 4xx responses can use credits, including empty data. Gateway refusals and 5xx responses do not use credits. Each pagination request is a separate call. https://monsterapi.co/docs/pricing ## Request template Replace path placeholders and add the required query parameters from the Inputs section before sending. ```shell curl --get 'https://api.monsterapi.co/twitch/api/users' \ -H 'Authorization: Bearer ' ```