Report Connections

HypeAuditor for Report Connections

Endpoint

By username:

JSON

GET https://hypeauditor.com/api/method/auditor.reportConnections?username={username}&type={social_network}

By user_id:

JSON

GET https://hypeauditor.com/api/method/auditor.reportConnections?id={report_id}&type={social_network}

📘

Note:

• Endpoint is available only for API subscriptions.
• No credits taken for using this endpoint

Both endpoints return the report's connections. Accept the username (string without @) parameter or id parameter of account you requested to check. If you add both parameters, the request will be processed by id.

The string type refers to a social network (Instagram, YouTube, TikTok, Twitter, Twitch, Snapchat), and only one social network may be selected per request.

List of network titles:

Social Network	Title
Instagram	instagram
YouTube	youtube
Twitter	twitter
TikTok	tiktok
Twitch	twitch
Snapchat	snapchat

Response Object

Attributes	Type	Description
social_id	string	report ID
username	string	social account username
type	string	code of a social network instagram, tiktok, youtube, twitter, twitch, snapchat
title	string	name or title from a social account
avatar_url	string	a link to a social network account's avatar
subscribers_count	integer	influencer subscriber count
er	integer	influencer engagement rate in percent; this integer is always 0 for Twitch and Snapchat because the er does not exist in reports
state	string	identifies if a report is fully READY lacks demographic data due to the low audience activity READY_LOW_CONFIDENCE, not ready yet NOT_READY, PRIVATE, DELETED, RESTRICTED, or has LOW_VIEWS.

Requests

Set YOUR_ID and YOUR_TOKEN from HypeAuditor.

Sample with username

Curl Request

curl -X GET \
https://hypeauditor.com/api/method/auditor.reportConnections?username=nasa&type=instagram
-H 'accept: application/json' \
-H 'x-auth-id: %YOUR_ID%' \
-H 'x-auth-token: %YOUR_TOKEN%' \

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://hypeauditor.com/api/method/auditor.reportConnections?username=nasa&type=instagram',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'accept: application/json',
    'x-auth-id: %YOUR_ID%',
    'x-auth-token: %YOUR_TOKEN%'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Sample with user_id

Curl Request

curl -X GET \
https://hypeauditor.com/api/method/auditor.reportConnections?id=UCLA_DiR1FfKNvjuUpBHmylQ&type=youtube
-H 'accept: application/json' \
-H 'x-auth-id: %YOUR_ID%' \
-H 'x-auth-token: %YOUR_TOKEN%' \

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://hypeauditor.com/api/method/auditor.reportConnections?user_id=UCLA_DiR1FfKNvjuUpBHmylQ&type=youtube',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'accept: application/json',
    'x-auth-id: %YOUR_ID%',
    'x-auth-token: %YOUR_TOKEN%'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Sample Response

JSON

{
    "result": [
        {
            "social_id": "528817151",
            "username": "nasa",
            "type": "instagram",
            "title": "NASA",
            "avatar_url": "https://cdn.hypeauditor.com/img/instagram/user/528817151.jpg?w=150&till=1740787140&sign=2b06782dfbe96d267bfd26c08d37dbfa",
            "subscribers_count": 96809672,
            "er": 0.734377,
            "state": "READY"
        },
        {
            "social_id": "11348282",
            "username": "nasa",
            "type": "twitter",
            "title": "NASA",
            "avatar_url": "https://pbs.twimg.com/profile_images/1321163587679784960/0ZxKlEKB_400x400.jpg",
            "subscribers_count": 84756058,
            "er": 0,
            "state": "READY"
        },
        {
            "social_id": "UCLA_DiR1FfKNvjuUpBHmylQ",
            "username": "nasa",
            "type": "youtube",
            "title": "NASA",
            "avatar_url": "https://yt3.googleusercontent.com/eIf5fNPcIcj9ig-wZBeq4stFy1lgjWTW1nLT5dYlFkHZprZ03QBiMcbpwNMB6XSBjrSFGtAGQg=s900-c-k-c0x00ffffff-no-rj",
            "subscribers_count": 12244637,
            "er": 2.72,
            "state": "READY"
        },
        {
            "social_id": "1104426670",
            "username": "nasaartemis",
            "type": "instagram",
            "title": "NASA Artemis",
            "avatar_url": "https://cdn.hypeauditor.com/img/instagram/user/1104426670.jpg?w=150&till=1740787140&sign=1bacdcc74cbb3c40921e72b00f6b26dd",
            "subscribers_count": 2837372,
            "er": 0.440513,
            "state": "READY"
        },
        {
            "social_id": "UC_aP7p621ATY_yAa8jMqUVA",
            "username": "nasagovvideo",
            "type": "youtube",
            "title": "NASA Video",
            "avatar_url": "https://yt3.googleusercontent.com/ytc/AIdro_mAavC7uPluTw_kro_ji26VOxzjsQ6FFnAdtaFi6mmJu8A=s900-c-k-c0x00ffffff-no-rj",
            "subscribers_count": 995500,
            "er": 5.17,
            "state": "READY_LOW_CONFIDENCE"
        }
    ]
}

Errors

Please refer to Errors.

Error Examples

400: Invalid request

JSON

{
    "error": {
        "code": 8,
        "description": "Invalid request"
    }
}

The 400: Invalid request error occurs if the search parameters are not added or added incorrectly.

402: No API access

JSON

{
    "error": {
        "code": 27,
        "description": "No API access"
    }
}

The 402: No API access error occurs when an ID/token of an account without API access is used.

403: Invalid token

JSON

{
    "error": {
        "code": 4,
        "description": "Invalid token"
    }
}

The 403: Invalid token error occurs if the ID or token is incorrect.

404: Object not found

JSON

{
    "error": {
        "code": 16,
        "description": "Object not found"
    }
}

The 404: Object not found error occurs if the requested report is not in the HypeAuditor database.