TV

TVs using Firefox OS call specialized variants of the search and detail APIs. These are not recommended for consumption by other clients and can change in conjunction with the TV client.

App

GET /api/v2/tv/app/

A copy of the app API. The response only contains the specific subset of fields TVs need.

Parameters:
  • app_type (string) – A string representing the app type. Can be hosted, packaged or privileged.
  • author (string) – A string representing the app author.
  • categories (array) – An array of strings representing the slugs of the categories the app belongs to.
  • current_version (string) – The version number corresponding to the app’s latest public version.
  • description (string|object) – The app’s description.
  • device_types (array) – An array of strings representing the devices the app is marked as compatible with. Currently available devices names are desktop, android-mobile, android-tablet, firefoxos, firefoxos-tv.
  • feature_compatibility (boolean|null) – Boolean indicating whether the app’s current version is compatible with the feature profile signature passed to the API request. If no profile signature was passed or if the backend is unable to determine compatibility, null is returned.
  • file_size (int) – Size of the app’s current version in bytes.
  • homepage (string|object) – The app’s homepage.
  • icons (object) – An object containing information about the app icons. The keys represent icon sizes, the values the corresponding URLs.
  • id (int) – The app ID.
  • last_updated (string) – The date the app was last updated in the Marketplace, in ISO 8601 format.
  • manifest_url – URL for the app manifest. If the app is not an hosted app, this will be a minimal manifest generated by the Marketplace.
  • name (string|object) – The app name.
  • privacy_policy (string) – The path to the privacy policy resource.
  • promo_imgs (object) – An object containing information about app promo images. The keys represent image sizes, the values the corresponding URLs.
  • release_notes (string|object|null) – the release notes for the current version.
  • resource_uri (string) – The canonical URI for this resource.
  • slug (string) – The app slug
  • status (int) – The app status. See the status table.
  • support_email (string|object) – The email the app developer set for support requests.
  • support_url (string|object) – The URL the app developer set for support requests.
  • tv_featured (boolean) – Whether this is a featured app or not.
  • user (object) – an object representing information specific to this user for the app. If the user is anonymous this object will not be present.
  • user.developed (boolean) – true if the user is a developer of the app.
  • user.installed (boolean) – true if the user installed the app (this might differ from the device).

Website

GET /api/v2/tv/website/

A copy of the website API.

Parameters:
  • categories (array) – An array of strings representing the slugs of the categories the app belongs to.
  • description (string|object) – The site’s description.
  • icons (object) – An object containing information about the site icons. The keys represent icon sizes, the values the corresponding URLs.
  • id (int) – The site ID.
  • promo_imgs (object) – An object containing information about site promo images. The keys represent image sizes, the values the corresponding URLs.
  • tv_featured (boolean) – Whether this is a featured app or not.
  • tv_url (string|null) – The site’s TV-specific URL, if it exists.
  • name (string|object) – The site’s name, as used on its detail page in Marketplace.
  • short_name (string|object) – A shorter representation of the site’s name, to be used in the listing pages in Marketplace.
  • title (string|object) – The site’s title, extracted from the site’s <title> element. Used internally to improve search results.
  • url (string) – The site’s URL.