API Endpoints

PDF Export

HypeAuditor For PDF Export

Changelog

❗️

Important:

  • Twitch, Twitter and Snapchat reports have been added to Endpoint since 12/02/2024

Endpoint

Get PDF file for:

Instagram Report

GET https://hypeauditor.com/api/method/auditor.instagramPdf/?username={username}

Username is Instagram username from the URL of Instagram account (https://www.instagram.com/<username>). Returns PDF file if it’s ready.

YouTube Report

GET https://hypeauditor.com/api/method/auditor.youtubePdf/?channel={channel}

Channel is YouTube channel from the URL of YouTube account (https://www.youtube.com/channel/<channel>). Returns PDF file if it’s ready.

TikTok Report

GET https://hypeauditor.com/api/method/auditor.tiktokPdf/?channel={channel}

Channel is TikTok channel from the URL of TikTok account (https://www.tiktok.com/@<channel>). Returns PDF file if it’s ready.

Twitch Report

GET https://hypeauditor.com/api/method/auditor.twitchPdf/?channel={channel}

Channel is Twtich channel from the URL of Twtich account (https://www.twitch.com/<channel>). Returns PDF file if it’s ready.

Twitter Report

GET https://hypeauditor.com/api/method/auditor.twitterPdf/?channel={channel}

Channel is Twitter channel from the URL of Twitter account (https://www.twitter.com/<channel>). Returns PDF file if it’s ready.

Snapchat Report

GET https://hypeauditor.com/api/method/auditor.snapchatPdf/?channel={channel}

Channel is Snapchat channel from the URL of Snapchat account (https://www.snapchat.com/add/<channel>). Returns PDF file if it’s ready.

Response

Response depends on HTTP code:

  • 202 - Request is accepted and PDF report is under generation. Pleaser, refer to retryTtl.
  • 200 - Request is ready and pdfUrl link available for PDF exporting.

If you receive a different response, please refer to error description in error.description key.

Response Object

AttributesType
pdfUrlstrURL in HypeAuditor CDN for downloading PDF.
By re-request, report is updated once a day.
The link is valid for 28 days.
retryTtlintTime in sec after request will be ready.
restTokensintNumber of remaining tokens.

Requests

Set YOUR_ID and YOUR_TOKEN from HypeAuditor.

curl -X GET \
  https://hypeauditor.com/api/method/auditor.{social_network}Pdf \
  -H 'x-auth-id: %YOUR_ID%' \
  -H 'x-auth-token: %YOUR_TOKEN%' \
  -d {username/channel}=<username/channel>  \

<?php
$curl = curl_init();
curl_setopt_array($curl, [
   CURLOPT_URL => 'https://hypeauditor.com/api/method/auditor.{social_network}Pdf',
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_POSTFIELDS => [
       'username/channel' => '<username/channel>'
   ],
   CURLOPT_HTTPHEADER => [
       'x-auth-id: YOUR_ID',
       'x-auth-token: YOUR_TOKEN'
   ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
   echo 'cURL Error #:' . $err;
} else {
   echo $response;
}

Sample request

GET https://hypeauditor.com/api/method/auditor.instagramPdf/?username=nasa

Sample response

{
    "result": {
        "pdfUrl": "https://cdn.hypeauditor.com/ha/local/generated/pdf/WeSBIMcKMTI2ODc1NyVodHRwczovL2FwcC5oeXBlYXVkaXRvci5kZXYvaW5zdGFncmFtL25hc2Ev.pdf?till=1705680459&sign=2f97f492b57e72806ed5b804428f327b",
        "restTokens": 999
    }
}

Errors