Получайте подробные публичные данные по сущности «Профиль» из Twitch по известному идентификатору для карточек, проверки и обогащения.
Операция «Описание по имени пользователя» подходит, когда объект уже найден и продукту нужен его актуальный публичный контекст.
Сначала оцените результат и сценарии применения, затем переходите к параметрам и рабочему примеру запроса.
Ответ содержит доступные поля объекта «Профиль» в нормализованной V2 или исходной V1 структуре.
Операция «Описание по имени пользователя» подходит, когда объект уже найден и продукту нужен его актуальный публичный контекст.
Добавляйте публичные поля Twitch к уже известным объектам продукта.
Сверяйте идентификаторы и актуальный публичный контекст перед дальнейшей обработкой.
Используйте детали объекта как основу для отчётов, скоринга и связанных запросов.
Обе версии решают одну и ту же задачу и принимают одинаковые параметры. Переключатель нужен, чтобы сравнить структуру ответа и выбрать версию, которую ожидает ваш клиент.
Переключайте версии на этой странице, чтобы сравнивать структуру ответа без смены URL инструкции.
Аутентификация, обязательные параметры и форма запроса одинаковы для V1 и V2. Версия задаётся в пути запроса и определяет структуру ответа.
Главное отличие — envelope ответа. Для новых интеграций лучше использовать V2, а V1 оставлять только для совместимости с уже существующей клиентской интеграцией.
Для обеих версий используется один заголовок API-ключа и одинаковые параметры строки запроса. Ниже сначала показаны общие параметры, затем путь и примеры кода для выбранной версии.
| Параметр | Обязателен | Тип | Пример | Описание |
|---|---|---|---|---|
username |
Да | str |
value |
Публичное имя пользователя без символа @. |
Версию имеет смысл выбирать, когда вы копируете точный путь эндпоинта, пример URL и фрагмент кода. Список параметров выше при этом остается тем же самым.
GET /api/v2/twitch.tv/profile/about-by-usernamecurl --request GET \
--url "https://www.scrapestorm.net/api/v2/twitch.tv/profile/about-by-username" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'username=value'from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v2/twitch.tv/profile/about-by-username"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"username": "value",
}
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/about-by-username";
const params = new URLSearchParams({
username: "value",
});
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: "value",
};
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" => "value",
];
try {
$response = $client->request("GET", "/api/v2/twitch.tv/profile/about-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/about-by-username"
params := url.Values{}
params.Set("username", "value")
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)
}Версию имеет смысл выбирать, когда вы копируете точный путь эндпоинта, пример URL и фрагмент кода. Список параметров выше при этом остается тем же самым.
GET /api/v1/twitch.tv/profile/about-by-usernamecurl --request GET \
--url "https://www.scrapestorm.net/api/v1/twitch.tv/profile/about-by-username" \
--header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
--get --data-urlencode 'username=value'from urllib.parse import urljoin
import requests
BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v1/twitch.tv/profile/about-by-username"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}
params = {
"username": "value",
}
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/about-by-username";
const params = new URLSearchParams({
username: "value",
});
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: "value",
};
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" => "value",
];
try {
$response = $client->request("GET", "/api/v1/twitch.tv/profile/about-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/about-by-username"
params := url.Values{}
params.Set("username", "value")
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": {
"channel_url": "https://www.twitch.tv/ninja",
"user_id": "19571641",
"username": "ninja",
"display_name": "Ninja",
"description": "Just want to make people happy. Co-Founder @DrinkNutcase.",
"hashtags": [],
"emails": [],
"follower_count": 19252591,
"is_partner": true,
"last_broadcast_game": {
"game_id": "1264310518",
"slug": null,
"name": null,
"display_name": "Marvel Rivals"
},
"avatar_url": "https://example.com/image.jpg"
}
}
}Компактный JSON-пример сформирован из последней успешной проверки версии V1.
{
"success": true,
"status": "ok",
"search_context": {
"username": "ninja"
},
"data": {
"errors": [
{
"message": "failed integrity check",
"path": [
"user",
"channel",
{
"_more_items": 1
}
],
"extensions": {
"code": "IntegrityCheckFailed"
}
}
],
"data": {
"currentUser": null,
"user": {
"id": "19571641",
"description": "Just want to make people happy. Co-Founder @DrinkNutcase. ",
"displayName": "Ninja",
"primaryColorHex": "1F69FF",
"profileImageURL": "https://static-cdn.jtvnw.net/jtv_user_pictures/90d40495-f467-4911-9035-72d8d10a49c5-profile_image-300x300.png",
"followers": {
"totalCount": 19252591,
"__typename": "FollowerConnection"
},
"roles": {
"isPartner": true,
"isAffiliate": false,
"isStaff": null,
"isParticipatingDJ": false,
"__typename": "UserRoles"
},
"channel": {
"id": "19571641",
"socialMedias": null,
"__typename": "Channel"
},
"lastBroadcast": {
"id": "319868118491",
"game": {
"id": "1264310518",
"displayName": "Marvel Rivals",
"__typename": "Game"
},
"__typename": "Broadcast"
},
"primaryTeam": null,
"videos": {
"edges": [
{
"node": "…",
"__typename": "VideoEdge"
},
{
"node": "…",
"__typename": "VideoEdge"
},
{
"_more_items": 28
}
],
"__typename": "VideoConnection"
},
"__typename": "User"
}
},
"extensions": {
"challenge": {
"type": "integrity"
},
"durationMilliseconds": 76,
"operationName": "ChannelRoot_AboutPanel",
"requestID": "01KXY4PSFVVRKJADBKFGWCF8Q0"
}
}
}Используйте инструкцию как первую точку принятия решения, а затем переходите к покрытию, стоимости и общим правилам интеграции перед запуском API-метода.
Эти ответы помогают понять, подходит ли API-метод под ваш сценарий, выбор версии и запуск.
Метод выполняет операцию «Описание по имени пользователя» для сущности «Профиль». Точный набор полей показан в компактном примере ответа ниже.
Для новой интеграции выбирайте V2 с нормализованной структурой. V1 нужен только для совместимости с клиентами, которые уже используют исходный формат платформы.
Создайте API-ключ, передайте его в заголовке и заполните обязательные параметры из таблицы. Готовые примеры кода уже содержат правильный путь и структуру запроса.