このエンドポイントが役立つこと
レスポンスには、一致する 検索、公開されているコンテキスト、さらに結果がある場合のページネーションデータが含まれます。
使用に適した場面
オブジェクトの正確な ID がわからず、まず関連する候補を見つける必要がある場合に「検索クエリによるゲーム」を使用します。
このエンドポイントの機能
この API メソッドで構築できるもの
まず結果と一般的なワークフローを確認し、次にパラメーターと動作するリクエスト例に進んでください。
主なユースケース
製品内の検索
顧客向けおよび社内の画面に、Twitch のデータ検索を追加します。
カタログの構築
クエリで候補を見つけ、関連するオブジェクトを保存して後でエンリッチします。
市場調査
トピック、クリエイター、競合の分析のために結果セットを収集します。
利用できるバージョン
レスポンスのバージョン
どちらのバージョンも同じタスクを解決し、同じパラメーターを受け付けます。切り替えを使ってレスポンス構造を比較し、クライアントが想定するバージョンを選んでください。
レスポンスのバージョン
V2
このページでバージョンを切り替えると、同じドキュメント URL でレスポンス構造を比較できます。
共通する点
認証、必須パラメーター、リクエストの形は V1 と V2 で同じです。実際には、エンドポイントのパスを組み立てるときとレスポンスを読み取るときにバージョンを選びます。
バージョン間で異なる点
主な違いはレスポンスのエンベロープです。新しい連携では V2 を使用し、既存のクライアント契約との互換性が必要な場合にのみ V1 を残してください。
使い方
メソッドの呼び出し方
どちらのバージョンでも、同じ API キーのヘッダーと同じクエリパラメーターを使用します。このドキュメントでは、まず共通のパラメーターを示し、次に各バージョンのパスとコードスニペットを示します。
入力パラメーター
共通パラメーター| パラメーター | 必須 | 型 | 例 | 説明 |
|---|---|---|---|---|
query |
はい | str |
gaming |
ユーザーが入力した検索クエリ。 |
cursor |
いいえ | str | None |
MTU= |
前のレスポンスで返された次のページのカーソル。最初のページでは省略します。 |
バージョン別のリクエストパス
V2エンドポイントの正確なパス、URL の例、コードスニペットをコピーするときにバージョンを選んでください。上のパラメーター一覧は変わりません。
GET /api/v2/twitch.tv/search/games-by-queryコード例
curl --request GET \
--url "https://www.scrapestorm.net/api/v2/twitch.tv/search/games-by-query" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'query=gaming' \
# Optional parameters:
# --data-urlencode 'cursor=MTU='from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v2/twitch.tv/search/games-by-query"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"query": "gaming",
}
# Optional parameters
# params["cursor"] = "MTU="
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/games-by-query";
const params = new URLSearchParams({
query: "gaming",
});
// Optional parameters
// params.set("cursor", "MTU=");
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: "gaming",
};
// Optional parameters
// params.cursor = "MTU=";
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" => "gaming",
];
// Optional parameters
// $query["cursor"] = "MTU=";
try {
$response = $client->request("GET", "/api/v2/twitch.tv/search/games-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/games-by-query"
params := url.Values{}
params.Set("query", "gaming")
// Optional parameters
// params.Set("cursor", "MTU=")
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)
}バージョン別のリクエストパス
V1エンドポイントの正確なパス、URL の例、コードスニペットをコピーするときにバージョンを選んでください。上のパラメーター一覧は変わりません。
GET /api/v1/twitch.tv/search/games-by-queryコード例
curl --request GET \
--url "https://www.scrapestorm.net/api/v1/twitch.tv/search/games-by-query" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'query=gaming' \
# Optional parameters:
# --data-urlencode 'cursor=MTU='from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v1/twitch.tv/search/games-by-query"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"query": "gaming",
}
# Optional parameters
# params["cursor"] = "MTU="
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/games-by-query";
const params = new URLSearchParams({
query: "gaming",
});
// Optional parameters
// params.set("cursor", "MTU=");
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: "gaming",
};
// Optional parameters
// params.cursor = "MTU=";
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" => "gaming",
];
// Optional parameters
// $query["cursor"] = "MTU=";
try {
$response = $client->request("GET", "/api/v1/twitch.tv/search/games-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/games-by-query"
params := url.Values{}
params.Set("query", "gaming")
// Optional parameters
// params.Set("cursor", "MTU=")
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)
}
レスポンス例
バージョン別のライブレスポンス
プレビューには主要なフィールドとコレクションの最初の要素が含まれているため、レスポンスの形をすばやく確認できます。バージョンを切り替えると JSON の形式が変わります。
このコンパクトな JSON の例は、V2 の直近の成功した検証実行から取得したものです。
{
"success": true,
"status": "ok",
"pagination": {
"cursor": "MTU=",
"has_more": true
},
"search_context": {
"query": "gaming"
},
"data": {
"games": {
"count": 15,
"items": [
{
"rank": 1,
"game_id": "32982",
"slug": "grand-theft-auto-v",
"name": "Grand Theft Auto V",
"display_name": "Grand Theft Auto V",
"box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/32982_IGDB-90x120.jpg",
"template_box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/32982_IGDB-{width}x{height}.jpg",
"viewer_count": 69271,
"tags": [
"FPS",
"Shooter",
{
"_more_items": 3
}
]
},
{
"rank": 2,
"game_id": "1820839024",
"slug": "meccha-chamereon",
"name": "MECCHA CHAMELEON",
"display_name": "MECCHA CHAMELEON",
"box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/1820839024_IGDB-90x120.jpg",
"template_box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/1820839024_IGDB-{width}x{height}.jpg",
"viewer_count": 8349,
"tags": [
"Indie Game",
"Stealth",
{
"_more_items": 2
}
]
},
{
"_more_items": 13
}
]
}
}
}このコンパクトな JSON の例は、V1 の直近の成功した検証実行から取得したものです。
{
"success": true,
"status": "ok",
"pagination": {
"cursor": "MTU=",
"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": "",
"edges": [],
"score": 0,
"totalMatches": 0,
"__typename": "SearchForResultUsers"
},
"games": {
"cursor": "MTU=",
"edges": [
{
"trackingID": "8d3f5b84-2690-4fed-baf6-2957fda1523e",
"item": "…",
"__typename": "SearchForEdge"
},
{
"trackingID": "9f702255-d968-4dae-942e-bb07bd1e0dab",
"item": "…",
"__typename": "SearchForEdge"
},
{
"_more_items": 13
}
],
"score": 0,
"totalMatches": 10000,
"__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": 117,
"operationName": "SearchResultsPage_SearchResults",
"requestID": "01KXY4PX73MCNZ91RCCBM6BQQJ"
}
}
}
次のステップ
評価を続ける
このドキュメントを最初の判断材料とし、継続的な利用のためにエンドポイントを接続する前に、料金、プラットフォームのカバー範囲、連携ルールを確認してください。
よくある質問
チームが実装前に尋ねる質問
これらの回答を参考に、この API メソッドがワークフロー、バージョンの選択、導入計画に合うかどうかを判断してください。
この Twitch API メソッドはどのようなデータを返しますか？
このメソッドは 検索 に対して「検索クエリによるゲーム」を実行します。以下のコンパクトなレスポンス例で、フィールドの正確な構造を確認できます。
V1 と V2 のどちらを選ぶべきですか？
新しい連携では、正規化された構造を提供する V2 を選んでください。V1 は、既にプラットフォーム固有の形式を処理しているクライアントとの互換性のためにのみ使用してください。
最初のリクエストには何が必要ですか？
API キーを作成し、リクエストヘッダーで送信し、表の必須パラメーターを指定してください。コード例には、正しいパスとリクエスト構造が既に含まれています。