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.
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.
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 access.
All API endpoints will start with https://api.mixrank.com/v2/json/{api_key}/ followed by a query path. Required parameters (marked in bold) will typically be embedded in the url path segment and optional parameters are appended as query string parameters.
For example, dissecting the URL:
https:
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".
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.
Test that your API key is valid.
/echo| Path | Type | Summary |
|---|---|---|
| status | str | "success" if your API key is valid. |
Summary of your API usage for current or past month.
/usage| Name | Summary |
|---|---|
| month | Month to look up usage data for, using YYYY-DD format. If none specified, usage data for the current month will be returned |
| impersonate | Account id to impersonate. |
| Path | Type | Summary |
|---|---|---|
| account_name | str | Your account name. |
| total_events | int | Total API query count. |
| total_data_quantity | int | Amount of data items returned by API queries. |
| details | list[object] | API query and data item count, broken down by category. |
| details[].events | int | Event count for category. |
| details[].data_quantity | int | Data quantity count for category. |
| details[].category | str | Data category. |
Features or feature IDs are a way to codify a set of properties. For
example, the property "currently a software engineer" could be codified
by the feature ID 123 or the property "worked at
Microsoft" by the feature ID 456, and both can be used to
search for people that are currently software engineers or that worked
at Microsoft.
Features are categorized by segments and by types within each segment.
Currently, the supported segments are persons and companies.
Each segment contains features for searching (people or companies) by different criteria. More
segments will be added in the future.
Up to 2000 feature IDs can be returned.
/segment-features/{segment}| Name | Summary |
|---|---|
| segment |
Segment of feature IDs to retrieve. Supported values: persons and companies.
|
| type |
Each segment supports different types of features. PersonsFeature types to search people by:
Feature types to search companies by:
|
| limit |
Default: 100. Min: 1. Number of feature IDs to return. |
| search | Term used for looking up feature IDs. Case insensitive and cannot be longer than 8000 characters. |
| code |
Parameter used for looking up feature IDs by encoded values.
Codes of type
Codes of type
|
| company_id |
Parameter used for looking up feature IDs by a specific company id.
It only works for features of type company.
|
| url |
Parameter used for looking up feature IDs by a specific domain of a
company. It only works for features of type company.
|
| expand_search |
This parameter is used to expand job title feature search to include fuzzier matches.
It only works for features of type job titles.
|
| concat_features |
This parameter concatenates job title feature results in a single string
separated by vertical bars (|), ready to be used as a final query.
The feature_concat response field is populated with the result.
|
| modifiers |
Features support modifiers and they allow for finer
filters. For example, searching for people who previously
worked at a company, the
If this parameter is not passed, all features matching the
|
| Path | Type | Summary |
|---|---|---|
| id | int | Feature ID. |
| mod | str | Search modifier. |
| name | str | Feature name. |
| description | str | Feature description. |
| explanation | str | Feature explanation. |
| feature_concat | str | Null if concat_features is not passed or false. |
Check the status of a result file referenced by a token. If it is
ready, then download starts. File is compressed using zst
to improve download speeds.
Response codes:
200: file is ready and download starts.204: file still being processed.403: access forbidden.404: file not found./segment-result| Name | Summary |
|---|---|
| token | File reference. |
| Path | Type | Summary |
|---|---|---|
| status | str | File status if it is not ready. |
/segment-result?token=a2e1f8c3d7b9e2d6f1e8b0a5c2d3f4b6
Obtain a list of company IDs by making a GET/POST request for long boolean feature queries (see Feature).
/companies/segment-preview/companies/segment-preview| Name | Summary |
|---|---|
| query |
Query composed of feature IDs. Supported operators are:
Parentheses can be used to group expressions, e.g.,
|
| limit |
Default: 100. Min: 1. Max: 2000. Number of company IDs to return. |
Obtain a list of person IDs by making a GET/POST request for long boolean feature queries (see Feature).
/person/segment-preview/person/segment-preview| Name | Summary |
|---|---|
| query |
Query composed of feature IDs. Supported operators are:
Parentheses can be used to group expressions, e.g.,
|
| limit |
Default: 100. Min: 1. Max: 2000. Number of person IDs to return. |
Obtain a list of company IDs by making a GET/POST request for boolean feature queries (see Feature). Instead of immediately returning the results like Company Segment Preview does, a file containing the results is generated which can be downloaded by passing the returned token to the Segment Result endpoint once it is ready, allowing for a larger number of results.
Results have an identical format to those returned by Company Segment Preview: a list of comma-separated company IDs that match the query.
/companies/segment-query/companies/segment-query| Name | Summary |
|---|---|
| query |
Query composed of feature IDs. Supported operators are:
Parentheses can be used to group expressions, e.g.,
|
| Path | Type | Summary |
|---|---|---|
| token | str | Token for downloading the results file. |
Obtain a list of person IDs by making a GET/POST request for boolean feature queries (see Feature). Instead of immediately returning the results like Person Segment Preview does, a file containing the results is generated which can be downloaded by passing the returned token to the Segment Result endpoint once it is ready, allowing for a larger number of results.
Results have an identical format to those returned by Person Segment Preview: a list of comma-separated company IDs that match the query.
/person/segment-query/person/segment-query| Name | Summary |
|---|---|
| query |
Query composed of feature IDs. Supported operators are:
Parentheses can be used to group expressions, e.g.,
|
| Path | Type | Summary |
|---|---|---|
| token | str | Token for downloading the results file. |
Directory of companies.
/companies| Name | Summary |
|---|---|
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rank.
Sort the results by the field specified. Sortable fields: |
| search | Term to search for |
| Path | Type | Summary |
|---|---|---|
| id | int | Company ID. |
| name | str | Company name. |
| slug | str | A unique textual identifier for this company |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| employees | int | Number of current employees at this company. |
| rank_internetretailer | int | Internet Retailer Rank |
| rank_incmagazine | int | Inc. 5000 Rank |
| rank_fortune | int | Fortune Rank |
| address | object | Primary address for this company. |
| address.street_address | str | Street address of this company |
| address.city | str | City of this company |
| address.region | str | State, Province, etc. of this company |
| address.country | str | Country of this company |
| address.postal_code | str | Postal routing code of this company |
| object | LinkedIn company profile. | |
| linkedin.id | int | LinkedIn company ID. |
| linkedin.website | str | LinkedIn company website. |
| linkedin.url | str | LinkedIn company URL. |
| linkedin.type | str | Description of the company type (e.g. "Public Company", "Privately Held"). |
| linkedin.size | str | Description of the company size in terms of employees (e.g. "1-10 employees", "10,001+ employees"). |
| linkedin.name | str | Name. |
| linkedin.founded | int | Foundation year. |
| linkedin.description | str | Description. |
| linkedin.locations | list[object] | Locations. |
| linkedin.locations[].address | str | Location address. |
| linkedin.locations[].is_primary | bool | Boolean flag to distinguish between the primary location and the rest, "true" when is considered a primary address, otherwise "false". |
| linkedin.country | str | Two letters country code (ISO 3166-1 alpha-2). |
| linkedin.specialties | list[str] | Company specialties (e.g. "AI", "Cloud Computing"). |
| linkedin.employee_count | int | Employee count. |
| linkedin.follower_count | int | Followers on LinkedIn. |
| linkedin.logo_url | str | Company logo download URL. |
| web | object | Objects on the web |
| web.site_count | int | number of websites published by this company. |
| web.tag_count | int | number of Web Tags produced by this company. |
| appstore | object | Objects in the Apple App Store |
| appstore.app_count | int | number of iOS apps published by this company. |
| appstore.sdk_count | int | number of iOS SDKs produced by this company. |
| playstore | object | Objects in the Google Play Store |
| playstore.app_count | int | number of Android apps published by this company. |
| playstore.sdk_count | int | number of Android SDKs produced by this company. |
| industries | list[object] | Company industries. |
| industries[].id | int | Industry ID |
| industries[].name | str | Industry name |
| industries[].is_primary | bool | Whether or not this is a primary industry that this company is involved in |
| sic | list[object] | Standard Industry Classification codes for this company. |
| sic[].id | str | Industry ID |
| sic[].name | str | Industry name |
| naics | list[object] | North American Industry Classification System codes for this company. |
| naics[].id | str | Industry ID |
| naics[].name | str | Industry name |
Summary information about a company.
/companies/{company_id}| Name | Summary |
|---|---|
| company_id |
Min: -inf. The ID of the company. |
| Path | Type | Summary |
|---|---|---|
| id | int | Company ID. |
| name | str | Company name. |
| slug | str | A unique textual identifier for this company |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| employees | int | Number of current employees at this company. |
| rank_internetretailer | int | Internet Retailer Rank |
| rank_incmagazine | int | Inc. 5000 Rank |
| rank_fortune | int | Fortune Rank |
| address | object | Primary address for this company. |
| address.street_address | str | Street address of this company |
| address.city | str | City of this company |
| address.region | str | State, Province, etc. of this company |
| address.country | str | Country of this company |
| address.postal_code | str | Postal routing code of this company |
| object | LinkedIn company profile. | |
| linkedin.id | int | LinkedIn company ID. |
| linkedin.website | str | LinkedIn company website. |
| linkedin.url | str | LinkedIn company URL. |
| linkedin.type | str | Description of the company type (e.g. "Public Company", "Privately Held"). |
| linkedin.size | str | Description of the company size in terms of employees (e.g. "1-10 employees", "10,001+ employees"). |
| linkedin.name | str | Name. |
| linkedin.founded | int | Foundation year. |
| linkedin.description | str | Description. |
| linkedin.locations | list[object] | Locations. |
| linkedin.locations[].address | str | Location address. |
| linkedin.locations[].is_primary | bool | Boolean flag to distinguish between the primary location and the rest, "true" when is considered a primary address, otherwise "false". |
| linkedin.country | str | Two letters country code (ISO 3166-1 alpha-2). |
| linkedin.specialties | list[str] | Company specialties (e.g. "AI", "Cloud Computing"). |
| linkedin.employee_count | int | Employee count. |
| linkedin.follower_count | int | Followers on LinkedIn. |
| linkedin.logo_url | str | Company logo download URL. |
| web | object | Objects on the web |
| web.site_count | int | number of websites published by this company. |
| web.tag_count | int | number of Web Tags produced by this company. |
| appstore | object | Objects in the Apple App Store |
| appstore.app_count | int | number of iOS apps published by this company. |
| appstore.sdk_count | int | number of iOS SDKs produced by this company. |
| playstore | object | Objects in the Google Play Store |
| playstore.app_count | int | number of Android apps published by this company. |
| playstore.sdk_count | int | number of Android SDKs produced by this company. |
| industries | list[object] | Company industries. |
| industries[].id | int | Industry ID |
| industries[].name | str | Industry name |
| industries[].is_primary | bool | Whether or not this is a primary industry that this company is involved in |
| sic | list[object] | Standard Industry Classification codes for this company. |
| sic[].id | str | Industry ID |
| sic[].name | str | Industry name |
| naics | list[object] | North American Industry Classification System codes for this company. |
| naics[].id | str | Industry ID |
| naics[].name | str | Industry name |
Query the companies databases for best matches. Results ordered by relevance.
/companies/match| Name | Summary |
|---|---|
| name | Company name. |
| url | Domain name, website url. |
| Company's LinkedIn url. |
| Path | Type | Summary |
|---|---|---|
| id | int | Company ID. |
| name | str | Company name. |
| slug | str | A unique textual identifier for this company |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| employees | int | Number of current employees at this company. |
| rank_internetretailer | int | Internet Retailer Rank |
| rank_incmagazine | int | Inc. 5000 Rank |
| rank_fortune | int | Fortune Rank |
| address | object | Primary address for this company. |
| address.street_address | str | Street address of this company |
| address.city | str | City of this company |
| address.region | str | State, Province, etc. of this company |
| address.country | str | Country of this company |
| address.postal_code | str | Postal routing code of this company |
| object | LinkedIn company profile. | |
| linkedin.id | int | LinkedIn company ID. |
| linkedin.website | str | LinkedIn company website. |
| linkedin.url | str | LinkedIn company URL. |
| linkedin.type | str | Description of the company type (e.g. "Public Company", "Privately Held"). |
| linkedin.size | str | Description of the company size in terms of employees (e.g. "1-10 employees", "10,001+ employees"). |
| linkedin.name | str | Name. |
| linkedin.founded | int | Foundation year. |
| linkedin.description | str | Description. |
| linkedin.locations | list[object] | Locations. |
| linkedin.locations[].address | str | Location address. |
| linkedin.locations[].is_primary | bool | Boolean flag to distinguish between the primary location and the rest, "true" when is considered a primary address, otherwise "false". |
| linkedin.country | str | Two letters country code (ISO 3166-1 alpha-2). |
| linkedin.specialties | list[str] | Company specialties (e.g. "AI", "Cloud Computing"). |
| linkedin.employee_count | int | Employee count. |
| linkedin.follower_count | int | Followers on LinkedIn. |
| linkedin.logo_url | str | Company logo download URL. |
| web | object | Objects on the web |
| web.site_count | int | number of websites published by this company. |
| web.tag_count | int | number of Web Tags produced by this company. |
| appstore | object | Objects in the Apple App Store |
| appstore.app_count | int | number of iOS apps published by this company. |
| appstore.sdk_count | int | number of iOS SDKs produced by this company. |
| playstore | object | Objects in the Google Play Store |
| playstore.app_count | int | number of Android apps published by this company. |
| playstore.sdk_count | int | number of Android SDKs produced by this company. |
| industries | list[object] | Company industries. |
| industries[].id | int | Industry ID |
| industries[].name | str | Industry name |
| industries[].is_primary | bool | Whether or not this is a primary industry that this company is involved in |
| sic | list[object] | Standard Industry Classification codes for this company. |
| sic[].id | str | Industry ID |
| sic[].name | str | Industry name |
| naics | list[object] | North American Industry Classification System codes for this company. |
| naics[].id | str | Industry ID |
| naics[].name | str | Industry name |
Employee and followers trends about a company.
/companies/{company_id}/timeseries| Name | Summary |
|---|---|
| company_id |
Min: -inf. The ID of the company. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 100. Min: 1. Max: 1000. Number of results to return. |
| Path | Type | Summary |
|---|---|---|
| date | date | The date this sample was taken. |
| employee_count | int | Number of employees (headcount). |
| linkedin_follower_count | int | Number of LinkedIn followers. |
| facebook_like_count | int | Number of Facebook likes. |
| twitter_follower_count | int | Number of Twitter followers. |
| seomoz_link_count | int | Number of Seomoz links. |
Obtain a list of company IDs by making a GET/POST request for long boolean feature queries (see Feature).
/companies/segment-preview/companies/segment-preview| Name | Summary |
|---|---|
| query |
Query composed of feature IDs. Supported operators are:
Parentheses can be used to group expressions, e.g.,
|
| limit |
Default: 100. Min: 1. Max: 2000. Number of company IDs to return. |
Obtain a list of company IDs by making a GET/POST request for boolean feature queries (see Feature). Instead of immediately returning the results like Company Segment Preview does, a file containing the results is generated which can be downloaded by passing the returned token to the Segment Result endpoint once it is ready, allowing for a larger number of results.
Results have an identical format to those returned by Company Segment Preview: a list of comma-separated company IDs that match the query.
/companies/segment-query/companies/segment-query| Name | Summary |
|---|---|
| query |
Query composed of feature IDs. Supported operators are:
Parentheses can be used to group expressions, e.g.,
|
| Path | Type | Summary |
|---|---|---|
| token | str | Token for downloading the results file. |
Obtain a list of person IDs by making a GET/POST request for long boolean feature queries (see Feature).
/person/segment-preview/person/segment-preview| Name | Summary |
|---|---|
| query |
Query composed of feature IDs. Supported operators are:
Parentheses can be used to group expressions, e.g.,
|
| limit |
Default: 100. Min: 1. Max: 2000. Number of person IDs to return. |
Obtain a list of person IDs by making a GET/POST request for boolean feature queries (see Feature). Instead of immediately returning the results like Person Segment Preview does, a file containing the results is generated which can be downloaded by passing the returned token to the Segment Result endpoint once it is ready, allowing for a larger number of results.
Results have an identical format to those returned by Person Segment Preview: a list of comma-separated company IDs that match the query.
/person/segment-query/person/segment-query| Name | Summary |
|---|---|
| query |
Query composed of feature IDs. Supported operators are:
Parentheses can be used to group expressions, e.g.,
|
| Path | Type | Summary |
|---|---|---|
| token | str | Token for downloading the results file. |
Directory of iOS apps.
/appstore/apps| Name | Summary |
|---|---|
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rank.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| company.id | Filter results by company ID. |
| search | Term to search for |
| Path | Type | Summary |
|---|---|---|
| id | str | The unique integer identifier for this app. |
| bundle_id | str | The unique string identifier for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer | str | The name of the app developer. |
| company_url | str | Company website. |
| support_url | str | Support website. |
| privacy_policy_url | str | App's privacy policy. |
| seller | str | The name of the app seller. |
| copyright | str | App's copyright notice. |
| downloaded | bool | Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the first version of this app. |
| small_artwork_url | str | Small 60x60 app icon. |
| large_artwork_url | str | Large 100x100 app icon. |
| xlarge_artwork_url | str | Extra large 512x512 app icon. |
| genre | str | Genre this app is in. |
| genres | str | Sub-genres this app is in. |
| configs_count | int | The number of configuration properties extracted from the app's info.plist (across all inspected versions). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.version_number | str | Unique identifier of binary. |
| version.version_string | str | Human-friendly version number. |
| content_rating | str | Content safety rating. |
| content_rating_details | str | Content safety rating details. |
Summary information about a App Store app.
/appstore/apps/{app_id}| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| Path | Type | Summary |
|---|---|---|
| id | str | The unique integer identifier for this app. |
| bundle_id | str | The unique string identifier for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer | str | The name of the app developer. |
| company_url | str | Company website. |
| support_url | str | Support website. |
| privacy_policy_url | str | App's privacy policy. |
| seller | str | The name of the app seller. |
| copyright | str | App's copyright notice. |
| downloaded | bool | Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the first version of this app. |
| small_artwork_url | str | Small 60x60 app icon. |
| large_artwork_url | str | Large 100x100 app icon. |
| xlarge_artwork_url | str | Extra large 512x512 app icon. |
| genre | str | Genre this app is in. |
| genres | str | Sub-genres this app is in. |
| configs_count | int | The number of configuration properties extracted from the app's info.plist (across all inspected versions). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.version_number | str | Unique identifier of binary. |
| version.version_string | str | Human-friendly version number. |
| content_rating | str | Content safety rating. |
| content_rating_details | str | Content safety rating details. |
| developer_link | str | Developer's itunes profile. |
| ratings | object | Number of ratings per star. |
| ratings.1 | int | |
| ratings.2 | int | |
| ratings.3 | int | |
| ratings.4 | int | |
| ratings.5 | int | |
| summary | str | The description of this app |
| installation_size | int | Size of the app in bytes. |
| price | str | Price for this app in US appstore. |
| compatibility | object | Restrictions on Supported Devices |
| compatibility.min_ios_version | str | |
| compatibility.supported_devices | list[str] | |
| screenshot_urls | list[str] | Screenshots for iPhone, iPod. |
| ipad_screenshot_urls | list[str] | Screenshots for iPad |
| privacy_label_ids | list[int] | Privacy label id. |
Rankings for an app. Apps are ranked in "lists" which are made up of a container, a country, and a genre.
/appstore/apps/{app_id}/rankings| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| Path | Type | Summary |
|---|---|---|
| id | int | List ID. |
| container | str | List container. |
| genre | str | List genre. |
| country | str | List country. |
| current_rank | int | The current rank the app is at in this list. |
| highest_rank | int | The highest rank the app achieved in this list. |
| first_ranked | date | The date this app first ranked in this list. |
| last_ranked | date | The date this app last ranked in this list. |
Ranking history for an app in a given ranking list.
/appstore/apps/{app_id}/rankings-history| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| container | Container name from /appstore/rankings. |
| genre | Category name from /appstore/rankings. |
| country | Category name from /appstore/rankings. |
| before | Return rankings before given date (in UTC). |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| Path | Type | Summary |
|---|---|---|
| ranking | int | The current rank of this app at this time. |
| date | datetime | When this ranking list was generated by Apple (UTC). |
SDKs installed in a given app.
/appstore/apps/{app_id}/sdks| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 500. Number of results to return. |
| sort_field |
Default: version_code_min.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| name | str | Name of the SDK. |
| slug | str | ID of the SDK. |
| upload_date_min | date | The upload date of the oldest version of the app with this SDK installed. |
| upload_date_max | date | The upload date of the newest version of the app with this SDK installed. |
| version_code_min | int | The oldest version of the app we've observed with this SDK. |
| version_code_max | int | The newest version of the app we've observed with this SDK. |
| currently_installed | bool | Indicates if the SDK is currently installed in the app. |
| sdk_version | str | Version of the SDK in use. |
Configuration options for iOS apps from embedded info.plist documents.
/appstore/apps/{app_id}/configs| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| Path | Type | Summary |
|---|---|---|
| version | str | The version of the app analyzed. |
| plist | str | The plist document embedded in the app. |
Releases of an app.
/appstore/apps/{app_id}/versions| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: id.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| id | int | Version ID (unique globally). |
| asset_size | int | Size of IPA in bytes. |
| config_count | int | Number of Info.plist configs. |
| class_count | int | Number of classes in binary. |
| resource_count | int | Number of files in bundle. |
| version_display | str | Human-friendly version number. |
| release_date | date | Date this version was released to the store. |
| release_notes | str | Developer's release notes. |
In-App purchases offered by this app.
/appstore/apps/{app_id}/iaps| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: id.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| id | int | In-app purchase ID (unique globally). |
| name | str | Name of in-app purchase. |
| price_str | str | String-formatted purchase price of in-app purchase. |
User reviews of a given app.
/appstore/apps/{app_id}/reviews| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: date.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| id | int | Review ID. |
| user_id | int | iTunes user ID. |
| username | str | iTunes username. |
| rating | int | Star rating (1-5). |
| version | str | Version of app the user is reviewing. |
| date | date | When the user submitted the review. |
| vote_yes | int | Number of users that voted this review as helpful. |
| vote_no | int | Number of users that voted this review as unhelpful. |
| title | str | Title of the review. |
| body | str | Body of the review. |
| country_id | str | Country code of the store the user downloaded the app from. |
Download trends for a given app.
/appstore/apps/{app_id}/downloads| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| interval |
Default: 1 month. Duration to retrieve data for. Possible values: '1 month', '3 month', '6 month', '12 month' |
| country | 2-letter ISO country code. |
| offset | Interval offset, in months. |
| Path | Type | Summary |
|---|---|---|
| country | str | Name of country for downloads timeseries. |
| data | list[list] | Data for downloads timeseries. |
Revenue trends for a given app.
/appstore/apps/{app_id}/revenue| Name | Summary |
|---|---|
| app_id | The ID of the app - either the MixRank ID or the iOS bundle ID |
| interval |
Default: 1 month. Duration to retrieve data for. Possible values: '1 month', '3 month', '6 month', '12 month' |
| country | 2-letter ISO country code. |
| offset | Interval offset, in months. |
| Path | Type | Summary |
|---|---|---|
| country | str | Name of country for revenue timeseries. |
| data | list[list] | Data for revenue timeseries. |
Apps published by a developer
/appstore/developers/{developer_id}/apps| Name | Summary |
|---|---|
| developer_id | The ID of the developer. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rating_count.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| id | str | The unique integer identifier for this app. |
| bundle_id | str | The unique string identifier for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer | str | The name of the app developer. |
| company_url | str | Company website. |
| support_url | str | Support website. |
| privacy_policy_url | str | App's privacy policy. |
| seller | str | The name of the app seller. |
| copyright | str | App's copyright notice. |
| downloaded | bool | Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the first version of this app. |
| small_artwork_url | str | Small 60x60 app icon. |
| large_artwork_url | str | Large 100x100 app icon. |
| xlarge_artwork_url | str | Extra large 512x512 app icon. |
| genre | str | Genre this app is in. |
| genres | str | Sub-genres this app is in. |
| configs_count | int | The number of configuration properties extracted from the app's info.plist (across all inspected versions). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.version_number | str | Unique identifier of binary. |
| version.version_string | str | Human-friendly version number. |
| content_rating | str | Content safety rating. |
| content_rating_details | str | Content safety rating details. |
Possible privacy labels for iOS apps from App store.
/appstore/privacy/labels| Path | Type | Summary |
|---|---|---|
| id | int | Privacy label id. |
| datatype_id | int | Privacy label datatype id. |
| linkage_id | int | Privacy label linkage id. |
| purpose_id | int | Privacy label purpose id. |
Possible privacy data types and categories for iOS apps from App store.
/appstore/privacy/datatype| Path | Type | Summary |
|---|---|---|
| id | int | Privacy data type id. |
| category_label | str | Privacy data category label. |
| category_identifier | str | Privacy data category identifier. |
| label | str | Privacy data type label. |
| description | str | Privacy data type description. |
Possible privacy types (linkages) for iOS apps from App store.
/appstore/privacy/linkage| Path | Type | Summary |
|---|---|---|
| id | int | Privacy linkage id. |
| label | str | Privacy linkage label. |
| identifier | str | Privacy linkage identifier. |
| description | str | Privacy linkage description. |
Possible privacy data collection purposes for iOS apps from App store.
/appstore/privacy/purpose| Path | Type | Summary |
|---|---|---|
| id | int | Privacy data collection purpose id. |
| label | str | Privacy data collection purpose label. |
| identifier | str | Privacy data collection purpose identifier. |
| description | str | Privacy data collection purpose description. |
Get all ranking list options. A list is determined by a container, genre, and country.
/appstore/rankings| Path | Type | Summary |
|---|---|---|
| containers | list[str] | List of iOS rankings containers, eg "topfreeapplications". |
| genres | list[str] | List of iOS genres, eg "ios-games-racing". |
| countries | list[str] | List of iOS rankings countries, eg "us". |
Get app rankings by list. A list is determined by container, a genre, and a country.
/appstore/rankings/{container}/{genre}/{country}| Name | Summary |
|---|---|
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: ranking.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: asc.
Sort the results in the order specified. Sortable directions: |
| container | Container name from /appstore/rankings. |
| genre | Category name from /appstore/rankings. |
| country | Category name from /appstore/rankings. |
| before | Return ranking list as it appeared before given date (in UTC). |
| Path | Type | Summary |
|---|---|---|
| id | str | The unique integer identifier for this app. |
| bundle_id | str | The unique string identifier for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer | str | The name of the app developer. |
| company_url | str | Company website. |
| support_url | str | Support website. |
| privacy_policy_url | str | App's privacy policy. |
| seller | str | The name of the app seller. |
| copyright | str | App's copyright notice. |
| downloaded | bool | Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the first version of this app. |
| small_artwork_url | str | Small 60x60 app icon. |
| large_artwork_url | str | Large 100x100 app icon. |
| xlarge_artwork_url | str | Extra large 512x512 app icon. |
| genre | str | Genre this app is in. |
| genres | str | Sub-genres this app is in. |
| configs_count | int | The number of configuration properties extracted from the app's info.plist (across all inspected versions). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.version_number | str | Unique identifier of binary. |
| version.version_string | str | Human-friendly version number. |
| content_rating | str | Content safety rating. |
| content_rating_details | str | Content safety rating details. |
| ranking | int | The current rank of this app. |
| ranking_date | datetime | When this ranking list was generated by Apple (UTC). |
List of identified SDKs.
/appstore/sdks| Name | Summary |
|---|---|
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rank.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| rank | int | MixRank Rank |
| score | float | Score of this SDK |
| name | str | Name of the SDK. |
| id | int | Unique integer ID of this SDK |
| slug | str | Identifies this SDK. |
| total_installs | int | Number of apps that have ever installed this SDK. |
| current_installs | int | Number of apps that currently have this SDK installed. |
| uninstalls | int | Number of apps that have uninstalled this SDK. |
Get summary information about an SDK.
/appstore/sdks/{sdk_slug}| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| Path | Type | Summary |
|---|---|---|
| name | str | Name of this SDK. |
| slug | str | ID of this SDK. |
| description | str | Description of this SDK. |
| tags | list[str] | Tags indicating types of SDK. |
| url | str | Usually points to the company or documentation page for this SDK. |
| logo_url | str | Logo for the SDK/company. |
| publisher_count | int | Number of app publishers that have ever installed this SDK. |
| total_installs | int | Number of apps that have ever installed this SDK. |
| current_installs | int | Number of apps that currently have this SDK installed. |
| uninstalls | int | Number of apps that have uninstalled this SDK. |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
Get apps that have this SDK installed.
/appstore/sdks/{sdk_slug}/installs| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rank.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| id | str | The unique integer identifier for this app. |
| bundle_id | str | The unique string identifier for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer | str | The name of the app developer. |
| company_url | str | Company website. |
| support_url | str | Support website. |
| privacy_policy_url | str | App's privacy policy. |
| seller | str | The name of the app seller. |
| copyright | str | App's copyright notice. |
| downloaded | bool | Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the first version of this app. |
| small_artwork_url | str | Small 60x60 app icon. |
| large_artwork_url | str | Large 100x100 app icon. |
| xlarge_artwork_url | str | Extra large 512x512 app icon. |
| genre | str | Genre this app is in. |
| genres | str | Sub-genres this app is in. |
| configs_count | int | The number of configuration properties extracted from the app's info.plist (across all inspected versions). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.version_number | str | Unique identifier of binary. |
| version.version_string | str | Human-friendly version number. |
| content_rating | str | Content safety rating. |
| content_rating_details | str | Content safety rating details. |
Get historical count of apps that have this SDK installed.
/appstore/sdks/{sdk_slug}/install-trend| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| Path | Type | Summary |
|---|---|---|
| total_installs | int | Count of apps that ever used this SDK at this date. |
| current_installs | int | Count of apps that were using this SDK at this date. |
| uninstalls | int | Count of apps that used this SDK before this date, but removed it. |
| date | datetime | Date this count was taken. |
Get apps that have uninstalled this SDK.
/appstore/sdks/{sdk_slug}/uninstalls| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rank.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| id | str | The unique integer identifier for this app. |
| bundle_id | str | The unique string identifier for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer | str | The name of the app developer. |
| company_url | str | Company website. |
| support_url | str | Support website. |
| privacy_policy_url | str | App's privacy policy. |
| seller | str | The name of the app seller. |
| copyright | str | App's copyright notice. |
| downloaded | bool | Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the first version of this app. |
| small_artwork_url | str | Small 60x60 app icon. |
| large_artwork_url | str | Large 100x100 app icon. |
| xlarge_artwork_url | str | Extra large 512x512 app icon. |
| genre | str | Genre this app is in. |
| genres | str | Sub-genres this app is in. |
| configs_count | int | The number of configuration properties extracted from the app's info.plist (across all inspected versions). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.version_number | str | Unique identifier of binary. |
| version.version_string | str | Human-friendly version number. |
| content_rating | str | Content safety rating. |
| content_rating_details | str | Content safety rating details. |
Get aggregate genre data for a given SDK's apps.
/appstore/sdks/{sdk_slug}/genres| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| Path | Type | Summary |
|---|---|---|
| genre | str | The identifier for this genre. |
| total_installs | int | Number of apps that have ever installed this SDK in this genre. |
| current_installs | int | Number of apps that currently have this SDK installed in this genre. |
| uninstalls | int | Number of apps that have uninstalled this SDK in this genre. |
Releases of an SDK
/appstore/sdks/{sdk_slug}/versions| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| Path | Type | Summary |
|---|---|---|
| id | int | The unique ID of this entity |
| version | str | The version number of the release |
| name | str | The name of the SDK in this version |
| summary | str | Summary |
| description | str | Detailed description beyond what is in the summary |
| homepage | str | Homepage link for this SDK |
| documentation_url | str | Link to SDK documentation |
| social_media_url | str | Link to the social media page for this SDK |
| source | object | A mapping of details about the source of this SDK, such as the git repo and tag. |
| platform | list[str] | The platform on which this SDK is supported |
| ios_deployment_target | str | The minimum deployment targets of the supported platform |
| authors | object | A mapping of details about the SDK authors |
| license | object | A mapping of details about the SDK license |
| screenshots | list[str] | List of screenshots listed by this SDK |
| other_data | object | A mapping of miscellaneous data about this SDK |
| xcconfig | object | A mapping of xcconfig entries |
| source_files | list[str] | List of file-path patterns for the included source files |
| public_header_files | list[str] | List of file-path patterns for public header files |
| preserve_paths | list[str] | List of file-path patterns specified preserve_path which should not be removed after being downloaded |
| exclude_files | list[str] | List of file-path patterns in exclude_files |
| vendored_libraries | list[str] | List of file-path patterns for vendored libraries |
| vendored_frameworks | list[str] | List of file-path patterns for vendored frameworks that come shipped with the SDK |
| resources | list[str] | List of file-path patterns for included resources |
| libraries | list[str] | List of dependent system libraries that are linked against |
| frameworks | list[str] | List of dependent system frameworks that are linked against |
| weak_frameworks | list[str] | A list of frameworks that the SDK target weakly links against. |
| private_header_files | list[str] | List of file-path patterns for private header files |
| requires_arc | bool | Whether this SDK requires ARC (Automatic Reference Counting) |
| default_subspec | str | The specified list of subspecs names to indicate preferred dependencies |
| dependencies | list[str] | List of dependencies |
Directory of Play Store (Android) apps.
/playstore/apps| Name | Summary |
|---|---|
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: downloads.
Sort the results by the field specified. Sortable fields: |
| company.id | Filter results by company ID. |
| search | Term to search for |
| Path | Type | Summary |
|---|---|---|
| pname | str | The package name for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer_name | str | The name of the app publisher. Usually a company or individual's name. |
| developer_email | str | Email address of the developer, from the public profile. |
| developer_website | str | Developer's website. |
| downloads | int | The approximate number of downloads for this app. |
| removed | bool | Indicates if this app has been removed from the playstore. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the earliest version of this app. |
| small_icon_url | str | 48x48 app icon (deprecated). |
| large_icon_url | str | 512x512 app icon. |
| category | str | The primary category of this app. |
| categories | str | All categories of this app (includes alternates like android_wear). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.major_version_number | int | Major version number. |
| version.version_code | int | Internal unique version code. |
| version.version_string | str | User-visible version number. |
Summary information about a Play Store app.
/playstore/apps/{pname}| Name | Summary |
|---|---|
| pname | The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android". |
| Path | Type | Summary |
|---|---|---|
| pname | str | The package name for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer_name | str | The name of the app publisher. Usually a company or individual's name. |
| developer_email | str | Email address of the developer, from the public profile. |
| developer_website | str | Developer's website. |
| downloads | int | The approximate number of downloads for this app. |
| removed | bool | Indicates if this app has been removed from the playstore. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the earliest version of this app. |
| small_icon_url | str | 48x48 app icon (deprecated). |
| large_icon_url | str | 512x512 app icon. |
| category | str | The primary category of this app. |
| categories | str | All categories of this app (includes alternates like android_wear). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.major_version_number | int | Major version number. |
| version.version_code | int | Internal unique version code. |
| version.version_string | str | User-visible version number. |
| permissions | list[str] | List of permissions this app requires. |
| ratings | object | Number of ratings per star. |
| ratings.1 | int | |
| ratings.2 | int | |
| ratings.3 | int | |
| ratings.4 | int | |
| ratings.5 | int | |
| recent_changes_html | str | The recent changes HTML. |
| description_html | str | The HTML description of this app. |
| installation_size | int | Size of the app in bytes. |
| content_rating | int | The content safety rating (1-5). See: https://support.google.com/googleplay/answer/1075738?hl=en. |
| content_rating_details | list[str] | Content safety rating details. |
| version | object | An object with several fields: major_version_number, version_code (internal unique version code), version_string (pretty version number). |
| version.major_version_number | int | |
| version.version_code | int | |
| version.version_string | str | |
| prices | list[object] | List of prices for this app in different currencies. |
| prices[].native_currency | str | |
| prices[].native_price | int | |
| prices[].converted_currency | str | |
| prices[].converted_price | int |
Get image and video assets for an app. Includes icons and screenshots.
/playstore/apps/{pname}/images| Name | Summary |
|---|---|
| pname | The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android". |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 100. Min: 1. Max: 100. Number of results to return. |
| Path | Type | Summary |
|---|---|---|
| url | str | Image url. |
| type | object | Meta info about this asset. |
Rankings for an app. Apps are ranked in "lists" which are made up of a container, and (optionally) a category.
/playstore/apps/{pname}/rankings| Name | Summary |
|---|---|
| pname | The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android". |
| country |
Default: US. Two letters country code (ISO 3166-1 alpha-2) |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: current_rank.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| container | str | List container. |
| country | str | List country. |
| category | str | The category this app is in. |
| current_rank | int | The current rank the app is at in this list. |
| highest_rank | int | The highest rank the app achieved in this list. |
| first_ranked | date | The date this app first ranked in this list. |
| last_ranked | date | The date this app last ranked in this list. |
Ranking history for an app in a given ranking list.
/playstore/apps/{pname}/rankings-history| Name | Summary |
|---|---|
| pname | The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android". |
| country |
Default: US. Two letters country code (ISO 3166-1 alpha-2) |
| container | Container name from /playstore/rankings. |
| category | Category name from /playstore/rankings. |
| before | Return rankings before given date (in UTC). |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| Path | Type | Summary |
|---|---|---|
| country | str | List country. |
| ranking | int | The current rank of this app at this time. |
| date | datetime | When this ranking list was generated by Google (UTC). |
SDKs installed in a given app.
/playstore/apps/{pname}/sdks| Name | Summary |
|---|---|
| pname | The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android". |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 500. Number of results to return. |
| sort_field |
Default: version_code_min.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| name | str | Name of the SDK. |
| slug | str | ID of the SDK. |
| upload_date_min | date | The upload date of the oldest version of the app with this SDK installed. |
| upload_date_max | date | The upload date of the newest version of the app with this SDK installed. |
| version_code_min | int | The oldest version of the app we've observed with this SDK. |
| version_code_max | int | The newest version of the app we've observed with this SDK. |
| currently_installed | bool | Indicates if the SDK is currently installed in the app. |
Namespaces present in a given app.
/playstore/apps/{pname}/namespaces| Name | Summary |
|---|---|
| pname | The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android". |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: version_code_min.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| namespace | str | The namespace name. |
| upload_date_min | date | The upload date of the oldest version of the app with this namespace present. |
| upload_date_max | date | The upload date of the newest version of the app with this namespace present. |
| version_code_min | int | The oldest version of the app we've observed with this namespace present. |
| version_code_max | int | The newest version of the app we've observed with this namespace present. |
| currently_installed | bool | Indicates if the namespace is currently present in the app. |
Releases of an app.
/playstore/apps/{pname}/versions| Name | Summary |
|---|---|
| pname | The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android". |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: version_code.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| id | int | Version ID (unique per app). |
| asset_size | int | Size of APK in bytes. |
| version_string | str | Human-friendly version number. |
| downloaded | bool | Indicates if the APK has been downloaded. |
| is_latest | bool | Indicates if this is the latest version available on Play Store (null if unknown). |
| latest_since | datetime | If this is the latest version available on Play Store, the date when it was last checked. |
| release_date | date | Date this version was released to the store |
| release_notes | str | Developer's releases notes. |
APK files (aka "splits").
/playstore/apps/{pname}/versions/{version_code}/apks| Name | Summary |
|---|---|
| pname | The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android". |
| version_code | The unique integer version code. |
| Path | Type | Summary |
|---|---|---|
| id | int | Unique ID. |
| name | str | APK split filename. |
| byte_size | int | Size of APK split in bytes. |
| download_at | date | Date this APK split was downloaded. |
| md5 | str | MD5 hash of file. |
| sha1 | str | SHA1 hash of file. |
| sha256 | str | SHA256 hash of file. |
| namespace_count | int | Java namespace count. |
| permission_count | int | Android permission count. |
| s3uri | str | Path in s3 to download this APK split file. |
Apps published by a developer
/playstore/developers/{developer_id}/apps| Name | Summary |
|---|---|
| developer_id | The ID of the developer. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: downloads.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| pname | str | The package name for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer_name | str | The name of the app publisher. Usually a company or individual's name. |
| developer_email | str | Email address of the developer, from the public profile. |
| developer_website | str | Developer's website. |
| downloads | int | The approximate number of downloads for this app. |
| removed | bool | Indicates if this app has been removed from the playstore. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the earliest version of this app. |
| small_icon_url | str | 48x48 app icon (deprecated). |
| large_icon_url | str | 512x512 app icon. |
| category | str | The primary category of this app. |
| categories | str | All categories of this app (includes alternates like android_wear). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.major_version_number | int | Major version number. |
| version.version_code | int | Internal unique version code. |
| version.version_string | str | User-visible version number. |
Get all ranking lists.
/playstore/rankings| Path | Type | Summary |
|---|---|---|
| container | str | The name of this container. |
| category | str | The category within this container. |
Get app rankings by list. A list is determined by container, category and country.
/playstore/rankings/{container}/{category}/{country}| Name | Summary |
|---|---|
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: ranking.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: asc.
Sort the results in the order specified. Sortable directions: |
| container | Container name from /playstore/rankings. |
| category | Category name from /playstore/rankings or "null" for all-category charts. |
| country | 2-letter country code, upper case (ISO 3166). |
| before | Return ranking list as it appeared before given date (in UTC). |
| Path | Type | Summary |
|---|---|---|
| pname | str | The package name for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer_name | str | The name of the app publisher. Usually a company or individual's name. |
| developer_email | str | Email address of the developer, from the public profile. |
| developer_website | str | Developer's website. |
| downloads | int | The approximate number of downloads for this app. |
| removed | bool | Indicates if this app has been removed from the playstore. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the earliest version of this app. |
| small_icon_url | str | 48x48 app icon (deprecated). |
| large_icon_url | str | 512x512 app icon. |
| category | str | The primary category of this app. |
| categories | str | All categories of this app (includes alternates like android_wear). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.major_version_number | int | Major version number. |
| version.version_code | int | Internal unique version code. |
| version.version_string | str | User-visible version number. |
| ranking | int | Rank within the list. |
| ranking_date | datetime | When this ranking list was generated by Google (UTC). |
List of identified SDKs.
/playstore/sdks| Name | Summary |
|---|---|
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rank.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| rank | int | MixRank Rank. |
| score | float | Score of the SDK |
| name | str | Name of the SDK. |
| id | int | Unique integer ID of this SDK |
| slug | str | Identifies this SDK. |
| total_installs | int | Number of apps that have ever installed this SDK. |
| current_installs | int | Number of apps that currently have this SDK installed. |
| uninstalls | int | Number of apps that have uninstalled this SDK. |
Get summary information about an SDK.
/playstore/sdks/{sdk_slug}| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| Path | Type | Summary |
|---|---|---|
| name | str | Name of this SDK. |
| slug | str | ID of this SDK. |
| description | str | Description of this SDK. |
| tags | list[str] | Tags indicating types of SDK. |
| url | str | Usually points to the company or documentation page for this SDK. |
| logo_url | str | Logo for the SDK/company. |
| publisher_count | int | Number of app publishers that have ever installed this SDK. |
| total_installs | int | Number of apps that have ever installed this SDK. |
| current_installs | int | Number of apps that currently have this SDK installed. |
| uninstalls | int | Number of apps that have uninstalled this SDK. |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
Get apps that have this SDK installed.
/playstore/sdks/{sdk_slug}/installs| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: downloads.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| pname | str | The package name for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer_name | str | The name of the app publisher. Usually a company or individual's name. |
| developer_email | str | Email address of the developer, from the public profile. |
| developer_website | str | Developer's website. |
| downloads | int | The approximate number of downloads for this app. |
| removed | bool | Indicates if this app has been removed from the playstore. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the earliest version of this app. |
| small_icon_url | str | 48x48 app icon (deprecated). |
| large_icon_url | str | 512x512 app icon. |
| category | str | The primary category of this app. |
| categories | str | All categories of this app (includes alternates like android_wear). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.major_version_number | int | Major version number. |
| version.version_code | int | Internal unique version code. |
| version.version_string | str | User-visible version number. |
Get historical count of apps that have this SDK installed.
/playstore/sdks/{sdk_slug}/install-trend| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| Path | Type | Summary |
|---|---|---|
| total_installs | int | Count of apps that ever used this SDK at this date. |
| current_installs | int | Count of apps that were using this SDK at this date. |
| uninstalls | int | Count of apps that used this SDK before this date, but removed it. |
| date | datetime | Date this count was taken. |
Get apps that have uninstalled this SDK.
/playstore/sdks/{sdk_slug}/uninstalls| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: downloads.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| pname | str | The package name for this app. |
| title | str | The title of the app. |
| rank | int | MixRank Rank. |
| score | float | MixRank Authority Score™. |
| developer_id | int | ID of the developer. |
| developer_name | str | The name of the app publisher. Usually a company or individual's name. |
| developer_email | str | Email address of the developer, from the public profile. |
| developer_website | str | Developer's website. |
| downloads | int | The approximate number of downloads for this app. |
| removed | bool | Indicates if this app has been removed from the playstore. |
| review_count | int | Number of reviews/comments for this app. |
| rating | float | The current rating for this app. (0-5) |
| rating_count | int | Number of ratings for this app. |
| upload_date | date | The upload date for the latest version of this app. |
| release_date | date | The upload date for the earliest version of this app. |
| small_icon_url | str | 48x48 app icon (deprecated). |
| large_icon_url | str | 512x512 app icon. |
| category | str | The primary category of this app. |
| categories | str | All categories of this app (includes alternates like android_wear). |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| version | object | Latest version information. |
| version.major_version_number | int | Major version number. |
| version.version_code | int | Internal unique version code. |
| version.version_string | str | User-visible version number. |
Get aggregate category data for a given SDK's apps.
/playstore/sdks/{sdk_slug}/categories| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| Path | Type | Summary |
|---|---|---|
| category | str | The identifier for this category. |
| total_installs | int | Number of apps that have ever installed this SDK in this category. |
| current_installs | int | Number of apps that currently have this SDK installed in this category. |
| uninstalls | int | Number of apps that have uninstalled this SDK in this category. |
Get aggregate download data for a given SDK's apps, broken out by download bucket.
/playstore/sdks/{sdk_slug}/downloads| Name | Summary |
|---|---|
| sdk_slug | The ID of the SDK. |
| Path | Type | Summary |
|---|---|---|
| downloads | int | The lower bound for this download bucket. |
| total_installs | int | Number of apps that have ever installed this SDK in this download bucket. |
| current_installs | int | Number of apps that currently have this SDK installed in this download bucket. |
| uninstalls | int | Number of apps that have uninstalled this SDK in this download bucket. |
Directory of websites.
/web/sites| Name | Summary |
|---|---|
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rank.
Sort the results by the field specified. Sortable fields: |
| company.id | Filter results by company ID. |
| search | Term to search for |
| Path | Type | Summary |
|---|---|---|
| domain | str | The website domain name. |
| rank | int | MixRank Rank. |
| alexa_rank | int | Alexa Rank. |
| score | float | MixRank Authority Score™. |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
Summary information about a website.
/web/sites/{domain}| Name | Summary |
|---|---|
| domain | The domain name of a website. Use the root domain name; in particular, do not prefix with "www." or any other subdomain. |
| Path | Type | Summary |
|---|---|---|
| domain | str | The website domain name. |
| rank | int | MixRank Rank. |
| alexa_rank | int | Alexa Rank. |
| score | float | MixRank Authority Score™. |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
Tags installed on a given website.
/web/sites/{domain}/tags| Name | Summary |
|---|---|
| domain | The domain name of a website. Use the root domain name; in particular, do not prefix with "www." or any other subdomain. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| Path | Type | Summary |
|---|---|---|
| id | int | ID of the tag. |
| slug | str | Textual ID of the SDK. |
| name | str | Name of the tag. |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| times_seen | int | Times this tag has been observed on this site. |
Summary information about a web tag.
/web/tags/{slug}| Name | Summary |
|---|---|
| slug | The textual ID of the tag. |
| Path | Type | Summary |
|---|---|---|
| id | int | ID of the tag. |
| slug | str | Textual ID of the SDK. |
| name | str | Name of the tag. |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |
| description | str | Description of the tag. |
| url | str | URL reference for more information. |
| logo_url | str | Logo for this tag. |
| site_count | str | Number of websites found with this tag. |
List of identified tags
/web/tags| Name | Summary |
|---|---|
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rank.
Sort the results by the field specified. Sortable fields: |
| sort_order |
Default: desc.
Sort the results in the order specified. Sortable directions: |
| Path | Type | Summary |
|---|---|---|
| rank | int | MixRank Rank |
| score | float | Score of the Web Tag |
| name | str | Name of the Web Tag. |
| id | int | Unique integer ID of this Web Tag |
| slug | str | Identifies this Web Tag. |
| domain_count | int | Number of websites found with this tag |
| times_seen | int | Number of times this Web Tag was seen |
Web sites that use a given tag.
/web/tags/{slug}/sites| Name | Summary |
|---|---|
| slug | The textual ID of the tag. |
| offset |
Default: 0. Min: 0. Offset the set of results to return. Useful for paging through results. |
| page_size |
Default: 4. Min: 1. Max: 100. Number of results to return. |
| sort_field |
Default: rank.
Sort the results by the field specified. Sortable fields: |
| Path | Type | Summary |
|---|---|---|
| domain | str | The website domain name. |
| rank | int | MixRank Rank. |
| alexa_rank | int | Alexa Rank. |
| score | float | MixRank Authority Score™. |
| company | object | Information about the company associated with this object |
| company.id | int | The unique integer identifier for this company |
| company.name | str | The name of this company |
| company.slug | str | A unique textual identifier for this company |