Basic

Limits

There is the limit on RPS (request per seconds), it should be less than 100 per minute.

Authorization

šŸ“˜

Note:

Use your Client ID and API token values to access the API. Pass them via X-Auth-Token and X-Auth-Id headers, respectively. Reach us at [email protected] if you donā€™t have them.

Versioning

ā—ļø

IMPORTANT:

Versioning is controlled by the v parameter, which is a code that represents the ā€œversionā€ of the API you expect from HypeAuditor.

It is designed to give developers the freedom to adapt to HypeAuditor API changes on their own schedule. The value of the v parameter is string. As a concrete example, suppose we introduce a change in the future that renames all our id fields to foo.

Version parameter is optional. If itā€™s not passed as a part of an API request we default it to latest version. We recommend setting a single version across all of your API calls and launching your app with API calls using this version. Current version is 2019-10-18

Requests

Method: POST
URL: https://hypeauditor.com/api/method/%endpoint%

Please, check the following docs to see endpoint names and response results:

Response

Response comes with Content-Type: application/json header. Start with checking response HTTP code. If you receive something different than 200, then error description will be in error.description key.

HTTP codes

  • 500 - Internal Server Error ā€” service temporary unavailable, try later.
  • 400 - Bad request ā€” check request parameters
  • 402 - Payment Required ā€” your account is out of credits or API Access expired, you need to purchase more at HypeAuditor or contact [email protected].
  • 403 - Unauthorized ā€” Check API token OR Private account/Account does not have posts. Note: your API token changes when you change password
  • 404 - Not Found ā€” User/page not found
  • 429 - Too many requests
  • 200 - OK
  • 202 - Accepted ā€” Report requested and being generated. Response body contains result.retryTtl field with the number of seconds to retry after. If after retryTtl seconds report is still not ready, you get code 202 again. In case of success you get code 200. Available only for Instagram reports

Response body success

{
    "result": {
       ..., // some result
       "restTokens": 500 // credits left on your balance
       "validUntil": int // unix timestamp in seconds
   }
}

Response body error

{
  "error": {
       "description": "Sample Description"
   }
}