Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

get

account.get The token’s own user, optionally with the subscription block Risk: read
Input Output

Keywords

add

keywords.add Add keywords to a project, each with its domain, region and language. Adding a keyword already tracked returns the existing one Risk: write
Input Adding a keyword the project already tracks returns the existing one rather than an error.
Output

bulkDelete

keywords.bulkDelete Delete many keywords from one project in a single call; their history is lost Risk: destructive · Irreversible
Input Scoped by numeric projectId, where the single-keyword routes take the project name. Output

bulkUpdate

keywords.bulkUpdate Apply the same domain, region, tags or status to many keywords in one project Risk: write
Input
Output

delete

keywords.delete Delete one keyword and its ranking history; it cannot be restored Risk: destructive · Irreversible
Input Output

get

keywords.get One keyword with its rank, metrics and rank history Risk: read
Input Output

list

keywords.list Every keyword in a project or group with its rank, best rank, search volume and trend, read as of a given day Risk: read
Input Output

refresh

keywords.refresh Queue keywords for an on-demand rank check; spends the plan’s daily refresh quota. The whole request is refused if the quota would be exceeded Risk: destructive
Input Spends the plan’s daily on-demand refresh quota. The whole request is refused when it would be exceeded. Output

update

keywords.update Change a keyword’s domain, region, tags, status, baseline or favourite flag Risk: write
Input Output

Metrics

competitors

metrics.competitors The top competing URLs for one keyword in a date window, with each result’s type and position Risk: read
Input Output

get

metrics.get Keyword movement for a project, group or tag: how many sit in each top-N bucket and how that changed day over day Risk: read
Input Output

Mindshare

history

mindshare.history Share of Voice over a date window, read from Keyword’s cache Risk: read
Input Scoped by numeric projectId, and read from Keyword’s cache. Output

Projects

archive

projects.archive Archive a project or subproject: it stops updating until projects.restore brings it back. Keyword refuses to archive the account’s only active top-level project Risk: write
Input Output

create

projects.create Create a project, or a subproject from a Parent[sub]Child name; the parent must exist first Risk: write
Input Output

delete

projects.delete Delete a project with every keyword and its ranking history; it cannot be restored Risk: destructive · Irreversible
Input Output

get

projects.get One project or subproject with its tags and counts Risk: read
Input Output

list

projects.list Every project and subproject with its tags and keyword counts; a subproject is named Parent[sub]Child Risk: read
Input: empty object Returns projects and subprojects together; a subproject is written Parent[sub]Child in its id. Output

restore

projects.restore Undo an archive, bringing the project and its keywords back Risk: write
Input Output

Rank Chart

get

rankChart.get Daily rank history for a set of keywords over a number of days; Keyword refuses a call covering more than 400,000 keyword-days Risk: read
Input Keyword refuses a call covering more than 400,000 keyword-days, so shorten limit or send fewer keywords. Output

Ranking Urls

list

rankingUrls.list The pages that rank best for a project, with their average position and total search volume, 10 to a page Risk: read
Input Output

Regions

list

regions.list The Google regions a project tracks, with each one’s language and keyword count Risk: read
Input Output

Sharing

get

sharing.get A project’s shared-report settings: whether the share link is on, its hash, whether it needs a password, and what the report shows Risk: read
Input Output

update

sharing.update Turn a project’s share link on or off, set or clear its password, or toggle what the shared report shows. Everything except the on/off switch needs Keyword’s white-label permission Risk: write
Input
Output