Retrieving Contents

Danbo's on the way with the apps!

This endpoint returns all available applications. Specifically, successfully indexed applications.

Get Repository Contents

GET /contents

Returns all apps available in the repository.

200: OK Success!

Example response:

[
    {
        "slug": "danbo",
        "name": "Danbo",
        "author": "Danbo",
        "authors": [],
        "category": "demos",
        "contributors": [],
        "description": {
            "short": "Danbo",
            "long": "Danbo"
        },
        "assets": {
            "icon": {
                "url": "https://hbb1.oscwii.org/api/contents/danbo/icon.png",
                "size": 16732
            },
            "archive": {
                "url": "https://hbb1.oscwii.org/api/contents/danbo/danbo.zip",
                "hash": "8df6ccfcb2f7228c0ecf45c7d579ed80",
                "size": 1337156
            },
            "binary": {
                "url": "https://hbb1.oscwii.org/unzipped_apps/danbo/apps/danbo/boot.dol",
                "hash": "b3aefb8a05100ec861448708095f3902",
                "size": 1966848
            },
            "meta": {
                "url": "https://hbb1.oscwii.org/unzipped_apps/danbo/apps/danbo/meta.xml"
            }
        },
        "flags": [],
        "package_type": "dol",
        "peripherals": [
            "wii_remote"
        ],
        "release_date": 1605484800,
        "shop": {
            "contents_size": 2733520,
            "title_id": "000100014E41D674",
            "inodes": 3,
            "title_version": 1,
            "tmd_size": 2420
        },
        "subdirectories": [],
        "supported_platforms": [
            "wii",
            "vwii",
            "wii_mini"
        ],
        "uncompressed_size": 1983880,
        "version": "v1.0"
    },
  ...
]

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.

200: OK Success!

Second Tab

Example response:

{
    "slug": "smw-wiigii",
    "name": "Super Mario War Wii",
    "author": "Tantric",
    "authors": [],
    "category": "games",
    "contributors": [],
    "description": {
        "short": "Port of Super Mario War",
        "long": "Port of Super Mario War"
    },
    "assets": {
        "icon": {
            "url": "https://hbb1.oscwii.org/api/contents/smw-wiigii/icon.png",
            "size": 9907
        },
        "archive": {
            "url": "https://hbb1.oscwii.org/api/contents/smw-wiigii/smw-wiigii.zip",
            "hash": "865713b70d1f28a8c93dc3ec7a28b542",
            "size": 14204833
        },
        "binary": {
            "url": "https://hbb1.oscwii.org/unzipped_apps/smw-wiigii/apps/smw-wiigii/boot.dol",
            "hash": "db2316f3f8959d894e1c4cf68a4f364a",
            "size": 3246464
        },
        "meta": {
            "url": "https://hbb1.oscwii.org/unzipped_apps/smw-wiigii/apps/smw-wiigii/meta.xml"
        }
    },
    "flags": [],
    "package_type": "dol",
    "peripherals": [
        "wii_remote",
        "wii_remote",
        "wii_remote",
        "wii_remote",
        "classic_controller"
    ],
    "release_date": 1281484800,
    "shop": {
        "contents_size": 15600400,
        "title_id": "000100014E1E6C1F",
        "inodes": 3,
        "title_version": 1,
        "tmd_size": 2420
    },
    "subdirectories": [],
    "supported_platforms": [
        "wii",
        "vwii",
        "wii_mini"
    ],
    "uncompressed_size": 3258256,
    "version": "1.4"
}

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.	Description
assets	All the available assets for this application.	Assets
flags	List of flags for this application.	List of Flags
package_type	One of two values: dol / elf. This indicates the binary type of the application.	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.	Shop Information
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