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

Apps

describe

apps.describe Read the countries, stores, modes and devices the app rank operation accepts, which is the only way to know a valid mode Risk: read
Input: empty object Output

rank

apps.rank Read an app’s store rank day by day for one country and chart, from the App Store or Google Play Risk: read
Input device must match store: androidphone for Google, iphone or ipad for Apple. Call apps.describe for the valid mode values. Output

Capabilities

get

capabilities.get Read what the subscription entitles this account to, keyed by capability name Risk: read
Input: empty object Check this before concluding a 403 means the key is wrong: 403 also means the account is out of data credits. Output

Categories

list

categories.list Read the website category tree, with each child mapping to the Parent~Child slug the rank routes accept Risk: read
Input: empty object Each child maps to the Parent~Child slug the rank routes accept. Some top-level categories have no children. Output

Usage

get

usage.get Read the data credit allowance and how many this user has left; costs no credits Risk: read
Input: empty object Costs no credits. Returns allowance and user_remaining; used is derived from the two. Output

Websites

countryRank

websites.countryRank Read a domain’s rank within one country month by month, for a country code the subscription includes Risk: read
Input The country must be one the subscription includes; capabilities.get lists them. Worldwide is not supported here; use websites.globalRank. Output

globalRank

websites.globalRank Read a domain’s global rank month by month, based on estimated unique visitors and page views across desktop and mobile Risk: read
Input Send both start_date and end_date, or neither for the last 28 days. One without the other is answered with the default window. Output

industryRank

websites.industryRank Read a domain’s industry and its rank within that industry worldwide, as the current reading rather than a series Risk: read
Input Output

topSites

websites.topSites Read the highest-ranked domains worldwide across desktop and mobile, up to 5000 of them Risk: read
Input Output