API Endpoints

HypeAuditor For Discovery - Twitch

JSON Example

Here you can find request with all available filters

{
    "social_network": "twitch",
    "subscribers_count": {
        "from": 1000,
        "to": 10000000
    },
    "account_languages": [
        "en"
    ],
    "account_has_contacts": true,
    "search": [
        "twitch"
    ],
    "account_geo": {
        "country": [
            "us",
            "gb"
        ]
    },
    "audience_geo": {
        "countries": [
            {
                "id": "us",
                "prc": 3
            }
        ]
    },
    "audience_gender": {
        "gender": "male",
        "prc": 50
    },
    "growth": {
        "period": "365d",
        "from": 0,
        "to": 100
    },
    "twitch_live_viewers_avg": {
        "from": 0,
        "to": 50
    },
    "twitch_active_days_per_week": {
        "from": 0,
        "to": 50
    },
    "twitch_games": {
        "games": [
            19156
        ],
        "period": 30
    },
    "twitch_hours_streamed": {
        "from": 10,
        "to": 1000
    },
    "sort": {
        "field": "subscribers_count",
        "order": "desc"
    },
    "page": 1
}

📘

Note:

  • To obtain game IDs, please refer to Endpoint Twitch Games.

Requests

Set YOUR_ID and YOUR_TOKEN from HypeAuditor.

$postFields = [
    'social_network'       => 'twitch',
    'twitch_live_viewers_avg' => ['from' => 1200],
];
$opts = [
    CURLOPT_URL            => 'https://hypeauditor.com/api/method/auditor.searchSandbox',
    CURLOPT_TIMEOUT        => 10,
    CURLOPT_POSTFIELDS     => $postFields,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'X-Auth-Id: CLIENT_ID_HERE',
        'X-Auth-Token: API_TOKEN_HERE',
    ],
];
$ch = curl_init();
curl_setopt_array($ch, $opts);
$response = curl_exec($ch);
var_dump($response);
$postFields = json_encode([
    'social_network'       => 'twitch',
    'twitch_live_viewers_avg' => ['from' => 1200],
]);
$opts = [
    CURLOPT_URL            => 'https://hypeauditor.com/api/method/auditor.searchSandbox',
    CURLOPT_TIMEOUT        => 10,
    CURLOPT_POSTFIELDS     => $postFields,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'X-Auth-Id: CLIENT_ID_HERE',
        'X-Auth-Token: API_TOKEN_HERE',
        'Content-Type: application/json',
        'Content-Length: '.strlen($postFields),
    ],
];
$ch = curl_init();
curl_setopt_array($ch, $opts);
$response = curl_exec($ch);
var_dump($response);

Response Object

{
    "result": {
        "search_results": [
            {
                "basic": {
                    "username": "ebonix",
                    "title": "Ebonix",
                    "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/22d30c9d-2e2b-43a2-84bc-743ab98309d4-profile_image-300x300.png"
                },
                "metrics": {
                    "subscribers_count": {
                        "value": 33570
                    },
                    "live_viewers": [
                        128
                    ],
                    "hours_streamed": [
                        17.89
                    ],
                    "games": [
                        [
                            "The Sims 4",
                            "Just Chatting",
                            "Alan Wake"
                        ]
                    ]
                },
                "features": {
                    "social_networks": [
                        {
                            "social_id": "108636838",
                            "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/22d30c9d-2e2b-43a2-84bc-743ab98309d4-profile_image-300x300.png",
                            "subscribers_count": 33540,
                            "type": "twitch",
                            "title": "Ebonix",
                            "er": 0,
                            "username": "ebonix"
                        },
                        {
                            "social_id": "3634198639",
                            "avatar_url": "https://cdn.hypeauditor.com/img/instagram/user/3634198639.jpg?w=150&till=1706270400&sign=51d797f0d6b111d0956593924efeff09",
                            "subscribers_count": 26288,
                            "type": "instagram",
                            "title": "👑 Ebonix | Danielle Udogaranya 👑",
                            "er": 1.485469,
                            "username": "ebonixsims"
                        },
                        {
                            "social_id": "UCZGhfrR2ZrXC9LO_UYyaHPQ",
                            "avatar_url": "https://yt3.googleusercontent.com/bgWCws3GpuXrIrpVVnMWn411yrjzE17_z0elHoGmrHETmwYjoq799cAFLZg5tErPub8RgxdwjQ=s900-c-k-c0x00ffffff-no-rj",
                            "subscribers_count": 6941,
                            "type": "youtube",
                            "title": "Ebonix",
                            "er": 9.28,
                            "username": "Ebonix"
                        }
                    ],
                    "search_content": [],
                    "audience_geo": {
                          "countries": {
                              "US": 25.61
                          }
                      }
                }
            }, 
            ...,
        ],
        "current_page": 1,
        "total_pages": 102,
        "queries_left": 86
    }
}

Errors