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. Currently, HTTP GET is the only supported verb, and 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 http://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.
All API endpoints will start with http://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:
http://api.mixrank.com/v2/json/{api_key}/advertisers/livingsocial.com/gdn/textads?page_size=10&offset=10
livingsocial.com
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, e.g. "2011-06-13".
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.
Authentication / Echo
Test that your API key is valid.
Synopsis
GET /echo
Response
status
"success" if your API key is valid.
Examples
Companies / Directory
Directory of companies.
Synopsis
GET /companies
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: employee_count, property_count.
Default: employee_count
search
Term to search for
Response
id
Company ID.
name
Company name.
slug
A unique textual identifier for this company
employees
Estimated employees at this company.
rank_internetretailer
Internet Retailer Rank
rank_incmagazine
Inc. 5000 Rank
rank_fortune
Fortune Rank
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
company_id
The ID of the company.
Response
id
Company ID.
name
Company name.
slug
A unique textual identifier for this company
employees
Estimated employees at this company.
rank_internetretailer
Internet Retailer Rank
rank_incmagazine
Inc. 5000 Rank
rank_fortune
Fortune Rank
address
Primary address for this company.
Examples
GET
Hide
Company information for Google, Inc.
/companies/81760867
Websites / Directory
Directory of websites.
Synopsis
GET /web/sites
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: rank, id.
Default: rank
company.id
Filter results by company ID.
search
Term to search for
Response
domain
The website domain name.
company
Information about the company associated with this object
Examples
GET
Hide
Websites by Barns and Noble
/web/sites?company.id=81765662
GET
Hide
Search for apps matching "chocolate".
/web/sites?search=chocolate
Websites / Overview
Summary information about a website.
Synopsis
GET /web/sites/{domain}
Required Parameters
domain
The domain name of a website. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Response
domain
The website domain name.
company
Information about the company associated with this object
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
domain
The domain name of a website. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
Response
id
ID of the tag.
slug
Textual ID of the SDK.
name
Name of the tag.
company
Information about the company associated with this object
first_seen
The upload date of the oldest version of the app with this SDK installed.
last_seen
The upload date of the newest version of the app with this SDK installed.
times_seen
Times this tag has been observed on this site.
Examples
GET
Hide
Tags found on Toys R Us.
/web/sites/toysrus.com/tags
Summary information about a web tag.
Synopsis
GET /web/tags/{slug}
Required Parameters
slug
The textual ID of the tag.
Response
id
ID of the tag.
slug
Textual ID of the SDK.
name
Name of the tag.
company
Information about the company associated with this object
description
Description of the tag.
url
URL reference for more information.
logo_url
Logo for this tag.
site_count
Number of websites found with this tag.
Examples
GET
Hide
Summary information for Criteo tag.
/web/tags/adroll
Web sites that use a given tag.
Synopsis
GET /web/tags/{slug}/sites
Required Parameters
slug
The textual ID of the tag.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: rank, id.
Default: rank
Response
domain
The website domain name.
company
Information about the company associated with this object
Examples
GET
Hide
Websites that use Adroll.
/web/tags/adroll/sites
Advertisers / Overview
Summary information about an advertiser.
Synopsis
GET /advertisers/{advertiser}
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Response
advertiser
rank
Global rank of this advertiser.
times_seen
The number of times we've observed this advertiser's ads.
first_seen
The date we first observed observed this advertiser's ads.
last_seen
The date we last observed observed this advertiser's ads.
landing_page_count
The number of unique landing pages we've observed for this advertiser.
gdn_keyword_count
The number of unique keywords we've observed for this advertiser on GDN.
display_publisher_count
The number of unique web publishers we've observed for this advertiser.
gdn_text_ad_count
The number of unique GDN text ads.
gdn_text_ad_times_seen
The number of times we've observed this advertiser's GDN text ads.
gdn_text_ad_first_seen
The date we first observed this advertiser's GDN text ads.
gdn_text_ad_last_seen
The date we last observed this advertiser's GDN text ads.
gdn_display_ad_count
The number of unique banners.
gdn_display_ad_times_seen
The number of times we've observed this advertiser's banners.
gdn_display_ad_first_seen
The date we first observed this advertiser's banners.
gdn_display_ad_last_seen
The date we last observed this advertiser's banners.
Examples
GET
Hide
Get summary of dell.com.
/advertisers/dell.com
GET
Hide
Get summary of playstation.com.
/advertisers/playstation.com
GET
Hide
Get summary of softlayer.com.
/advertisers/softlayer.com
Advertisers / Banners
Get banner ads for an advertiser.
Synopsis
GET /advertisers/{advertiser}/gdn/displayads
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
advertiser
The advertiser.
hash
Unique id of this ad.
format
The width, height, and format type of this ad.
media_url
A URL to download the creative.
file_size
The size of the creative in bytes.
content_type
The file extension, e.g. swf, jpg, gif.
times_seen
The number of times we have observed this ad.
first_seen
The first time we observed this ad.
last_seen
The last time we observed this ad.
Examples
GET
Hide
Nike's most active banner ads.
/advertisers/nike.com/gdn/displayads?sort_field=times_seen
GET
Hide
Ford's recently launched banner ads.
/advertisers/ford.com/gdn/displayads?sort_field=first_seen
Advertisers / Text Ads
Get GDN text ads for an advertiser.
Synopsis
GET /advertisers/{advertiser}/gdn/textads
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, avg_position, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
advertiser
The advertiser.
hash
Unique id of this ad.
title
The title of the ad.
body
The subtitle of the ad.
display_url
The display url of the ad (visible to the user).
avg_position
Average position of this ad within ad units. Position is the ad's rank in a text ad block. High positions indicate ads that are next in queue and will show up when a publisher has multiple ad blocks per page, or by using the paging feature in an ad block.
times_seen
The number of times we have observed this ad.
first_seen
The first time we observed this ad.
last_seen
The last time we observed this ad.
Examples
GET
Hide
Domino's most active text ads.
/advertisers/dominos.com/gdn/textads
GET
Hide
Chuck E Cheese's recently added text ads.
/advertisers/chuckecheese.com/gdn/textads?sort_field=first_seen&sort_order=desc
GET
Hide
Vitaminwater's active text ads.
/advertisers/vitaminwater.com/gdn/textads?sort_field=last_seen&sort_order=desc
Advertisers / Keywords
Get an advertiser's contextual keywords.
Synopsis
GET /advertisers/{advertiser}/gdn/keywords
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
keyword
times_seen
The number of times we observed the advertiser's ads match this keyword.
first_seen
The first time we observed the advertiser's ads match this keyword.
last_seen
The last time we observed the advertiser's ads match this keyword.
Examples
GET
Hide
Philz Coffee's keywords.
/advertisers/philzcoffee.com/gdn/keywords
GET
Hide
LowerMyBills' most active keywords.
/advertisers/lowermybills.com/gdn/keywords
GET
Hide
23andMe's recently observed keywords.
/advertisers/23andme.com/gdn/keywords?sort_field=last_seen&sort_order=desc
Advertisers / Publishers
Get an advertiser's publishers.
Synopsis
GET /advertisers/{advertiser}/gdn/publishers
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, monthly_uniques.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
publisher
monthly_uniques
The monthly unique visitors of this publisher.
times_seen
The number of times we observed the advertiser's ads on this publisher.
first_seen
The first time we observed the advertiser's ads on this publisher.
last_seen
The last time we observed the advertiser's ads on this publisher.
Examples
GET
Hide
Kayak's top publishers.
/advertisers/kayak.com/gdn/publishers
GET
Hide
Marriott's top publishers.
/advertisers/marriott.com/gdn/publishers
GET
Hide
Nintendo's largest publishers.
/advertisers/nintendo.com/gdn/publishers?sort_field=monthly_uniques
Advertisers / Landing Pages
Get an advertiser's landing pages.
Synopsis
GET /advertisers/{advertiser}/landingpages
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
advertiser
url
The URL of the landing page
hash
The unique ID of the landing page.
times_seen
The number of times we observed the advertiser's ads point to this landing page.
first_seen
The first time we observed this landing page.
last_seen
The last time we observed this landing page.
Examples
GET
Hide
Rackspace's top landing pages.
/advertisers/rackspace.com/landingpages
GET
Hide
McAfee's newest landing pages.
/advertisers/mcafee.com/landingpages?sort_field=first_seen
Get related advertisers based on campaign similarities.
Synopsis
GET /advertisers/{advertiser}/relatedadvertisers
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: similarity, times_seen, first_seen, last_seen.
Default: similarity
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
advertiser
rank
Global rank of this advertiser.
times_seen
The number of times we've observed this advertiser's ads.
first_seen
The date we first observed observed this advertiser's ads.
last_seen
The date we last observed observed this advertiser's ads.
landing_page_count
The number of unique landing pages we've observed for this advertiser.
gdn_keyword_count
The number of unique keywords we've observed for this advertiser on GDN.
display_publisher_count
The number of unique web publishers we've observed for this advertiser.
gdn_text_ad_count
The number of unique GDN text ads.
Examples
GET
Hide
Kayak's top competitors.
/advertisers/kayak.com/relatedadvertisers
GET
Hide
Norton's top competitors.
/advertisers/norton.com/relatedadvertisers
Banners / Publishers
Get the publishers we've observed a given banner appear on.
Synopsis
GET /advertisers/{advertiser}/gdn/displayads/{hash}/publishers
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
hash
The unique id of the ad.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen, monthly_uniques.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
publisher
monthly_uniques
The monthly unique visitors of this publisher.
times_seen
The number of times we observed the ad on this publisher.
first_seen
The first time we observed the ad on this publisher.
last_seen
The last time we observed the ad on this publisher.
Examples
GET
Hide
Publishers for a
Bose creative.
/advertisers/bose.com/gdn/displayads/703a8d5997590a50b42dab31e8f1d1d1/publishers
Banners / Landing Pages
Get the landing pages we've observed for a given banner.
Synopsis
GET /advertisers/{advertiser}/gdn/displayads/{hash}/destinations
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
hash
The unique id of the ad.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
destination_url
URL the ad pointed to.
times_seen
The number of times we observed the ad point to this landing page.
first_seen
The first time we observed the ad point to this landing page.
last_seen
The last time we observed the ad point to this landing page.
Examples
GET
Hide
Landing pages for a
diet creative.
/advertisers/beyonddiet.com/gdn/displayads/041aa10ca49743f0e460a283374d7452/destinations
Text Ads / Publishers
Get the publishers we've observed a given text ad appear on.
Synopsis
GET /advertisers/{advertiser}/gdn/textads/{hash}/publishers
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
hash
The unique id of the ad.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen, monthly_uniques.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
publisher
monthly_uniques
The monthly unique visitors of this publisher.
times_seen
The number of times we observed the ad on this publisher.
avg_position
Average position of this ad within ad units. Position is the ad's rank in a text ad block. High positions indicate ads that are next in queue and will show up when a publisher has multiple ad blocks per page, or by using the paging feature in an ad block.
first_seen
The first time we observed the ad on this publisher.
last_seen
The last time we observed the ad on this publisher.
Examples
GET
Hide
Top publishers for a
Quiznos text ad.
/advertisers/quiznos.com/gdn/textads/cba5ea30870e335f8a25654cbe1e7bc9/publishers
GET
Hide
Active publishers for a
Ebmunds text ad.
/advertisers/edmunds.com/gdn/textads/b35c7b1c41cce5238ba453561f9080f6/publishers
Text Ads / Landing Pages
Get the landing pages we've observed for a given text ad.
Synopsis
GET /advertisers/{advertiser}/gdn/textads/{hash}/destinations
Required Parameters
advertiser
The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
hash
The unique id of the ad.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
destination_url
URL the ad pointed to.
times_seen
The number of times we observed the ad point to this landing page.
first_seen
The first time we observed the ad point to this landing page.
last_seen
The last time we observed the ad point to this landing page.
avg_position
Average position of this ad when directed against this landing page.
Examples
GET
Hide
Landing pages for a
Smilebox text ad.
/advertisers/smilebox.com/gdn/textads/13fa3d6782940c54ec40bc1540a25520/destinations
Publishers / Overview
Summary information about a publisher.
Synopsis
GET /publishers/{publisher}
Required Parameters
publisher
The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Response
publisher
rank
The rank of this publisher.
monthly_uniques
The number of monthly unique visitors to this publisher.
gdn_text_ad_count
The number of unique GDN text ads observed on this publisher.
gdn_text_ad_first_seen
The date that GDN text ads were first observed on this publisher.
gdn_text_ad_last_seen
The date that GDN text ads were last observed on this publisher.
gdn_display_ad_count
The number of unique banner ads observed on this publisher.
gdn_display_ad_first_seen
The date that banner ads were first observed on this publisher.
gdn_display_ad_last_seen
The date that banner ads were last observed on this publisher.
Examples
GET
Hide
Get summary of studentdoctor.net.
/publishers/studentdoctor.net
GET
Hide
Get summary of law.com.
/publishers/law.com
GET
Hide
Get summary of perezhilton.com.
/publishers/perezhilton.com
Publishers / Advertisers
Advertisers that we have observed run ads on a given publisher.
Synopsis
GET /publishers/{publisher}/gdn/advertisers
Required Parameters
publisher
The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
advertiser
times_seen
The number of times we observed the advertiser's ads run on the publisher.
first_seen
The first time we observed the advertiser's ads run on the publisher.
last_seen
The last time we observed the advertiser's ads run on the publisher.
gdn_text_ad_avg_position
Average position of this ad on this publisher.
Examples
GET
Hide
Top advertisers on moneynews.com.
/publishers/moneynews.com/gdn/advertisers?page_size=10
GET
Hide
Recent advertisers on allnurses.com.
/publishers/allnurses.com/gdn/advertisers?page_size=10&sort_field=last_seen
Publishers / Banners
Get banner ads that have been observed on a given publisher.
Synopsis
GET /publishers/{publisher}/gdn/displayads
Required Parameters
publisher
The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
advertiser
The advertiser.
hash
Unique id of this ad.
format
The width, height, and format type of this ad.
media_url
A URL to download the creative.
file_size
The size of the creative in bytes.
content_type
The file extension, e.g. swf, jpg, gif.
times_seen
The number of times we have observed this ad on this publisher.
first_seen
The first time we observed this ad on this publisher.
last_seen
The last time we observed this ad on this publisher.
Examples
GET
Hide
Top banners that have run on collegedb.com.
/publishers/collegedb.com/gdn/displayads
GET
Hide
Recently seen banners on runmyfreecreditreport.com.
/publishers/runmyfreecreditreport.com/gdn/displayads?sort_field=last_seen
GET
Hide
Longest running banners on tvsnob.com.
/publishers/tvsnob.com/gdn/displayads?sort_field=first_seen&sort_order=asc
Publishers / Text Ads
Get GDN text ads that have been observed on a given publisher.
Synopsis
GET /publishers/{publisher}/gdn/textads
Required Parameters
publisher
The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
Response
advertiser
The advertiser.
hash
Unique id of this ad.
title
The title of the ad.
body
The subtitle of the ad.
display_url
The display url of the ad (visible to the user).
avg_position
Average position of this ad within ad units. Position is the ad's rank in a text ad block. High positions indicate ads that are next in queue and will show up when a publisher has multiple ad blocks per page, or by using the paging feature in an ad block.
times_seen
The number of times we have observed this ad appear on the publisher.
first_seen
The first time we observed this ad appear on the publisher.
last_seen
The last time we observed this ad appear on the publisher.
Examples
GET
Hide
Top text ads observed on kidskonnect.com.
/publishers/kidskonnect.com/gdn/textads?page_size=10
Get related publishers based on advertiser similarities.
Synopsis
GET /publishers/{publisher}/relatedpublishers
Required Parameters
publisher
The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: similarity, rank.
Default: similarity
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
publisher
rank
The rank of this publisher.
gdn_text_ad_count
The number of unique GDN text ads observed on this publisher.
gdn_text_ad_first_seen
The date that GDN text ads were first observed on this publisher.
gdn_text_ad_last_seen
The date that GDN text ads were last observed on this publisher.
gdn_display_ad_count
The number of unique banner ads observed on this publisher.
gdn_display_ad_first_seen
The date that banner ads were first observed on this publisher.
gdn_display_ad_last_seen
The date that banner ads were last observed on this publisher.
Examples
GET
Hide
Similar publishers to iMotors.com.
/publishers/imotors.com/relatedpublishers
GET
Hide
Similar publishers to MySavings.com.
/publishers/mysavings.com/relatedpublishers
Keywords / Overview
Summary information about a contextual keyword.
Synopsis
GET /keywords/{keyword}
Required Parameters
keyword
A contextual keyword.
Response
keyword
gdn_text_ad_count
The number of unique GDN text ads observed for this keyword.
gdn_text_ad_first_seen
The date that GDN text ads were first observed for this keyword.
gdn_text_ad_last_seen
The date that GDN text ads were last observed for this keyword.
gdn_display_ad_count
The number of unique banner ads observed for this keyword.
gdn_display_ad_first_seen
The date that banner ads were first observed for this keyword.
gdn_display_ad_last_seen
The date that banner ads were last observed for this keyword.
Examples
GET
Hide
Get summary of "best poker sites".
/keywords/best%20poker%20sites
GET
Hide
Get summary of "san francisco giants".
/keywords/san%20francisco%20giants
GET
Hide
Get summary of "cloud hosting".
/keywords/cloud%20hosting
Keywords / Advertisers
Advertisers we've observed for a given keyword.
Synopsis
GET /keywords/{keyword}/gdn/advertisers
Required Parameters
keyword
A contextual keyword.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
advertiser
times_seen
The number of times we observed the advertiser's ads target the keyword.
first_seen
The first time we observed the advertiser's ads target the keyword.
last_seen
The last time we observed the advertiser's ads target the keyword.
gdn_text_ad_avg_position
Average position of this ad for this keyword.
Examples
GET
Hide
Top advertisers for "online personals".
/keywords/online%20personals/gdn/advertisers?page_size=20
GET
Hide
Recent advertisers for "online degree programs".
/keywords/online%20degree%20programs/gdn/advertisers?page_size=20&sort_field=last_seen
Keywords / Banners
Banner ads we've observed target a given keyword.
Synopsis
GET /keywords/{keyword}/gdn/displayads
Required Parameters
keyword
A contextual keyword.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
advertiser
The advertiser.
hash
Unique id of this ad.
format
The width, height, and format type of this ad.
media_url
A URL to download the creative.
file_size
The size of the creative in bytes.
content_type
The file extension, e.g. swf, jpg, gif.
times_seen
The number of times we have observed this ad targeting this keyword.
first_seen
The first time we observed this ad targeting this keyword.
last_seen
The last time we observed this ad targeting this keyword.
Examples
GET
Hide
Top banners for "30 year mortgage rates".
/keywords/30%20year%20mortgage%20rates/gdn/displayads
GET
Hide
Recently seen banners for "cloud hosting".
/keywords/cloud%20hosting/gdn/displayads?sort_field=last_seen
GET
Hide
New banners for "buying gold".
/keywords/buying%20gold/gdn/displayads?sort_field=first_seen
Keywords / Text Ads
GDN text ads we've observed target a given keyword.
Synopsis
GET /keywords/{keyword}/gdn/textads
Required Parameters
keyword
A contextual keyword.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: times_seen, avg_position, first_seen, last_seen.
Default: times_seen
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
advertiser
The advertiser.
hash
Unique id of this ad.
title
The title of the ad.
body
The subtitle of the ad.
display_url
The display url of the ad (visible to the user).
avg_position
Average position of this ad within ad units. Position is the ad's rank in a text ad block. High positions indicate ads that are next in queue and will show up when a publisher has multiple ad blocks per page, or by using the paging feature in an ad block.
times_seen
The number of times we have observed this ad targeting this keyword.
first_seen
The first time we observed this ad targeting this keyword.
last_seen
The last time we observed this ad targeting this keyword.
Examples
GET
Hide
Top text ads for "affordable life insurance".
/keywords/affordable%20life%20insurance/gdn/textads
GET
Hide
Top 10 text ads for "pizza delivery".
/keywords/pizza%20delivery/gdn/textads?page_size=10
GET
Hide
New text ads for "online savings accounts".
/keywords/online%20savings%20accounts/gdn/textads?sort_field=first_seen
Get related keywords based on advertiser similarities.
Synopsis
GET /keywords/{keyword}/relatedkeywords
Required Parameters
keyword
A contextual keyword.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: similarity.
Default: similarity
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
keyword
gdn_text_ad_count
The number of unique GDN text ads observed for this keyword.
gdn_text_ad_first_seen
The date that GDN text ads were first observed for this keyword.
gdn_text_ad_last_seen
The date that GDN text ads were last observed for this keyword.
gdn_display_ad_count
The number of unique banner ads observed for this keyword.
gdn_display_ad_first_seen
The date that banner ads were first observed for this keyword.
gdn_display_ad_last_seen
The date that banner ads were last observed for this keyword.
Examples
GET
Hide
Similar keywords to "instant payday loans".
/keywords/instant payday loans/relatedkeywords
GET
Hide
Similar keywords to "business degrees".
/keywords/business degrees/relatedkeywords
Play Store Apps / Directory
Directory of Play Store (Android) apps.
Synopsis
GET /playstore/apps
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: downloads, rating_count, pname.
Default: downloads
company.id
Filter results by company ID.
search
Term to search for
Response
pname
The package name for this app.
title
The title of the app.
developer_id
ID of the developer.
developer_name
The name of the app publisher. Usually a company or individual's name.
developer_email
Email address of the developer, from the public profile.
developer_website
Developer's website.
downloads
The approximate number of downloads for this app.
removed
Indicates if this app has been removed from the playstore.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_icon_url
48x48 app icon.
large_icon_url
512x512 app icon.
category
The category this app is in.
company
Information about the company associated with this object
version
Latest version information.
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
pname
The package name of the app. The package name is adotted Java namespace, e.g. "com.mixrank.android".
Response
pname
The package name for this app.
title
The title of the app.
developer_id
ID of the developer.
developer_name
The name of the app publisher. Usually a company or individual's name.
developer_email
Email address of the developer, from the public profile.
developer_website
Developer's website.
downloads
The approximate number of downloads for this app.
removed
Indicates if this app has been removed from the playstore.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_icon_url
48x48 app icon.
large_icon_url
512x512 app icon.
category
The category this app is in.
company
Information about the company associated with this object
version
Latest version information.
permissions
List of permissions this app requires.
ratings
Number of ratings per star.
recent_changes_html
The recent changes HTML.
description_html
The HTML description of this app.
installation_size
Size of the app in bytes.
content_rating
The content safety rating (1-5). See: https://support.google.com/googleplay/answer/1075738?hl=en.
version
An object with several fields: major_version_number, version_code (internal unique version code), version_string (pretty version number).
prices
List of prices for this app in different currencies.
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
pname
The package name of the app. The package name is adotted Java namespace, e.g. "com.mixrank.android".
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
Response
url
Our hosted copy of the image.
play_store_url
The original Play Store URL for this image. Unreliably since they expire frequently.
first_seen
The date we first observed this app image.
last_seen
The date we last observed this app image.
type
Meta info about this asset.
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
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
pname
The package name of the app. The package name is adotted Java namespace, e.g. "com.mixrank.android".
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: current_rank, highest_rank.
Default: current_rank
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
container
List container.
category
The category this app is in.
current_rank
The current rank the app is at in this list.
highest_rank
The highest rank the app achieved in this list.
first_ranked
The date this app first ranked in this list.
last_ranked
The date this app last ranked in this list.
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 / SDKs
SDKs installed in a given app.
Synopsis
GET /playstore/apps/{pname}/sdks
Required Parameters
pname
The package name of the app. The package name is adotted Java namespace, e.g. "com.mixrank.android".
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: version_code_min, version_code_max, slug.
Default: version_code_min
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
name
Name of the SDK.
slug
ID of the SDK.
upload_date_min
The upload date of the oldest version of the app with this SDK installed.
upload_date_max
The upload date of the newest version of the app with this SDK installed.
version_code_count
Number of app versions we've observed with this SDK.
version_code_min
The oldest version of the app we've observed with this SDK.
version_code_max
The newest version of the app we've observed with this SDK.
currently_installed
Indicates if the SDK is currently installed in the app.
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
pname
The package name of the app. The package name is adotted Java namespace, e.g. "com.mixrank.android".
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: version_code_min, version_code_max, namespace.
Default: version_code_min
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
namespace
The namespace name.
upload_date_min
The upload date of the oldest version of the app with this namespace present.
upload_date_max
The upload date of the newest version of the app with this namespace present.
version_code_min
The oldest version of the app we've observed with this namespace present.
version_code_max
The newest version of the app we've observed with this namespace present.
currently_installed
Indicates if the namespace is currently present in the app.
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
pname
The package name of the app. The package name is adotted Java namespace, e.g. "com.mixrank.android".
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: version_code.
Default: version_code
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
id
Version ID (unique per app).
asset_size
Size of IPA in bytes.
downloaded
Indicates if the APK has been downloaded.
Examples
GET
Hide
Versions of Viber.
/playstore/apps/com.viber.voip/versions?page_size=10
Play Store Developers / Apps
Apps published by a developer
Synopsis
GET /playstore/developers/{developer_id}/apps
Required Parameters
developer_id
The ID of the developer.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: downloads, rating_count, pname.
Default: downloads
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
pname
The package name for this app.
title
The title of the app.
developer_id
ID of the developer.
developer_name
The name of the app publisher. Usually a company or individual's name.
developer_email
Email address of the developer, from the public profile.
developer_website
Developer's website.
downloads
The approximate number of downloads for this app.
removed
Indicates if this app has been removed from the playstore.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_icon_url
48x48 app icon.
large_icon_url
512x512 app icon.
category
The category this app is in.
company
Information about the company associated with this object
version
Latest version information.
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
container
The name of this container.
category
The category within this container.
Examples
GET
Hide
Get all ranking lists.
/playstore/rankings
Play Store Rankings / Rankings
Get app rankings by list. A list is determined by container and (optionally) a category.
Synopsis
GET /playstore/rankings/{container}
Required Parameters
container
Container name from /playstore/rankings.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: ranking.
Default: ranking
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: asc
category
Category name from /playstore/rankings.
Response
pname
The package name for this app.
title
The title of the app.
developer_id
ID of the developer.
developer_name
The name of the app publisher. Usually a company or individual's name.
developer_email
Email address of the developer, from the public profile.
developer_website
Developer's website.
downloads
The approximate number of downloads for this app.
removed
Indicates if this app has been removed from the playstore.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_icon_url
48x48 app icon.
large_icon_url
512x512 app icon.
category
The category this app is in.
company
Information about the company associated with this object
version
Latest version information.
ranking
Rank within the list.
Examples
GET
Hide
Rankings of trending apps.
/playstore/rankings/apps_movers_shakers
GET
Hide
Rankings of top grossing arcade games.
/playstore/rankings/apps_topgrossing?category=game_arcade
Play Store SDKs / Directory
List of identified SDKs.
Synopsis
GET /playstore/sdks
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: total_installs, current_installs, uninstalls, slug.
Default: total_installs
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
name
Name of the SDK.
slug
Identifies this SDK.
total_installs
Number of apps that have ever installed this SDK.
current_installs
Number of apps that currently have this SDK installed.
uninstalls
Number of apps that have uninstalled this SDK.
Examples
GET
Hide
Top 4 SDKs by total installs.
/playstore/sdks?sort_field=total_installs&page_size=4
GET
Hide
Top 4 SDKs by 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
sdk_slug
The ID of the SDK.
Response
name
Name of this SDK.
slug
ID of this SDK.
description
Description of this SDK.
url
Usually points to the company or documentation page for this SDK.
logo_url
Logo for the SDK/company.
total_installs
Number of apps that have ever installed this SDK.
current_installs
Number of apps that currently have this SDK installed.
uninstalls
Number of apps that have uninstalled this SDK.
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
sdk_slug
The ID of the SDK.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: downloads, rating_count, pname.
Default: downloads
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
pname
The package name for this app.
title
The title of the app.
developer_id
ID of the developer.
developer_name
The name of the app publisher. Usually a company or individual's name.
developer_email
Email address of the developer, from the public profile.
developer_website
Developer's website.
downloads
The approximate number of downloads for this app.
removed
Indicates if this app has been removed from the playstore.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_icon_url
48x48 app icon.
large_icon_url
512x512 app icon.
category
The category this app is in.
company
Information about the company associated with this object
version
Latest version information.
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
sdk_slug
The ID of the SDK.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: downloads, rating_count, pname.
Default: downloads
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
pname
The package name for this app.
title
The title of the app.
developer_id
ID of the developer.
developer_name
The name of the app publisher. Usually a company or individual's name.
developer_email
Email address of the developer, from the public profile.
developer_website
Developer's website.
downloads
The approximate number of downloads for this app.
removed
Indicates if this app has been removed from the playstore.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_icon_url
48x48 app icon.
large_icon_url
512x512 app icon.
category
The category this app is in.
company
Information about the company associated with this object
version
Latest version information.
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
sdk_slug
The ID of the SDK.
Response
category
The identifier for this category.
total_installs
Number of apps that have ever installed this SDK in this category.
current_installs
Number of apps that currently have this SDK installed in this category.
uninstalls
Number of apps that have uninstalled this SDK in this category.
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
sdk_slug
The ID of the SDK.
Response
downloads
The lower bound for this download bucket.
total_installs
Number of apps that have ever installed this SDK in this download bucket.
current_installs
Number of apps that currently have this SDK installed in this download bucket.
uninstalls
Number of apps that have uninstalled this SDK in this download bucket.
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
iOS Apps / Directory
Directory of iOS apps.
Synopsis
GET /appstore/apps
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: rating_count, release_date, configs_count, id.
Default: rating_count
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
company.id
Filter results by company ID.
search
Term to search for
Response
id
The unique integer identifier for this app.
bundle_id
The unique string identifier for this app.
title
The title of the app.
developer_id
ID of the developer.
developer
The name of the app developer.
company_url
Company website.
support_url
Support website.
privacy_policy_url
App's privacy policy.
seller
The name of the app seller.
copyright
App's copyright notice.
downloaded
Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_artwork_url
57x57 app icon.
large_artwork_url
100x100 app icon.
genre
Genre this app is in.
genres
Sub-genres this app is in.
configs_count
The number of configuration properties extracted from the app's info.plist (across all inspected versions).
company
Information about the company associated with this object
version
Latest version information.
content_rating
Content safety rating.
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 Play Store app.
Synopsis
GET /appstore/apps/{app_id}
Required Parameters
Response
id
The unique integer identifier for this app.
bundle_id
The unique string identifier for this app.
title
The title of the app.
developer_id
ID of the developer.
developer
The name of the app developer.
company_url
Company website.
support_url
Support website.
privacy_policy_url
App's privacy policy.
seller
The name of the app seller.
copyright
App's copyright notice.
downloaded
Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_artwork_url
57x57 app icon.
large_artwork_url
100x100 app icon.
genre
Genre this app is in.
genres
Sub-genres this app is in.
configs_count
The number of configuration properties extracted from the app's info.plist (across all inspected versions).
company
Information about the company associated with this object
version
Latest version information.
content_rating
Content safety rating.
developer_link
Developer's itunes profile.
ratings
Number of ratings per star.
summary
The desciption of this app
installation_size
Size of the app in bytes.
price
Price for this app in US appstore.
Examples
GET
Hide
Summary information for Facebook.
/appstore/apps/284882215
GET
Hide
Summary information for Pandora.
/appstore/apps/com.pandora
iOS Apps / Rankings
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
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
Response
container
List container.
genre
List genre.
country
List country.
current_rank
The current rank the app is at in this list.
highest_rank
The highest rank the app achieved in this list.
first_ranked
The date this app first ranked in this list.
last_ranked
The date this app last ranked in this list.
Examples
GET
Hide
Rankings for Starbucks.
/appstore/apps/331177714/rankings
iOS Apps / SDKs
SDKs installed in a given app.
Synopsis
GET /appstore/apps/{app_id}/sdks
Required Parameters
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: version_code_min, version_code_max, name, slug.
Default: version_code_min
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
name
Name of the SDK.
slug
ID of the SDK.
upload_date_min
The upload date of the oldest version of the app with this SDK installed.
upload_date_max
The upload date of the newest version of the app with this SDK installed.
version_code_min
The oldest version of the app we've observed with this SDK.
version_code_max
The newest version of the app we've observed with this SDK.
currently_installed
Indicates if the SDK is currently installed in the app.
Examples
GET
Hide
SDKs installed in Instagram.
/appstore/apps/389801252/sdks
iOS Apps / Configs
Configuration options for iOS apps from embedded info.plist documents.
Synopsis
GET /appstore/apps/{app_id}/configs
Required Parameters
Response
version
The version of the app analyzed.
plist
The plist document embedded in the app.
Examples
GET
Hide
Get the config options for Words With Friends.
/appstore/apps/321916506/configs
iOS Apps / Versions
Releases of an app.
Synopsis
GET /appstore/apps/{app_id}/versions
Required Parameters
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: id.
Default: id
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
id
Version ID (unique globally).
asset_size
Size of IPA in bytes.
config_count
Number of Info.plist configs.
class_count
Number of classes in binary.
resource_count
Number of files in bundle.
version_display
Human-friendly version number.
release_date
Date this version was released to the store.
release_notes
Developer's release notes.
Examples
GET
Hide
Versions of Pinterest app.
/appstore/apps/429047995/versions
iOS Developers / Apps
Apps published by a developer
Synopsis
GET /appstore/developers/{developer_id}/apps
Required Parameters
developer_id
The ID of the developer.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: rating_count, release_date, configs_count, rating, id.
Default: rating_count
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
id
The unique integer identifier for this app.
bundle_id
The unique string identifier for this app.
title
The title of the app.
developer_id
ID of the developer.
developer
The name of the app developer.
company_url
Company website.
support_url
Support website.
privacy_policy_url
App's privacy policy.
seller
The name of the app seller.
copyright
App's copyright notice.
downloaded
Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_artwork_url
57x57 app icon.
large_artwork_url
100x100 app icon.
genre
Genre this app is in.
genres
Sub-genres this app is in.
configs_count
The number of configuration properties extracted from the app's info.plist (across all inspected versions).
company
Information about the company associated with this object
version
Latest version information.
content_rating
Content safety rating.
Examples
GET
Hide
Get the apps developed by OMGPOP.
/appstore/developers/422679887/apps
iOS Rankings / Lists
Get all ranking list options. A list is determined by a container, genre, and country.
Synopsis
GET /appstore/rankings
Response
containers
List of iOS rankings containers, eg "topfreeapplications".
genres
List of iOS genres, eg "ios-games-racing".
countries
List of iOS rankings countries, eg "us".
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
container
Container name from /appstore/rankings.
genre
Category name from /appstore/rankings.
country
Category name from /appstore/rankings.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: ranking.
Default: ranking
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: asc
Response
id
The unique integer identifier for this app.
bundle_id
The unique string identifier for this app.
title
The title of the app.
developer_id
ID of the developer.
developer
The name of the app developer.
company_url
Company website.
support_url
Support website.
privacy_policy_url
App's privacy policy.
seller
The name of the app seller.
copyright
App's copyright notice.
downloaded
Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_artwork_url
57x57 app icon.
large_artwork_url
100x100 app icon.
genre
Genre this app is in.
genres
Sub-genres this app is in.
configs_count
The number of configuration properties extracted from the app's info.plist (across all inspected versions).
company
Information about the company associated with this object
version
Latest version information.
content_rating
Content safety rating.
ranking
The current rank of this app
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
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: total_installs, current_installs, uninstalls.
Default: total_installs
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
name
Name of the SDK.
slug
Identifies this SDK.
total_installs
Number of apps that have ever installed this SDK.
current_installs
Number of apps that currently have this SDK installed.
uninstalls
Number of apps that have uninstalled this SDK.
Examples
GET
Hide
Top 4 SDKs by total installs.
/appstore/sdks?sort_field=total_installs&page_size=4
GET
Hide
Top 4 SDKs by 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
sdk_slug
The ID of the SDK.
Response
name
Name of this SDK.
slug
ID of this SDK.
description
Description of this SDK.
url
Usually points to the company or documentation page for this SDK.
logo_url
Logo for the SDK/company.
total_installs
Number of apps that have ever installed this SDK.
current_installs
Number of apps that currently have this SDK installed.
uninstalls
Number of apps that have uninstalled this SDK.
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
sdk_slug
The ID of the SDK.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: rating_count, upload_date, id.
Default: rating_count
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
id
The unique integer identifier for this app.
bundle_id
The unique string identifier for this app.
title
The title of the app.
developer_id
ID of the developer.
developer
The name of the app developer.
company_url
Company website.
support_url
Support website.
privacy_policy_url
App's privacy policy.
seller
The name of the app seller.
copyright
App's copyright notice.
downloaded
Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_artwork_url
57x57 app icon.
large_artwork_url
100x100 app icon.
genre
Genre this app is in.
genres
Sub-genres this app is in.
configs_count
The number of configuration properties extracted from the app's info.plist (across all inspected versions).
company
Information about the company associated with this object
version
Latest version information.
content_rating
Content safety rating.
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
sdk_slug
The ID of the SDK.
Optional Parameters
offset
Offset the set of results to return. Useful for paging through results.
Default: 0
page_size
Number of results to return.
Min: 1
Max: 100
Default: 4
sort_field
Sort the results by the field specified. Sortable fields: rating_count, upload_date, id.
Default: rating_count
sort_order
Sort the results in the order specified. Sortable directions: asc, desc.
Default: desc
Response
id
The unique integer identifier for this app.
bundle_id
The unique string identifier for this app.
title
The title of the app.
developer_id
ID of the developer.
developer
The name of the app developer.
company_url
Company website.
support_url
Support website.
privacy_policy_url
App's privacy policy.
seller
The name of the app seller.
copyright
App's copyright notice.
downloaded
Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
review_count
Number of reviews/comments for this app.
rating
The current rating for this app. (0-5)
rating_count
Number of ratings for this app.
upload_date
The upload date for the current version of this app.
small_artwork_url
57x57 app icon.
large_artwork_url
100x100 app icon.
genre
Genre this app is in.
genres
Sub-genres this app is in.
configs_count
The number of configuration properties extracted from the app's info.plist (across all inspected versions).
company
Information about the company associated with this object
version
Latest version information.
content_rating
Content safety rating.
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
sdk_slug
The ID of the SDK.
Response
genre
The identifier for this genre.
total_installs
Number of apps that have ever installed this SDK in this genre.
current_installs
Number of apps that currently have this SDK installed in this genre.
uninstalls
Number of apps that have uninstalled this SDK in this genre.
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
