此端点可以帮助您
响应以规范化的 V2 格式或平台原生的 V1 格式提供可用的个人资料字段。
何时使用
当对象已知、您的产品需要其当前公开上下文时，请使用“按用户名获取直播状态”。
此端点的作用
利用此 API 方法可以构建什么
先查看结果和常见工作流，然后再了解参数和可运行的请求示例。
常见使用场景
记录补全
将公开的 Twitch 字段附加到已知的产品对象上。
数据验证
在后续处理之前验证标识符和当前的公开上下文。
分析准备
将对象详情用作报告、评分和相关请求的输入。
可用版本
响应版本
两个版本完成相同的任务，接受相同的参数。使用切换按钮比较响应结构，并选择您的客户端所需的版本。
响应版本
V2
在本页面切换版本，即可在同一文档 URL 下比较响应结构。
保持不变的部分
V1 和 V2 的身份验证、必填参数和请求结构均相同。实际上，您只需在构建端点路径和解析响应时选择版本。
版本之间的差异
主要区别在于响应结构。新集成请使用 V2；仅在需要兼容现有客户端契约时保留 V1。
使用方法
如何调用该方法
两个版本使用相同的 API 密钥请求头和相同的查询参数。本文档先展示共享的参数集合，然后展示各版本特定的端点路径和代码片段。
输入参数
共享参数| 参数 | 必填 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
username |
是 | str |
ninja |
不带 @ 符号的公开用户名。 |
各版本的请求路径
V2复制确切的端点路径、示例 URL 和代码片段时请选择版本。上方的参数列表保持不变。
GET /api/v2/twitch.tv/profile/live-status-by-username代码示例
curl --request GET \
--url "https://www.scrapestorm.net/api/v2/twitch.tv/profile/live-status-by-username" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'username=ninja'from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v2/twitch.tv/profile/live-status-by-username"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"username": "ninja",
}
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/profile/live-status-by-username";
const params = new URLSearchParams({
username: "ninja",
});
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 = {
username: "ninja",
};
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 = [
"username" => "ninja",
];
try {
$response = $client->request("GET", "/api/v2/twitch.tv/profile/live-status-by-username", [
'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/profile/live-status-by-username"
params := url.Values{}
params.Set("username", "ninja")
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/profile/live-status-by-username代码示例
curl --request GET \
--url "https://www.scrapestorm.net/api/v1/twitch.tv/profile/live-status-by-username" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'username=ninja'from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v1/twitch.tv/profile/live-status-by-username"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"username": "ninja",
}
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/profile/live-status-by-username";
const params = new URLSearchParams({
username: "ninja",
});
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 = {
username: "ninja",
};
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 = [
"username" => "ninja",
];
try {
$response = $client->request("GET", "/api/v1/twitch.tv/profile/live-status-by-username", [
'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/profile/live-status-by-username"
params := url.Values{}
params.Set("username", "ninja")
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",
"search_context": {
"username": "ninja"
},
"data": {
"channel_context": {
"channel_url": "https://www.twitch.tv/ninja",
"user_id": "19571641",
"username": "ninja"
},
"is_live": false,
"stream": null
}
}此简明 JSON 示例来自 V1 最近一次成功的验证运行。
{
"success": true,
"status": "ok",
"search_context": {
"username": "ninja"
},
"data": {
"data": {
"user": {
"id": "19571641",
"login": "ninja",
"stream": null,
"__typename": "User"
}
},
"extensions": {
"durationMilliseconds": 38,
"operationName": "UseLive",
"requestID": "01KXY4PTDWQ6F6HHBNN8XFZZ13"
}
}
}
下一步
继续评估
将本文档作为第一个决策点，然后在将端点接入常规使用之前，继续了解价格、平台覆盖范围和集成规则。
常见问题
团队在实现前常问的问题
借助这些解答，判断此 API 方法是否适合您的工作流、版本选择和上线计划。
此 Twitch API 方法返回哪些数据？
该方法针对个人资料执行“按用户名获取直播状态”操作。下方的简明响应示例展示了确切的字段结构。
应该选择 V1 还是 V2？
新集成请选择 V2，因为它提供规范化的结构。仅在兼容已使用平台原生格式的客户端时使用 V1。
第一个请求需要准备什么？
创建 API 密钥，在请求头中发送它，并提供表格中的必填参数。代码示例中已包含正确的路径和请求结构。