• API
  • Documentation

Getting Started

The MixRank API is a REST interface to much of the data available in MixRank reports. URL endpoints are resource-oriented and all results, including errors, are returned in JSON format. Appropriate HTTP status codes are returned to represent success and error results.

The API is very simple to use with only an HTTP client and a JSON parser, so there's no need for any client libraries.

Authentication

You'll need an API key to make any requests. Request API Access and we'll be in touch to help you get started.

Please keep your key secret; requests made with your key will identify you! If your key is compromised, please ask us for a replacement.

To verify your key, you can visit https://api.mixrank.com/v2/json/{api_key}/echo. You can also go to the Authentication section and click the button to test your API key.

Usage Limits

The number of requests you can make is determined by your API license. If you're unsure what your limit is, please ask us. Exceeding the request limit may result in a service interruption.

Your API license also determines what parts of the API are accessible; everything isn't available by default. Let us know if you have any questions about what you can and can't acccess.

Request Format

All API endpoints will start with https://api.mixrank.com/v2/json/{api_key}/ followed by a query path. Required parameters will be embedded in the endpoint format, and optional parameters must be appended in the URL query string.

For example, disecting the URL: https://api.mixrank.com/v2/json/{api_key}/appstore/apps/1526737990/sdks?page_size=25&offset=10

1526737990 This is a required parameter embedded in the endpoint URL.
page_size This is an optional parameter, overriding a default. The page_size parameter determines the maximum number of results returned. The maximum page size for all requests is 100.
offset This is another optional parameter, overriding a default. The offset parameter is useful for paging through results.

Note that optional parameter names are case-sensitive. In the example above, if Page_Size was used instead of page_size, the parameter would be ignored.

Parameters that specify a date should always be passed in ISO 8601 format, i.e. "YYYY-MM-DD".

Response Format

All responses are returned as JSON. If there are errors they will be available in the "errors" field of the response and the appropriate HTTP status code will be returned.

All dates will be returned in ISO 8601 format (i.e. YYYY-MM-DD).

If any fields in the response are empty, they will be returned as null.

Account / Echo

Test that your API key is valid.

Synopsis

GET /echo

Response

Examples

GET Hide
Check your API key.
/echo

Account / Usage

Summary of your API usage for the current month.

Synopsis

GET /usage

Response

Examples

GET Hide
Check your API usage.
/usage

Companies / Directory

Directory of companies.

Synopsis

GET /companies

Optional Parameters

Response

Examples

GET Hide
Top 4 companies by number of employees.
/companies?page_size=4
GET Hide
Search for companies matching "rovio".
/companies?search=rovio

Companies / Overview

Summary information about a company.

Synopsis

GET /companies/{company_id}

Required Parameters

Response

Examples

GET Hide
Company information for Google, Inc.
/companies/81760867

Companies / Match

Query the companies databases for best matches. Results ordered by relevance.

Synopsis

GET /companies/match

Optional Parameters

Response

Examples

GET Hide
Find best match to company name "Xerox".
/companies/match?name=Xerox
GET Hide
Match "MAXDigital LLC".
/companies/match?name=MAXDigital%20LLC
GET Hide
Match "UNC-Chapel Hill".
/companies/match?name=UNC-Chapel%20Hill
GET Hide
Find by website url.
/companies/match?url=https://guardian.co.uk/
GET Hide
Find by LinkedIn url.
/companies/match?linkedin=https://linkedin.com/company/157355
GET Hide
Find by LinkedIn url.
/companies/match?linkedin=https://linkedin.com/company/gameloft

Companies / Trends

Employee and followers trends about a company.

Synopsis

GET /companies/{company_id}/timeseries

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Google
/companies/81760867/timeseries
GET Hide
Google from 2020-03-19 to present
/companies/81760867/timeseries?since=2020-03-19
GET Hide
Latest 50 records for Google
/companies/81760867/timeseries?page_size=50
GET Hide
Latest 50, skipping 150 records for Google
/companies/81760867/timeseries?page_size=50&offset=150

iOS Apps / Directory

Directory of iOS apps.

Synopsis

GET /appstore/apps

Optional Parameters

Response

Examples

GET Hide
Top 4 apps by ratings.
/appstore/apps?page_size=4&sort_field=rating_count
GET Hide
The oldest apps in the appstore.
/appstore/apps?page_size=4&sort_field=id&sort_order=asc
GET Hide
iOS apps released by Supercell.
/appstore/apps?company.id=82018021
GET Hide
Search for apps matching "zombies".
/appstore/apps?search=zombies

iOS Apps / Overview

Summary information about a App Store app.

Synopsis

GET /appstore/apps/{app_id}

Required Parameters

Response

Examples

GET Hide
Summary information for Facebook.
/appstore/apps/284882215
GET Hide
Summary information for Pandora.
/appstore/apps/com.pandora

iOS Apps / Rankings Summary

Rankings for an app. Apps are ranked in "lists" which are made up of a container, a country, and a genre.

Synopsis

GET /appstore/apps/{app_id}/rankings

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Rankings for Starbucks.
/appstore/apps/331177714/rankings
GET Hide
Rankings for Starbucks.
/appstore/apps/com.starbucks.mystarbucks/rankings

iOS Apps / Rankings History

Ranking historys for an app in a given ranking list.

Synopsis

GET /appstore/apps/{app_id}/rankings-history

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Rankings history for Shazam in the "Top Free Applications" list in the US.
/appstore/apps/284993459/rankings-history?container=topfreeapplications&genre=ios&country=us
GET Hide
Rankings history for "Clash of Clans" in the "Top Free Applications" list in the US.
/appstore/apps/com.supercell.magic/rankings-history?container=topfreeapplications&genre=ios&country=us

iOS Apps / SDKs

SDKs installed in a given app.

Synopsis

GET /appstore/apps/{app_id}/sdks

Required Parameters

Optional Parameters

Response

Examples

GET Hide
SDKs installed in Instagram.
/appstore/apps/389801252/sdks
GET Hide
SDKs installed in "Clash of Clans".
/appstore/apps/com.supercell.magic/sdks

iOS Apps / Configs

Configuration options for iOS apps from embedded info.plist documents.

Synopsis

GET /appstore/apps/{app_id}/configs

Required Parameters

Response

Examples

GET Hide
Get the config options for Words With Friends.
/appstore/apps/321916506/configs
GET Hide
Get the config options for Words With Friends.
/appstore/apps/com.newtoyinc.WordsWithFriendsFree/configs

iOS Apps / Versions

Releases of an app.

Synopsis

GET /appstore/apps/{app_id}/versions

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Versions of Pinterest app.
/appstore/apps/429047995/versions
GET Hide
Versions of "Clash of Clans" app.
/appstore/apps/com.supercell.magic/versions

iOS Apps / In-App Purchases

In-App purchases offered by this app.

Synopsis

GET /appstore/apps/{app_id}/iaps

Required Parameters

Optional Parameters

Response

Examples

GET Hide
In-app purchases offered by "Minecraft".
/appstore/apps/479516143/iaps
GET Hide
In-app purchases offered by "Minecraft".
/appstore/apps/com.mojang.minecraftpe/iaps

iOS Apps / Reviews

User reviews of a given app.

Synopsis

GET /appstore/apps/{app_id}/reviews

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Reviews of "Minecraft".
/appstore/apps/479516143/reviews
GET Hide
Reviews of "Minecraft".
/appstore/apps/com.mojang.minecraftpe/reviews

iOS Apps / Downloads

Download trends for a given app.

Synopsis

GET /appstore/apps/{app_id}/downloads

Required Parameters

Response

Examples

GET Hide
Downloads trend for "Clash of Clans".
/appstore/apps/529479190/downloads
GET Hide
Downloads trend for "Clash of Clans".
/appstore/apps/com.supercell.magic/downloads

iOS Apps / Revenue

Revenue trends for a given app.

Synopsis

GET /appstore/apps/{app_id}/revenue

Required Parameters

Response

Examples

GET Hide
Revenue trend for "Clash of Clans".
/appstore/apps/529479190/revenue
GET Hide
Revenue trend for "Clash of Clans".
/appstore/apps/com.supercell.magic/revenue

iOS Developers / Apps

Apps published by a developer

Synopsis

GET /appstore/developers/{developer_id}/apps

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Get the apps developed by OMGPOP.
/appstore/developers/422679887/apps

iOS App Privacy / Privacy labels

Possible privacy labels for iOS apps from App store.

Synopsis

GET /appstore/privacy/labels

Response

Examples

GET Hide
Get all possible App store privacy labels.
/appstore/privacy/labels

iOS App Privacy / Privacy data types and categories

Possible privacy data types and categories for iOS apps from App store.

Synopsis

GET /appstore/privacy/datatype

Response

Examples

GET Hide
Get all possible App store privacy data types with categories.
/appstore/privacy/datatype

iOS App Privacy / Privacy types (linkages)

Possible privacy types (linkages) for iOS apps from App store.

Synopsis

GET /appstore/privacy/linkage

Response

Examples

GET Hide
Get all possible App store privacy types.
/appstore/privacy/linkage

iOS App Privacy / Privacy data collection purposes

Possible privacy data collection purposes for iOS apps from App store.

Synopsis

GET /appstore/privacy/purpose

Response

Examples

GET Hide
Get all possible App store privacy data collection purposes.
/appstore/privacy/purpose

iOS Rankings / Lists

Get all ranking list options. A list is determined by a container, genre, and country.

Synopsis

GET /appstore/rankings

Response

Examples

GET Hide
Get all ranking lists.
/appstore/rankings

iOS Rankings / Rankings

Get app rankings by list. A list is determined by container, a genre, and a country.

Synopsis

GET /appstore/rankings/{container}/{genre}/{country}

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Rankings of top free games.
/appstore/rankings/topfreeapplications/ios/us

iOS SDKs / Directory

List of identified SDKs.

Synopsis

GET /appstore/sdks

Optional Parameters

Response

Examples

GET Hide
Top 10 SDKs by rank
/appstore/sdks?page_size=10
GET Hide
Top 4 SDKs by all-time installs.
/appstore/sdks?sort_field=total_installs&page_size=4
GET Hide
Top 4 SDKs by most uninstalls.
/appstore/sdks?sort_field=uninstalls&page_size=4

iOS SDKs / Overview

Get summary information about an SDK.

Synopsis

GET /appstore/sdks/{sdk_slug}

Required Parameters

Response

Examples

GET Hide
Get information about the Facebook SDK.
/appstore/sdks/facebook

iOS SDKs / Installs

Get apps that have this SDK installed.

Synopsis

GET /appstore/sdks/{sdk_slug}/installs

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Top 10 apps that have installed the Flurry SDK.
/appstore/sdks/flurry/installs?page_size=10
GET Hide
Top 10 apps that have installed the Google Analytics SDK.
/appstore/sdks/google-analytics/installs?page_size=10

iOS SDKs / Uninstalls

Get apps that have uninstalled this SDK.

Synopsis

GET /appstore/sdks/{sdk_slug}/uninstalls

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Top 10 apps that have uninstalled the Flurry SDK.
/appstore/sdks/flurry/uninstalls?page_size=10
GET Hide
Top 10 apps by number of ratings that have uninstalled the OAuth SDK.
/appstore/sdks/oauth/uninstalls?page_size=10&sort_field=rating_count

iOS SDKs / Genres

Get aggregate genre data for a given SDK's apps.

Synopsis

GET /appstore/sdks/{sdk_slug}/genres

Required Parameters

Response

Examples

GET Hide
Get genre stats for apps that have installed InMobi.
/appstore/sdks/inmobi/genres
GET Hide
Get genre stats for apps that have installed Flurry.
/appstore/sdks/flurry/genres

iOS SDKs / Versions

Releases of an SDK

Synopsis

GET /appstore/sdks/{sdk_slug}/versions

Required Parameters

Response

Examples

GET Hide
Get the version history for the InMobi SDK
/appstore/sdks/inmobi/versions
GET Hide
Get the version history for the Flurry SDK
/appstore/sdks/flurry/versions

Play Store Apps / Directory

Directory of Play Store (Android) apps.

Synopsis

GET /playstore/apps

Optional Parameters

Response

Examples

GET Hide
Top 4 apps by downloads.
/playstore/apps?page_size=4&sort_field=downloads
GET Hide
Top 4 apps by ratings.
/playstore/apps?page_size=4&sort_field=rating_count
GET Hide
Apps by OMGPOP
/playstore/apps?company.id=81976622
GET Hide
Search for apps matching "messenger".
/playstore/apps?search=messenger

Play Store Apps / Overview

Summary information about a Play Store app.

Synopsis

GET /playstore/apps/{pname}

Required Parameters

Response

Examples

GET Hide
Summary information for Candy Crush.
/playstore/apps/com.king.candycrushsaga
GET Hide
Summary information for TuneIn Radio.
/playstore/apps/tunein.player
GET Hide
Summary information for WhatsApp.
/playstore/apps/com.whatsapp

Play Store Apps / Images

Get image and video assets for an app. Includes icons and screenshots.

Synopsis

GET /playstore/apps/{pname}/images

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Requests all image and video assets for Candy Crush.
/playstore/apps/com.king.candycrushsaga/images
GET Hide
Requests all image and video assets for Clash of Clans.
/playstore/apps/com.supercell.clashofclans/images

Play Store Apps / Rankings Summary

Rankings for an app. Apps are ranked in "lists" which are made up of a container, and (optionally) a category.

Synopsis

GET /playstore/apps/{pname}/rankings

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Rankings for Deer Hunter 2014.
/playstore/apps/com.glu.deerhunt2/rankings
GET Hide
Rankings for WolframAlpha.
/playstore/apps/com.wolfram.android.alpha/rankings

Play Store Apps / Rankings History

Ranking historys for an app in a given ranking list.

Synopsis

GET /playstore/apps/{pname}/rankings-history

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Rankings for Netflix in Top Grossing.
/playstore/apps/com.netflix.mediaclient/rankings-history?container=apps_topgrossing
GET Hide
Rankings for Netflix in Top Grossing before 2017.
/playstore/apps/com.netflix.mediaclient/rankings-history?container=apps_topgrossing&before=2017-01-01

Play Store Apps / SDKs

SDKs installed in a given app.

Synopsis

GET /playstore/apps/{pname}/sdks

Required Parameters

Optional Parameters

Response

Examples

GET Hide
SDKs installed in Pocket Bingo.
/playstore/apps/com.apostek.apps.pocketbingo/sdks?page_size=10
GET Hide
SDKs installed in Shazam.
/playstore/apps/com.shazam.android/sdks?page_size=10

Play Store Apps / Namespaces

Namespaces present in a given app.

Synopsis

GET /playstore/apps/{pname}/namespaces

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Get the namespaces in PicsArt.
/playstore/apps/com.picsart.studio/namespaces
GET Hide
Get the namespaces in Instagram.
/playstore/apps/com.instagram.android/namespaces

Play Store Apps / Versions

Releases of an app.

Synopsis

GET /playstore/apps/{pname}/versions

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Versions of Viber.
/playstore/apps/com.viber.voip/versions?page_size=10

Play Store Apps / APKs

APK files (aka "splits").

Synopsis

GET /playstore/apps/{pname}/versions/{version_code}/apks

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Viber version 640581.
/playstore/apps/com.viber.voip/versions/640581/apks

Play Store Developers / Apps

Apps published by a developer

Synopsis

GET /playstore/developers/{developer_id}/apps

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Get the apps developed by Rovio Mobile Ltd.
/playstore/developers/358123/apps

Play Store Rankings / Lists

Get all ranking lists.

Synopsis

GET /playstore/rankings

Response

Examples

GET Hide
Get all ranking lists.
/playstore/rankings

Play Store Rankings / Rankings

Get app rankings by list. A list is determined by container, category and country.

Synopsis

GET /playstore/rankings/{container}/{category}/{country}

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Rankings of top selling apps in US.
/playstore/rankings/apps_topselling_free/null/US
GET Hide
Rankings of top selling paid photography apps in France as of Dec 01 2021.
/playstore/rankings/apps_topselling_paid/photography/FR?before=2021-12-01
GET Hide
Rankings of top grossing arcade games in Taiwan.
/playstore/rankings/apps_topgrossing/game_arcade/TW

Play Store SDKs / Directory

List of identified SDKs.

Synopsis

GET /playstore/sdks

Optional Parameters

Response

Examples

GET Hide
Top 10 SDKs by rank.
/playstore/sdks?page_size=10
GET Hide
Top 4 SDKs by all-time installs.
/playstore/sdks?sort_field=total_installs&page_size=4
GET Hide
Top 4 SDKs by most uninstalls.
/playstore/sdks?sort_field=uninstalls&page_size=4

Play Store SDKs / Overview

Get summary information about an SDK.

Synopsis

GET /playstore/sdks/{sdk_slug}

Required Parameters

Response

Examples

GET Hide
Get information about the Square SDK.
/playstore/sdks/square
GET Hide
Get information about the StartApp SDK.
/playstore/sdks/startapp

Play Store SDKs / Installs

Get apps that have this SDK installed.

Synopsis

GET /playstore/sdks/{sdk_slug}/installs

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Top 10 apps that have installed the PayPal SDK.
/playstore/sdks/paypal/installs?page_size=10
GET Hide
Top 10 apps that have installed the Google Analytics SDK.
/playstore/sdks/google-analytics/installs?page_size=10

Play Store SDKs / Uninstalls

Get apps that have uninstalled this SDK.

Synopsis

GET /playstore/sdks/{sdk_slug}/uninstalls

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Top 10 apps that have uninstalled the Flurry SDK.
/playstore/sdks/flurry/uninstalls?page_size=10
GET Hide
Top 10 apps by number of ratings that have uninstalled Millennial Media.
/playstore/sdks/millennial-media/uninstalls?page_size=10&sort_field=rating_count

Play Store SDKs / Categories

Get aggregate category data for a given SDK's apps.

Synopsis

GET /playstore/sdks/{sdk_slug}/categories

Required Parameters

Response

Examples

GET Hide
Get category stats for apps that have installed InMobi.
/playstore/sdks/inmobi/categories
GET Hide
Get category stats for apps that have installed Flurry.
/playstore/sdks/flurry/categories

Play Store SDKs / Downloads

Get aggregate download data for a given SDK's apps, broken out by download bucket.

Synopsis

GET /playstore/sdks/{sdk_slug}/downloads

Required Parameters

Response

Examples

GET Hide
Get download stats for apps that have installed the Facebook SDK.
/playstore/sdks/facebook/downloads
GET Hide
Get download stats for apps that have installed the In-app purchases SDK.
/playstore/sdks/google-play-in-app-billing/downloads

Websites / Directory

Directory of websites.

Synopsis

GET /web/sites

Optional Parameters

Response

Examples

GET Hide
Websites by Barns and Noble
/web/sites?company.id=81765662
GET Hide
Search for websites matching "chocolate".
/web/sites?search=chocolate

Websites / Overview

Summary information about a website.

Synopsis

GET /web/sites/{domain}

Required Parameters

Response

Examples

GET Hide
Summary information for google.com.
/web/sites/google.com

Websites / Tags

Tags installed on a given website.

Synopsis

GET /web/sites/{domain}/tags

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Tags found on Toys R Us.
/web/sites/toysrus.com/tags

Web Tags / Overview

Summary information about a web tag.

Synopsis

GET /web/tags/{slug}

Required Parameters

Response

Examples

GET Hide
Summary information for Criteo tag.
/web/tags/adroll

Web Tags / Directory

List of identified tags

Synopsis

GET /web/tags

Optional Parameters

Response

Examples

GET Hide
Top 10 Web Tags by rank.
/web/tags?page_size=10
GET Hide
Top 4 Web Tags by most number of websites with this tag
/web/tags?sort_field=domain_count&page_size=4
GET Hide
Top 4 Web Tags by most number of times seen
/web/tags?sort_field=times_seen&page_size=4

Web Tags / Sites

Web sites that use a given tag.

Synopsis

GET /web/tags/{slug}/sites

Required Parameters

Optional Parameters

Response

Examples

GET Hide
Websites that use Adroll.
/web/tags/adroll/sites