# Twitch Directory API Reference Canonical: https://monsterapi.co/docs/api/twitch-directory Read the Twitch Directory 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: Featured streams `GET /twitch/api/featured` Documentation: https://monsterapi.co/docs/api/twitch#featured-streams Operation ID: `twitch_featured_streams` Returns the broadcasts Twitch promotes on its front page for a language; defaults to English. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `language` (query, optional): Optional language for featured broadcasts as a two-letter ISO 639-1 code. Defaults to `en` (English). ## Responses - 200: Promoted broadcasts - 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 result lists are 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/featured' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Category details `GET /twitch/api/game/{name}` Documentation: https://monsterapi.co/docs/api/twitch#category-details Operation ID: `twitch_category_details` Returns one category by its directory slug. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `name` (path, required): Required category slug: 1 to 100 ASCII letters, digits, underscores or hyphens. Use `categories[].slug` from [GET /twitch/api/games](https://monsterapi.co/docs/api/twitch-directory#all-categories) or `categories.items[].slug` from [GET /twitch/api/search](https://monsterapi.co/docs/api/twitch-directory#search-channels-categories-and-recordings). ## Responses - 200: Category details - 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/game/{name}' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Live streams of a category `GET /twitch/api/game/{name}/streams` Documentation: https://monsterapi.co/docs/api/twitch#live-streams-of-a-category Operation ID: `twitch_game_streams` Returns one page of broadcasts airing in a category, optionally filtered by language. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `name` (path, required): Required category slug: 1 to 100 ASCII letters, digits, underscores or hyphens. Use `categories[].slug` from [GET /twitch/api/games](https://monsterapi.co/docs/api/twitch-directory#all-categories) or `categories.items[].slug` from [GET /twitch/api/search](https://monsterapi.co/docs/api/twitch-directory#search-channels-categories-and-recordings). - `sort` (query, optional): Sort order. Defaults to `viewer_count`, with the most watched first. - `language` (query, optional): Optional broadcast language as a two-letter ISO 639-1 code. Omit to apply no language filter. - `limit` (query, optional): Requested page size, from 1 to 100. Defaults to 100. - `cursor` (query, optional): Use `next_cursor` from the preceding response of [GET /twitch/api/game/{name}/streams](https://monsterapi.co/docs/api/twitch-directory#live-streams-of-a-category). Pass unchanged as `cursor`, keeping the same path and filters; omit for the first page. ## Responses - 200: Page of broadcasts - 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/game/{name}/streams' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Recordings of a category `GET /twitch/api/game/{name}/videos` Documentation: https://monsterapi.co/docs/api/twitch#recordings-of-a-category Operation ID: `twitch_game_videos` Returns one page of recordings in a category, ordered by views or time. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `name` (path, required): Required category slug: 1 to 100 ASCII letters, digits, underscores or hyphens. Use `categories[].slug` from [GET /twitch/api/games](https://monsterapi.co/docs/api/twitch-directory#all-categories) or `categories.items[].slug` from [GET /twitch/api/search](https://monsterapi.co/docs/api/twitch-directory#search-channels-categories-and-recordings). - `sort` (query, optional): Sort order. Defaults to `time`, with newest recordings first. - `limit` (query, optional): Requested page size, from 1 to 100. Defaults to 100. - `cursor` (query, optional): Use `next_cursor` from the preceding response of [GET /twitch/api/game/{name}/videos](https://monsterapi.co/docs/api/twitch-directory#recordings-of-a-category). Pass unchanged as `cursor`, keeping the same path and filters; omit for the first page. ## Responses - 200: Page of recordings - 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/game/{name}/videos' \ -H 'Authorization: Bearer ' ``` --- # Twitch: All categories `GET /twitch/api/games` Documentation: https://monsterapi.co/docs/api/twitch#all-categories Operation ID: `twitch_categories_list` Returns one page of Twitch categories, ordered by viewers or relevance. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `sort` (query, optional): Sort order. Defaults to `viewer_count`, with the most watched first. - `limit` (query, optional): Requested page size, from 1 to 100. Defaults to 100. - `cursor` (query, optional): Use `next_cursor` from the preceding response of [GET /twitch/api/games](https://monsterapi.co/docs/api/twitch-directory#all-categories). Pass unchanged as `cursor`, keeping the same path and filters; omit for the first page. ## Responses - 200: Page of categories - 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/games' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Search channels, categories and recordings `GET /twitch/api/search` Documentation: https://monsterapi.co/docs/api/twitch#search-channels-categories-and-recordings Operation ID: `twitch_search_all` Searches channels, categories and recordings for one term, including related live broadcasts. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `q` (query, required): Required search text with at least one non-whitespace character. Surrounding spaces are preserved. ## Responses - 200: Matches by kind - 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 result lists are 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/search' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Search categories `GET /twitch/api/search/categories` Documentation: https://monsterapi.co/docs/api/twitch#search-categories Operation ID: `twitch_search_categories` Returns one page of categories matching a search term. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `q` (query, required): Required search text with at least one non-whitespace character. Surrounding spaces are preserved. - `cursor` (query, optional): Use `next_cursor` from the preceding response of [GET /twitch/api/search/categories](https://monsterapi.co/docs/api/twitch-directory#search-categories). Pass unchanged as `cursor`, keeping the same path and filters; omit for the first page. ## Responses - 200: Page of categories - 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/search/categories' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Search live streams `GET /twitch/api/search/streams` Documentation: https://monsterapi.co/docs/api/twitch#search-live-streams Operation ID: `twitch_search_streams` Returns live broadcasts matching a search term. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `q` (query, required): Required search text with at least one non-whitespace character. Surrounding spaces are preserved. ## Responses - 200: Matching broadcasts - 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 result lists are 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/search/streams' \ -H 'Authorization: Bearer ' ``` --- # Twitch: Popular live streams `GET /twitch/api/streams` Documentation: https://monsterapi.co/docs/api/twitch#popular-live-streams Operation ID: `twitch_popular_streams` Returns one page of broadcasts across Twitch, optionally filtered by language. Allows at most 30 entries per page. ## Authentication Send your billing API key in the `Authorization: Bearer ` header. Your account login is separate. ## Inputs - `sort` (query, optional): Sort order. Defaults to `viewer_count`, with the most watched first. - `language` (query, optional): Optional broadcast language as a two-letter ISO 639-1 code. Omit to apply no language filter. - `limit` (query, optional): Requested page size, from 1 to 30. Defaults to 30. - `cursor` (query, optional): Use `next_cursor` from the preceding response of [GET /twitch/api/streams](https://monsterapi.co/docs/api/twitch-directory#popular-live-streams). Pass unchanged as `cursor`, keeping the same path and filters; omit for the first page. ## Responses - 200: Page of broadcasts - 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/streams' \ -H 'Authorization: Bearer ' ```