Functions¶
-
class
steamstorefront.
SteamStoreFront
(**kwargs)[source]¶ Parameters: - appid (integer or numeric string) – application id
- category (string) – application category
- name (string) – application name
- url (string) – store url
Note
one of the 3 parameters is required
- appid
- name
- url
category defaults to “app”
Raises: InvalidArgument – See error message for explanation. Additionally error can be looked up for argument and type for error code. Return type: None if key not found. -
class
Errors
¶ An enumeration.
-
getAboutTheGame
(appid=appid, category=category, name=name, url=url, format=format)[source]¶ getAboutTheGame(appid=appid, category=category, name=name, url=url, format=format)
- supported categories = [app]
- supported categories with format = [app]
- supported format = [raw(default), normal]
- normal removes all html tags
Returns: returns about the game Return type: str
-
getAchievements
(appid=appid, category=category, name=name, url=url)[source]¶ getAchievements(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns achievements list Return type: list
-
getApps
(appid=appid, category=category, name=name, url=url)[source]¶ getApps(appid=appid, category=category, name=name, url=url)
- supported categories = [sub]
Returns: returns apps Return type: list
-
getBackground
(appid=appid, category=category, name=name, url=url)[source]¶ getBackground(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns background image Return type: str
-
getCategories
(appid=appid, category=category, name=name, url=url)[source]¶ getCategories(appid=appid, category=category, name=name, url=url)
- supported categories = [app, bundle]
Returns: returns categories Return type: list
-
getContentDescriptors
(appid=appid, category=category, name=name, url=url)[source]¶ getContentDescriptors(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns content descriptors Return type: dict
-
getControllerSupport
(appid=appid, category=category, name=name, url=url)[source]¶ getControllerSupport(appid=appid, category=category, name=name, url=url)
- supported categories = [app, sub]
Returns: returns controller support Return type: str
-
getDLC
(appid=appid, category=category, name=name, url=url)[source]¶ getDLC(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns dlc list Return type: list
-
getDRM
(appid=appid, category=category, name=name, url=url)[source]¶ getDRM(appid=appid, category=category, name=name, url=url)
- supported categories = [bundle]
Returns: returns drm Return type: list
-
getDemos
(appid=appid, category=category, name=name, url=url)[source]¶ getDemos(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns demos Return type: ?
-
getDescription
(appid=appid, category=category, name=name, url=url, format=format)[source]¶ getDescription(appid=appid, category=category, name=name, url=url, format=format)
- supported categories = [app, bundle]
- supported categories with format = [app]
- supported format = [raw(default), normal]
- normal removes all html tags
Returns: returns description Return type: str
-
getDevelopers
(appid=appid, category=category, name=name, url=url)[source]¶ getDevelopers(appid=appid, category=category, name=name, url=url)
- supported categories = [app, bundle]
Returns: returns developers Return type: list
-
getFranchise
(appid=appid, category=category, name=name, url=url)[source]¶ getFranchise(appid=appid, category=category, name=name, url=url)
- supported categories = [bundle]
Returns: returns franchise Return type: list
-
getFullgame
(appid=appid, category=category, name=name, url=url)[source]¶ getFullgame(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns ? Return type: ?
-
getGenres
(appid=appid, category=category, name=name, url=url)[source]¶ getGenres(appid=appid, category=category, name=name, url=url)
- supported categories = [app, bundle]
Returns: returns genres Return type: list
-
getHeaderImage
(appid=appid, category=category, name=name, url=url)[source]¶ getHeaderImage(appid=appid, category=category, name=name, url=url)
- supported categories = [app, sub, bundle]
Returns: returns header image Return type: str
-
getIsFree
(appid=appid, category=category, name=name, url=url)[source]¶ getIsFree(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns is game free Return type: boolean
-
getLegalNotice
(appid=appid, category=category, name=name, url=url)[source]¶ getLegalNotice(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns legal notice Return type: str
-
getLink
(appid=appid, category=category, name=name, url=url)[source]¶ - supported categories = [app, sub, bundle]
Returns: returns store url Return type: string
-
getLinuxRequirements
(appid=appid, category=category, name=name, url=url, format=format)[source]¶ getLinuxRequirements(appid=appid, category=category, name=name, url=url, format=format)
- supported categories = [app]
- supported categories with format = [app]
- supported format = [raw(default), dict]
Returns: returns linux requirements Return type: str or dict
-
getMacRequirements
(appid=appid, category=category, name=name, url=url, format=format)[source]¶ getMacRequirements(appid=appid, category=category, name=name, url=url, format=format)
- supported categories = [app]
- supported categories with format = [app]
- supported format = [raw(default), dict]
Returns: returns mac requirements Return type: str or dict
-
getMetacritic
(appid=appid, category=category, name=name, url=url)[source]¶ getMetacritic(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns metacritc score Return type: dict
-
getMovies
(appid=appid, category=category, name=name, url=url)[source]¶ getMovies(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns movies Return type: list
-
getName
(appid=appid, category=category, name=name, url=url)[source]¶ getName(appid=appid, category=category, name=name, url=url)
- supported categories = [app, sub, bundle]
Returns: returns name Return type: str
-
getPCRequirements
(appid=appid, category=category, name=name, url=url, format=format)[source]¶ getPCRequirements(appid=appid, category=category, name=name, url=url, format=format)
- supported categories = [app]
- supported categories with format = [app]
- supported format = [raw(default), dict]
Returns: returns pc requirements Return type: str or dict
-
getPackageGroup
(appid=appid, category=category, name=name, url=url)[source]¶ getPackageGroup(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns package groups Return type: list
-
getPackageItem
(appid=appid, category=category, name=name, url=url)[source]¶ getPackageItem(appid=appid, category=category, name=name, url=url)
- supported categories = [bundle]
Returns: returns package item (apps and packages) Return type: list
-
getPackages
(appid=appid, category=category, name=name, url=url)[source]¶ getPackages(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns packages Return type: list
-
getPageImage
(appid=appid, category=category, name=name, url=url)[source]¶ getPageImage(appid=appid, category=category, name=name, url=url)
- supported categories = [sub]
Returns: returns page image Return type: str
-
getPlatforms
(appid=appid, category=category, name=name, url=url)[source]¶ getPlatforms(appid=appid, category=category, name=name, url=url)
- supported categories = [app, sub]
Returns: returns platforms Return type: dict
-
getPrice
(appid=appid, category=category, name=name, url=url, currency=currency)[source]¶ getPrice(appid=appid, category=category, name=name, url=url, currency=currency)
- supported categories = [app, sub, bundle]
- supported categories with currency = [app, sub]
- currency should be in 2 letters, eg:- USD : us, INR : in, etc
Returns: returns price Return type: dictionary
-
getPublishers
(appid=appid, category=category, name=name, url=url)[source]¶ getPublishers(appid=appid, category=category, name=name, url=url)
- supported categories = [app, bundle]
Returns: returns publishers Return type: list
-
getRatings
(appid=appid, category=category, name=name, url=url)[source]¶ getRatings(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns (review_score, rating, review_summary) Return type: tuple
-
getRaw
(appid=appid, category=category, name=name, url=url)[source]¶ getRaw(appid=appid, category=category, name=name, url=url)
- supported categories = [app, sub, bundle]
Returns: returns raw json data Return type: dictionary
-
getRecommendations
(appid=appid, category=category, name=name, url=url)[source]¶ getRecommendations(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns recommendations Return type: dict
-
getReleaseDate
(appid=appid, category=category, name=name, url=url)[source]¶ getReleaseDate(appid=appid, category=category, name=name, url=url)
- supported categories = [app, sub]
Returns: returns release date Return type: dict
-
getRequiredAge
(appid=appid, category=category, name=name, url=url)[source]¶ getRequiredAge(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns required age Return type: int
-
getReviews
(appid=appid, category=category, name=name, url=url, format=format)[source]¶ getReviews(appid=appid, category=category, name=name, url=url, format=format)
- supported categories = [app]
- supported categories with format = [app]
- supported format = [raw(default), list]
Returns: returns reviews Return type: str or list
-
getScreenshots
(appid=appid, category=category, name=name, url=url)[source]¶ getScreenshots(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns screenshots Return type: list
-
getShortDescription
(appid=appid, category=category, name=name, url=url)[source]¶ getShortDescription(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns short description Return type: str
-
getSmallLogo
(appid=appid, category=category, name=name, url=url)[source]¶ getSmallLogo(appid=appid, category=category, name=name, url=url)
- supported categories = [sub]
Returns: returns small logo Return type: str
-
getSupportInfo
(appid=appid, category=category, name=name, url=url)[source]¶ getSupportInfo(appid=appid, category=category, name=name, url=url)
- supported categories = [app]
Returns: returns suport info Return type: dict
-
getSupportedLanguages
(appid=appid, category=category, name=name, url=url, format=format)[source]¶ getSupportedLanguages(appid=appid, category=category, name=name, url=url, format=format)
- supported categories = [app, bundle]
- supported categories with format = [app]
- supported format = [raw(default), normal, list]
- normal removes all html tags
- list returns a list
Returns: returns supported language Return type: str or list