Retrieving Contents

/v3/contents

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

Get Repository Contents

GET /v3/contents

Returns all apps available in the repository.

Example response:

[
  {
    "author": "Fledge68",
    "category": "utilities",
    "description": {
      "long": "WiiFlow is a app for loading backup games from a USB Device or SD card.\n    It displays your games in a coverflow with 3D full box covers.\n    \n    Key features:\n    * Emulated NAND support\n    * Plugin system for emu apps\n    * Devolution support\n    * Nintendont support\n    * Neek2o support",
      "short": "USB Loader app"
    },
    "file_size": {
      "binary": 4619072,
      "icon": 8319,
      "zip_compressed": 3307321,
      "zip_uncompressed": 6073186
    },
    "name": "WiiFlow WFL",
    "package_type": "dol",
    "peripherals": [
      "Wii Remote",
      "Wii Remote",
      "Wii Remote",
      "Wii Remote",
      "Nunchuk",
      "Classic Controller",
      "GameCube Controller",
      "SDHC"
    ],
    "release_date": 1647993600,
    "slug": "wiiflow",
    "subdirectories": [
      "/apps/wiiflow/imgs",
      "/apps/wiiflow/bins"
    ],
    "supported_platforms": [
      "wii"
    ],
    "url": {
      "icon": "http://hbb4.oscwii.org/api/v3/contents/wiiflow/icon.png",
      "zip": "http://hbb4.oscwii.org/api/v3/contents/wiiflow/wiiflow.zip"
    },
    "version": "5.5.3"
  },
  ...
]

At the root level, this response contains a list of app objects. Below is a definition for an app object as returned by the API in this endpoint.

FieldDescriptionType

author

Author of the application, as specified in the meta.xml (fallback value: author field on manifest)

str

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.

str

description

Description of the application, as specified in meta.xml. "short" (str): "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. "long" (str): "long_description" in the meta.xml. Long description as specified by the application author or overridden by manifest.

dict

file_size

Dictionary of various file sizes, all ints.

dict

flags

Dictionary of flags. List of all supported flags, all strings.

dict

name

The display name of the application, as specified in meta.xml (fallback value: name field on manifest)

str

package_type

One of three (str) values: "dol" / "elf" / "thm". This indicates the primary or the only binary for the application. "thm" is for homebrew channel theme. Themes are currently not supported by Repository Manager.

str

peripherals

Peripherals supported by the application, list of strings. Can include up to 4 "Wii Remote", and one of each of the following: "GameCube Controller" "Nunchuk" "Classic Controller" "SDHC" "USB Keyboard" "Wii Zapper"

list

release_date

UNIX timestamp of the application's release date as specified in meta.xml. Fallback: binary creation date.

int

slug

Application slug. Formerly known as "internal_name" or "hbbID". The application on the repository would be called <slug>.oscmeta.

str

subdirectories

List of additional directories (str) to be created, updated, or backed up by the client. Relative paths. Used by Homebrew Browser.

list

supported_platforms

List of platforms this app supports.

list

url

Full URLs (str) for downloading the application ZIP or the application icon.

list

version

Version as specified in the meta.xml.

str

Last updated