Twitter Example

HypeAuditor For Discovery - Twitter

JSON Example

Here you can find request with all available filters

JSON

{
    "social_network": "twitter",
    "er": {
        "from": 0,
        "to": 13
    },
    "subscribers_count": {
        "from": 1000,
        "to": 10000000
    },
    "account_languages": [
        "en"
    ],
    "verified": 0,
    "account_has_contacts": true,
    "search": [
        "adidas"
    ],
    "account_geo": {
        "country": [
            "us",
            "gb"
        ]
    },
    "last_media_time": {
        "from": 1626072318
    },
    "twitter_tweet": {
        "from": 0,
        "to": 50
    },
    "twitter_replies": {
        "from": 0,
        "to": 50
    },
    "twitter_likes": {
        "from": 0,
        "to": 50
    },
    "twitter_retweet": {
        "from": 0,
        "to": 50
    },
    "growth": {
        "period": "365d",
        "from": 0,
        "to": 100
    },
    "sort": {
        "field": "subscribers_count",
        "order": "desc"
    },
    "page": 1
}

Requests

Set YOUR_ID and YOUR_TOKEN from HypeAuditor.

PHP Request

$postFields = [
    'social_network'       => 'twitter',
    'twitter_tweet' => ['from' => 100],
];
$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);

Application/JSON with JSON body request

$postFields = json_encode([
    'social_network'       => 'twitter',
    'twitter_tweet' => ['from' => 100],
]);
$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

Response can contain search_results array. Please, check Change Log for further information.

JSON

{
  "result": {
    "search_results": [
      {
        "basic": {
          "username": "treasuremembers",
          "title": "TREASURE",
          "avatar_url": "https://pbs.twimg.com/profile_images/1245199469571796993/TaKDsz-3_400x400.jpg"
        },
        "metrics": {
          "er": {
            "value": 1.719826
          },
          "subscribers_count": {
            "value": 3834922
          },
          "avg_tweets": {
            "value": 112
          },
          "avg_retweets": {
            "value": 60816
          }
        },
        "features": {
          "social_networks": [
            {
              "social_id": "UCx9hXYOCvUYwrprEqe4ZQHA",
              "avatar_url": "https://yt3.ggpht.com/ytc/AKedOLSrw1Kksy0uIKu_ooYrhCIBt7ogFZdNiMqvIe6m=s900-c-k-c0x00ffffff-no-rj",
              "subscribers_count": 5990865,
              "type": "youtube",
              "title": "TREASURE (트레저)",
              "username": "TREASURE (트레저)"
            },
            {
              "social_id": "10871733091",
              "avatar_url": "https://cdn.hypeauditor.com/img/instagram/user/10871733091.jpg?w=150&till=1656039600&sign=3dc187261b0964e54bda200fcd08eeca",
              "subscribers_count": 5292374,
              "type": "instagram",
              "title": "TREASURE (트레저)",
              "username": "yg_treasure_official"
            },
            {
              "social_id": "1240627844868268033",
              "avatar_url": "https://pbs.twimg.com/profile_images/1245199469571796993/TaKDsz-3_400x400.jpg",
              "subscribers_count": 3785574,
              "type": "twitter",
              "title": "TREASURE",
              "username": "treasuremembers"
            }
          ]
        }
      }
    ],
    "current_page": 1,
    "total_pages": 22394,
    "queries_left": 83
  }
}

Errors

• Errors