This endpoint provides the data from Creator Profile
Endpoint
GET https://hypeauditor.com/api/method/auditor.creators
Parameters Object
| Attribute | Type | Description |
|---|---|---|
| report_unlocked_from | date | Start date for the access to a report, ISO format ( YYYY-MM-DDTHH:MM:SS±HH:MM) |
| report_unlocked_to | date | End date for the access to a report, ISO format ( YYYY-MM-DDTHH:MM:SS±HH:MM) |
| limit | int | from 1 to 100 |
| cursor | int | Used for pagination, add the next_cursor parameter of your page to get to the next page |
Response Object
| Attribute | Type | Description |
|---|---|---|
| creators | array | Data from Creator Profiles of all reports unlocked within the set period and limit |
| next_cursor | int | Used for pagination |
Creators Object Attributes
| Attribute | Type | Description |
|---|---|---|
| id | string | Requested account ID |
| avatar_url | string | Link to creator's avatar image |
| is_favorite | boolean | Is true or false |
| first_name | string | Creator name, if present in their account |
| last_name | string | Creator surname, if present in their account |
| bio | string | The content of the account bio |
| gender | object | Gender -male or female |
| language | array | Two-letter language code (ex.en,es,pt, etc.) |
| emails | array | An array of strings with emails from the creator's account |
| phones | array | Array of strings with phone numbers from the creator's account |
| country.title | string | The creator's country name from the account |
| city.code | array | The array of id's from https://www.geonames.org |
| messages.count | integer | Total number of messages |
| messages.new_count | integer | Number of new messages received from an influencer |
| accounts.{account}.id | string | Account ID |
| accounts.{account}.title | string | Account title |
| accounts.{account}.social_network | string | code of a social network instagram, tiktok, youtube, twitter, twitch, snapchat |
| accounts.{account}.subscribers_count | integer | The number of account subscribers |
| accounts.{account}.username | string | Account username |
| accounts.{account}.avatar_url | string | Link to account avatar image |
| accounts.{account}.is_report_unlocked | boolean | Is true or false |
| social_networks.report_unlock_date | date | Date when the account report has been unlocked, ISO format (YYYY-MM-DDTHH:MM:SS±HH:MM) |
| network_status.id | integer | Network status ID |
| network_status.name | string | Name of the network status related to the ID above |
| contract_status.id | integer | Contract status IDs |
| contract_status_name | string | Name of the payment status related to the ID above |
| payment_status.id | integer | Payment status ID |
| payment_status.name | string | Name of the payment status related to the ID above |
Requests
Set YOUR_ID and YOUR_TOKEN from HypeAuditor.
curl --location 'https://hypeauditor.com/api/method/auditor.creators/?limit=1' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Id: %YOUR_ID%' \
--header 'X-Auth-Token: %YOUR_TOKEN%' \
--data ''
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://hypeauditor.com/api/method/auditor.creators/?limit=1',
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',
'Content-Type: application/json',
'X-Auth-Id: %YOUR_ID%',
'X-Auth-Token: %YOUR_TOKEN%'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Sample Response
{
"result": {
"creators": [
{
"id": 4763636,
"avatar_url": "https://cdn.hypeauditor.com/img/instagram/user/32756785.jpg?w=150&till=1743465540&sign=a8ffeb1dd4eb8bd3cbe0e151b5ed552a",
"is_favorite": false,
"first_name": "RAE",
"last_name": "PHOTOGRAPHY",
"bio": "",
"gender": null,
"language": "en",
"emails": [],
"phones": [],
"country": {
"title": "Greece",
"code": "GR"
},
"city": null,
"messages": {
"count": 0,
"new_count": 0
},
"accounts": [
{
"id": "32756785",
"title": "Rae",
"social_network": "instagram",
"subscribers_count": 2653,
"username": "rae_pickard_",
"avatar_url": "https://cdn.hypeauditor.com/img/instagram/user/32756785.jpg?w=150&till=1743465540&sign=a8ffeb1dd4eb8bd3cbe0e151b5ed552a",
"is_report_unlocked": true,
"report_unlock_date": "2025-02-28T16:45:22+00:00"
},
{
"id": "38431970264",
"title": "RAE PHOTOGRAPHY",
"social_network": "instagram",
"subscribers_count": 4930,
"username": "rae.n.photography",
"avatar_url": "https://cdn.hypeauditor.com/img/instagram/user/38431970264.jpg?w=150&till=1743465540&sign=51124191f6ec0ae12abfa9a67fbd2a2e",
"is_report_unlocked": false,
"report_unlock_date": null
}
],
"network_status": {
"id": -1,
"name": "Prospects"
},
"payment_status": {
"id": -3,
"name": "Nothing to pay"
},
"contract_status": {
"id": -2,
"name": "Not signed"
}
}
],
"next_cursor": null
}
}
Errors
Please refer to Errors.
Error Examples
400: Invalid request
{
"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
{
"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
{
"error": {
"code": 4,
"description": "Invalid token"
}
}
The 403: Invalid token error occurs if the ID or token is incorrect.
{
"error": {
"code": 16,
"description": "Object not found"
}
}
500: Internal Server Error
{
"error": {
"code": 1,
"description": "Unknown error occurred"
}
}
If the 500: Internal Server Error error occurs, please contact the HypeAuditor support team or your Customer Success manager.