Discover Search data on Twitch from a user query and connect the results to search, catalog, or research interfaces.
Use “Live channels by query” when an exact object ID is not known and relevant candidates must be found first.
Review the result and common workflows first, then move to parameters and a working request example.
The response includes matching Search, public context, and pagination data when more results are available.
Use “Live channels by query” when an exact object ID is not known and relevant candidates must be found first.
Add Twitch data search to customer-facing and internal interfaces.
Find candidates by query and save relevant objects for later enrichment.
Collect result sets for topic, creator, and competitive analysis.
Both versions solve the same job and accept the same parameters. Use the switch to compare the response structure and choose the version your client expects.
Switch versions on this page to compare response structures while keeping the same documentation URL.
Authentication, required parameters, and the request shape stay the same across V1 and V2. In practice, you choose the version when you build the endpoint path and when you parse the response.
The main difference is the response envelope. Use V2 for new integrations and keep V1 only when you need compatibility with an existing client contract.
Use the same API key header and the same query parameters for both versions. This documentation shows the shared parameter set first, then version-specific endpoint paths and code snippets.
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
query |
Yes | str |
value |
User-entered search query. |
cursor |
No | str | None |
QVFB... |
Next-page cursor returned by the previous response. Omit it for the first page. |
Choose a version when you copy the exact endpoint path, example URL, and code snippet. The parameter list above stays the same.
GET /api/v2/twitch.tv/search/live-channels-by-querycurl --request GET \
--url "https://www.scrapestorm.net/api/v2/twitch.tv/search/live-channels-by-query" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'query=value' \
# Optional parameters:
# --data-urlencode 'cursor=QVFB...'from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v2/twitch.tv/search/live-channels-by-query"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"query": "value",
}
# Optional parameters
# params["cursor"] = "QVFB..."
with requests.Session() as session:
response = session.request(
method="GET",
url=urljoin(BASE_URL, ENDPOINT),
headers=HEADERS,
params=params,
timeout=30,
)
response.raise_for_status()
payload = response.json()
print(payload)const BASE_URL = "https://www.scrapestorm.net";
const endpoint = "/api/v2/twitch.tv/search/live-channels-by-query";
const params = new URLSearchParams({
query: "value",
});
// Optional parameters
// params.set("cursor", "QVFB...");
const response = await fetch(`${BASE_URL}${endpoint}?${params.toString()}`, {
method: "GET",
headers: {
Accept: "application/json",
"X-API-Key": "00000000-0000-4000-8000-000000000000",
},
});
if (!response.ok) {
throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}
const payload = await response.json();
console.log(payload);import axios from "axios";
const client = axios.create({
baseURL: "https://www.scrapestorm.net",
timeout: 30000,
headers: {
Accept: "application/json",
"X-API-Key": "00000000-0000-4000-8000-000000000000",
},
});
const params = {
query: "value",
};
// Optional parameters
// params.cursor = "QVFB...";
const { data: payload } = await client.request({
method: "GET",
url: endpoint,
params,
});
console.log(payload);<?php
declare(strict_types=1);
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
$client = new Client([
'base_uri' => "https://www.scrapestorm.net",
'timeout' => 30.0,
'headers' => [
'Accept' => 'application/json',
'X-API-Key' => "00000000-0000-4000-8000-000000000000",
],
]);
$query = [
"query" => "value",
];
// Optional parameters
// $query["cursor"] = "QVFB...";
try {
$response = $client->request("GET", "/api/v2/twitch.tv/search/live-channels-by-query", [
'query' => $query,
]);
$payload = json_decode(
(string) $response->getBody(),
true,
512,
JSON_THROW_ON_ERROR
);
var_dump($payload);
} catch (GuzzleException $e) {
throw $e;
}package main
import (
"encoding/json"
"fmt"
"net/http"
"net/url"
"time"
)
func main() {
baseURL := "https://www.scrapestorm.net"
endpoint := "/api/v2/twitch.tv/search/live-channels-by-query"
params := url.Values{}
params.Set("query", "value")
// Optional parameters
// params.Set("cursor", "QVFB...")
req, err := http.NewRequest(
"GET",
fmt.Sprintf("%s%s?%s", baseURL, endpoint, params.Encode()),
nil,
)
if err != nil {
panic(err)
}
req.Header.Set("Accept", "application/json")
req.Header.Set("X-API-Key", "00000000-0000-4000-8000-000000000000")
client := &http.Client{Timeout: 30 * time.Second}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
var payload any
if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
panic(err)
}
fmt.Printf("%+v\n", payload)
}Choose a version when you copy the exact endpoint path, example URL, and code snippet. The parameter list above stays the same.
GET /api/v1/twitch.tv/search/live-channels-by-querycurl --request GET \
--url "https://www.scrapestorm.net/api/v1/twitch.tv/search/live-channels-by-query" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'query=value' \
# Optional parameters:
# --data-urlencode 'cursor=QVFB...'from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v1/twitch.tv/search/live-channels-by-query"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"query": "value",
}
# Optional parameters
# params["cursor"] = "QVFB..."
with requests.Session() as session:
response = session.request(
method="GET",
url=urljoin(BASE_URL, ENDPOINT),
headers=HEADERS,
params=params,
timeout=30,
)
response.raise_for_status()
payload = response.json()
print(payload)const BASE_URL = "https://www.scrapestorm.net";
const endpoint = "/api/v1/twitch.tv/search/live-channels-by-query";
const params = new URLSearchParams({
query: "value",
});
// Optional parameters
// params.set("cursor", "QVFB...");
const response = await fetch(`${BASE_URL}${endpoint}?${params.toString()}`, {
method: "GET",
headers: {
Accept: "application/json",
"X-API-Key": "00000000-0000-4000-8000-000000000000",
},
});
if (!response.ok) {
throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}
const payload = await response.json();
console.log(payload);import axios from "axios";
const client = axios.create({
baseURL: "https://www.scrapestorm.net",
timeout: 30000,
headers: {
Accept: "application/json",
"X-API-Key": "00000000-0000-4000-8000-000000000000",
},
});
const params = {
query: "value",
};
// Optional parameters
// params.cursor = "QVFB...";
const { data: payload } = await client.request({
method: "GET",
url: endpoint,
params,
});
console.log(payload);<?php
declare(strict_types=1);
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
$client = new Client([
'base_uri' => "https://www.scrapestorm.net",
'timeout' => 30.0,
'headers' => [
'Accept' => 'application/json',
'X-API-Key' => "00000000-0000-4000-8000-000000000000",
],
]);
$query = [
"query" => "value",
];
// Optional parameters
// $query["cursor"] = "QVFB...";
try {
$response = $client->request("GET", "/api/v1/twitch.tv/search/live-channels-by-query", [
'query' => $query,
]);
$payload = json_decode(
(string) $response->getBody(),
true,
512,
JSON_THROW_ON_ERROR
);
var_dump($payload);
} catch (GuzzleException $e) {
throw $e;
}package main
import (
"encoding/json"
"fmt"
"net/http"
"net/url"
"time"
)
func main() {
baseURL := "https://www.scrapestorm.net"
endpoint := "/api/v1/twitch.tv/search/live-channels-by-query"
params := url.Values{}
params.Set("query", "value")
// Optional parameters
// params.Set("cursor", "QVFB...")
req, err := http.NewRequest(
"GET",
fmt.Sprintf("%s%s?%s", baseURL, endpoint, params.Encode()),
nil,
)
if err != nil {
panic(err)
}
req.Header.Set("Accept", "application/json")
req.Header.Set("X-API-Key", "00000000-0000-4000-8000-000000000000")
client := &http.Client{Timeout: 30 * time.Second}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
var payload any
if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
panic(err)
}
fmt.Printf("%+v\n", payload)
}The preview keeps key fields and the first collection items so you can scan the response shape quickly. Switching versions changes the JSON format.
This compact JSON example comes from the latest successful verification run for V2.
{
"success": true,
"status": "ok",
"pagination": {
"cursor": "QVFB...",
"has_more": true
},
"search_context": {
"query": "gaming"
},
"data": {
"live_channels": {
"count": 15,
"items": [
{
"rank": 1,
"channel_url": "https://www.twitch.tv/zentreya",
"user_id": "128440061",
"username": "zentreya",
"display_name": "Zentreya",
"description": "【 VARIETY STREAMER VTUBER 】 【⚡ THE CYBER PUNK / ROCKIN RED DRAGON 🔥 】. I have an amazing community, stop by, say hi! Hope you enjoy watching and have fun! ( BUSINESS INQUIRES :…",
"hashtags": [],
"emails": [
"[email protected]",
"[email protected]"
],
"is_partner": true,
"is_live": true,
"follower_count": 612568,
"stream": {
"stream_id": "320448797530",
"type": "live",
"title": "NEW 3D UPDATES AND A COOL NEW OUTFIT + COLLAB DAY + NEW ZEN FIGURE DROP !ggd | !agentink !youtooz !nendo !spencers !senpai !v1tech !vite",
"game": {
"game_id": "789588840",
"slug": "funnel-runners",
"name": "Funnel Runners",
"display_name": "Funnel Runners"
},
"started_at": "2026-07-19T15:58:37.516727Z",
"viewer_count": 4914,
"preview_image_url": "https://example.com/image.jpg",
"vertical_preview_image_url": "https://example.com/image.jpg",
"template_preview_image_url": "https://example.com/image.jpg",
"width": 1920,
"height": 1080,
"tags": [
"English",
"ForkliftCertified",
{
"_more_items": 8
}
]
},
"latest_video": {
"video_id": "2823900103",
"title": "NEW 3D UPDATES AND A COOL NEW OUTFIT + COLLAB DAY + NEW ZEN FIGURE DROP !ggd | !agentink !youtooz !nendo !spencers !senpai !v1tech !vite",
"video_url": "https://www.twitch.tv/videos/2823900103",
"preview_thumbnail_url": "https://example.com/image.jpg",
"duration_seconds": 20040
},
"top_clip": {
"clip_id": "1186678872",
"slug": "RealHelpfulDeerNotLikeThis-gZwKslfacDFqbqep",
"title": "didyouseeit!",
"clip_url": "https://clips.twitch.tv/RealHelpfulDeerNotLikeThis-gZwKslfacDFqbqep",
"preview_thumbnail_url": "https://example.com/image.jpg",
"duration_seconds": 59
},
"avatar_url": "https://example.com/image.jpg"
},
{
"rank": 2,
"channel_url": "https://www.twitch.tv/controcalcio__",
"user_id": "541899730",
"username": "controcalcio__",
"display_name": "ControCalcio__",
"description": "Il Canale Twitch di Controcalcio! Tutti i giorni live dalle 16!",
"hashtags": [],
"emails": [],
"is_partner": true,
"is_live": true,
"follower_count": 144445,
"stream": {
"stream_id": "320561303771",
"type": "live",
"title": "REACTION INGHILTERRA FRANCIA! ATTENTION PLEASE! MBAPPE CAPOCANNONIERE? TANTE NOTIZIE DI MERCADU",
"game": {
"game_id": "518203",
"slug": "sports-1",
"name": "Sports",
"display_name": "Sports"
},
"started_at": "2026-07-19T17:30:34.719Z",
"viewer_count": 2762,
"preview_image_url": "https://example.com/image.jpg",
"vertical_preview_image_url": "https://example.com/image.jpg",
"template_preview_image_url": "https://example.com/image.jpg",
"width": 1920,
"height": 1080,
"tags": [
"Italiano",
"gaming",
{
"_more_items": 1
}
]
},
"latest_video": {
"video_id": "2823962078",
"title": "REACTION INGHILTERRA FRANCIA! ATTENTION PLEASE! MBAPPE CAPOCANNONIERE? TANTE NOTIZIE DI MERCADU",
"video_url": "https://www.twitch.tv/videos/2823962078",
"preview_thumbnail_url": "https://example.com/image.jpg",
"duration_seconds": 14523
},
"top_clip": {
"clip_id": "52102576",
"slug": "CorrectCourageousKoalaHeyGirl-lUz_1Inf513UJRP4",
"title": "Chirico sale in cattedra",
"clip_url": "https://clips.twitch.tv/CorrectCourageousKoalaHeyGirl-lUz_1Inf513UJRP4",
"preview_thumbnail_url": "https://example.com/image.jpg",
"duration_seconds": 30
},
"avatar_url": "https://example.com/image.jpg"
},
{
"_more_items": 13
}
]
}
}
}This compact JSON example comes from the latest successful verification run for V1.
{
"success": true,
"status": "ok",
"pagination": {
"cursor": "QVFB...",
"has_more": true
},
"search_context": {
"query": "gaming"
},
"data": {
"data": {
"searchFor": {
"banners": null,
"querySubstitution": {
"edges": [],
"__typename": "SearchForResultSubstitution"
},
"channels": {
"cursor": "",
"edges": [],
"score": 0,
"totalMatches": 0,
"__typename": "SearchForResultUsers"
},
"channelsWithTag": {
"cursor": "QVFB...",
"edges": [
{
"trackingID": "a973ce02-2fff-41b1-94b5-0e479c35c5de",
"item": "…",
"__typename": "SearchForEdge"
},
{
"trackingID": "76d25532-952e-4a1d-86ca-1930ad7a5d17",
"item": "…",
"__typename": "SearchForEdge"
},
{
"_more_items": 13
}
],
"score": 0,
"totalMatches": 15,
"__typename": "SearchForResultUsers"
},
"games": {
"cursor": "",
"edges": [],
"score": 0,
"totalMatches": 0,
"__typename": "SearchForResultGames"
},
"videos": {
"cursor": "",
"edges": [],
"score": 0,
"totalMatches": 0,
"__typename": "SearchForResultVideos"
},
"relatedLiveChannels": {
"edges": [],
"score": null,
"__typename": "SearchForResultRelatedLiveChannels"
},
"collections": {
"cursor": "",
"edges": [],
"score": 0,
"totalMatches": 0,
"__typename": "SearchForResultCollections"
},
"__typename": "SearchFor"
}
},
"extensions": {
"durationMilliseconds": 136,
"operationName": "SearchResultsPage_SearchResults",
"requestID": "01KXY4PY60MNX0KZ0FK36H97D2"
}
}
}Use this documentation as the first decision point, then move into pricing, platform coverage, and integration rules before you connect the endpoint for recurring use.
Use these answers to decide whether this API method fits your workflow, versioning choice, and rollout plan.
The method performs “Live channels by query” for Search. The compact response example below shows the exact field structure.
Choose V2 for new integrations because it provides a normalized structure. Use V1 only for compatibility with clients that already consume the platform-native format.
Create an API key, send it in the request header, and provide the required parameters from the table. The code samples already contain the correct path and request structure.