New to Corsair? See API access, authentication, and error handling.
Account
planInfo
account.planInfo
Read the report credits and discovery calls left in the plan; API subscriptions only
Risk: read
unlockedReports
account.unlockedReports
List the reports unlocked on the account, with refunded marking a credit returned after a failed build
Risk: read
A date without a time is read as
00:00:00, and omitting both dates covers the account history.
Output
result full type
result full type
Discovery
keywords
discovery.keywords
Read the posts behind a keyword search by their content IDs, which is free and safe to repeat
Risk: read
Output
search
discovery.search
Search creators with the documented filters, 20 per page; each page costs one discovery call, and sandbox answers sample data without spending one
Risk: read
Each page costs one discovery call and returns 20 rows; the last page is 500.
sandbox: true spends nothing.
Output
History
history.instagram
Read the Instagram metrics history for a username. HypeAuditor unlocks the creator’s report on this call, so the first request for a creator spends a credit; repeating it is free
Risk: read
Output
tiktok
history.tiktok
Read the TikTok metrics history for a channel. HypeAuditor unlocks the creator’s report on this call, so the first request for a creator spends a credit; repeating it is free
Risk: read
Output
twitch
history.twitch
Read the Twitch metrics history for a channel. HypeAuditor unlocks the creator’s report on this call, so the first request for a creator spends a credit; repeating it is free
Risk: read
Output
history.twitter
Read the Twitter metrics history for a channel. HypeAuditor unlocks the creator’s report on this call, so the first request for a creator spends a credit; repeating it is free
Risk: read
Output
youtube
history.youtube
Read the YouTube metrics history for a channel. HypeAuditor documents that history calls unlock the creator’s report on the other networks, so treat the first request as spending a credit; repeating it is free
Risk: read
The action is
auditor.youtube.history. The docs page names auditor.youtubeHistory, which answers 405 code 3.
Output
Lists
add
lists.add
Add a report to a saved list; repeating it leaves the report in the list, so it is safe to retry
Risk: write
Output
items
lists.items
Read the reports saved in one list, up to 100 per page, which is free and safe to repeat
Risk: read
Output
result full type
result full type
list
lists.list
List the saved lists in the account; the default “Recent searches” list is id: 0
Risk: read
result full type
result full type
remove
lists.remove
Remove a report from a saved list; the default “Recent searches” list cannot be changed
Risk: write
Output
Media
media.instagram
Read an Instagram account’s recent media, which is free and safe to repeat
Risk: read
Output
tiktok
media.tiktok
Read a TikTok account’s media by channel ID, which is free and safe to repeat
Risk: read
Output
youtube
media.youtube
Read a YouTube channel’s media, one page at a time, which is free and safe to repeat
Risk: read
One page at a time, which is free and safe to repeat.
Output
Mentions
tiktok
mentions.tiktok
Read the brands a TikTok account’s videos mention, which is free and safe to repeat
Risk: read
Output
youtube
mentions.youtube
Read the brands a YouTube channel’s videos mention, which is free and safe to repeat
Risk: read
Output
Reports
reports.instagram
Read the Instagram report by username or user ID; the first request for a creator spends a credit, and a 202 answer carries retryTtl
Risk: read
Send exactly one of
username or user_id; they are two separate actions.
Output: object
Output full type
Output full type
snapchat
reports.snapchat
Read the Snapchat report by username; the first request for a creator spends a credit, and a 202 answer carries retryTtl
Risk: read
Output:
object
Output full type
Output full type
tiktok
reports.tiktok
Read the TikTok report by username or user ID; the first request for a creator spends a credit, and a 202 answer carries retryTtl
Risk: read
Send exactly one of
channel or user_id, for the same reason.
Output: object
Output full type
Output full type
twitch
reports.twitch
Read the Twitch report by username; the first request for a creator spends a credit, and a 202 answer carries retryTtl
Risk: read
Output:
object
Output full type
Output full type
reports.twitter
Read the Twitter report by username; the first request for a creator spends a credit, and a 202 answer carries retryTtl
Risk: read
Output:
object
Output full type
Output full type
youtube
reports.youtube
Read the YouTube report by channel ID or username; the first request for a creator spends a credit, and a 202 answer carries retryTtl
Risk: read
Output:
object
Output full type
Output full type
Suggester
get
suggester.get
Suggest a channel name from a partial one, which is free and safe to repeat
Risk: read
Output
Taxonomy
get
taxonomy.get
Read the category, thematics and language ids the discovery filters take
Risk: read