Retrieving Contents
This endpoint returns all available applications. Specifically, successfully indexed applications.
Get Repository Contents
GET
/contents
Returns all apps available in the repository.
Example response:
At the root level, this response contains a list of app objects. Here is a definition for an app object as returned by the API in this endpoint.
Get Featured App:
GET
/featured-app
Returns the app selected by the repository to be featured, called "App of the Day" in the official Open Shop Channel website. Read here to learn how featured apps are picked.
Example response:
Application object:
Field | Description | Type |
---|---|---|
slug | Application slug. Formerly known as "internal_name" or "hbbID". The application on the repository would be called <slug>.oscmeta. | String |
name | The display name of the application, as specified in meta.xml (fallback value: name field on manifest) | String |
author | The main author of the application, as specified in the meta.xml (fallback value: author field on manifest). | String |
authors | A list of other developers of the application. | List of Strings |
category | Name of category, as specified in the application manifest. Will always be a category declared as an available category in the information endpoint and the categories.json file in repository root. | String |
contributors | A list of contributors (not developers) of the application. | List of Strings |
description | Description of the application, as specified in meta.xml. | |
assets | All the available assets for this application. | |
flags | List of flags for this application. | List of Flags |
package_type | One of two values: | String |
peripherals | Peripherals supported by the application. | List of Peripherals |
release_date | UNIX timestamp of the application's release date as specified in meta.xml. Fallback: binary creation date. | Integer |
shop | Information used by the Shop Channel. | |
subdirectories | List of additional directories to be created, updated, or backed up by the client. Relative paths. Used by Homebrew Browser. | List of Strings |
supported_platforms | List of platforms this app supports. | List of Platforms |
uncompressed_size | The size of all the files of the application, uncompressed, in bytes. | Long |
version | Version as specified in the meta.xml. | String |
Assets
Map of application assets.
Field | Description |
---|---|
archive | The zipped application, ready for distribution. |
binary | The DOL/ELF of the application. |
icon | The application icon, in PNG format. |
meta | The meta.xml file of the application. |
Asset object:
Fields marked with '?' are optional, as they are not available for all asset types.
Field | Description | Type |
---|---|---|
url | The public URL of the asset. | String |
size? | The size of the file, in bytes. | Long |
hash? | The MD5 checksum of the file. | String |
Description
Field | Description | Type |
---|---|---|
short | "short_description" in the meta.xml, this should be used in areas where the long description won't fit. Short description as specified by the application author or overridden by manifest. | String |
long | "long_description" in the meta.xml. Long description as specified by the application author or overridden by manifest. | String |
Shop Information
Field | Description | Type |
---|---|---|
title_id | Title ID for this application. | String |
title_version | Title version. | Integer |
contents_size | The size of the packaged app + Wii Menu Banner | Long |
Last updated