def categories(hl="en", gl="us", ignore_promotions=True):
"""Sends a GET request to the front page (app store base url), parses and
returns a list of all available categories.
Note: May contain some promotions, e.g. "Popular Characters"
"""
s = scraper.PlayScraper(hl, gl)
return s.categories(ignore_promotions)
def suggestions(query, hl="en", gl="us"):
"""Sends a GET request to the Play Store's suggestion API and returns up to
five autocompleted suggested query strings in a list.
:param query: the query string to get autocomplete suggestions
:return: a list of suggestion strings
"""
s = scraper.PlayScraper(hl, gl)
return s.suggestions(query)
def details(app_id, hl="en", gl="us"):
"""Sends a GET request to the app's info page, parses the app's details, and
returns them as a dict.
:param app_id: the app to retrieve details from, e.g. 'com.nintendo.zaaa'
:return: a dictionary of app details
"""
s = scraper.PlayScraper(hl, gl)
return s.details(app_id)
def similar(app_id, detailed=False, hl="en", gl="us"):
"""Sends a GET request, follows the redirect, and retrieves a list of
applications similar to the specified app.
:param app_id: the app to retrieve details from, e.g. 'com.nintendo.zaaa'
:param detailed: if True, sends request per app for its full detail
:return: a list of similar apps
"""
s = scraper.PlayScraper(hl, gl)
return s.similar(app_id, detailed=detailed)
def reviews(app_id, page=1, hl='en', gl='us'):
"""Sends a POST request and retrieves a list of reviews for
the specified app.
:param app_id: the app to retrieve details from, e.g. 'com.nintendo.zaaa'
:param page: the page number to retrieve; max is 10
:return: a list of reviews
"""
s = scraper.PlayScraper(hl, gl)
return s.reviews(app_id, page)
def search(query, page=None, detailed=False, hl="en", gl="us"):
"""Sends a POST request and retrieves a list of applications matching
the query term(s).
:param query: search query term(s) to retrieve matching apps
:param page: the page number to retrieve; max is 12
:param detailed: if True, sends request per app for its full detail
:return: a list of apps matching search terms
"""
s = scraper.PlayScraper(hl, gl)
return s.search(query, page, detailed)
def search(query, **kwargs):
"""Sends a POST request and retrieves a list of applications matching
the query term(s).
:param query: search query term(s) to retrieve matching apps
:param page: the page number to retrieve; max is 12
:param detailed: if True, sends request per app for its full detail
:return: a list of apps matching search terms
"""
s = scraper.PlayScraper()
return s.search(query, **kwargs)
def developer(developer, hl="en", gl="us", **kwargs):
"""Sends a POST request to the developer's page, extracts their apps' basic
info, and returns them in a list.
:param developer: developer name to retrieve apps from, e.g. 'Disney'
:param results: the number of app results to retrieve
:param page: the page number to retrieve
:param detailed: if True, sends request per app for full detail
:return: a list of app dictionaries
"""
s = scraper.PlayScraper(hl, gl)
return s.developer(developer, **kwargs)
def collection(collection, category=None, hl="en", gl="us", **kwargs):
"""Sends a POST request to the collection url, gets each app's details, and
returns them in a list.
List of acceptable collections and categories can be found in settings.
:param collection: the collection ID as a string.
:param category: the category ID as a string.
:param results: the number of app results to retrieve
:param page: the page number, calculates collection start index. is limited
to page * results <= 500
:param age: an age range to filter by (only for FAMILY categories)
:param detailed: if True, sends request per app for full detail
:return: a list of app dictionaries
"""
s = scraper.PlayScraper(hl, gl)
return s.collection(collection, category, **kwargs)
def cluster_items(gsr, detailed=False):
s = scraper.PlayScraper()
return s.cluster_items(gsr, detailed)
def category_clusters(category):
s = scraper.PlayScraper()
return s.category_clusters(category)
