Skip to content

components

API Request Group: GET

Description

This API call returns an array of objects containing basic information about all installed components. Each object includes:

  • The internal (machine-readable) name of the component
  • A human-friendly name
  • A description of the component
  • A list of all systems supported by the component

Applicable Data Keys

None

Additional Notes

None

Examples: components

Example Request: components

{
  "action": "get",
  "request": "components",
  "version": "1.0",
  "request_id": "<request_id>"
}

Success Response: components

{
  "status": "success",
  "result": [
    {
      "component_name": "retrodeck",
      "component_friendly_name": "RetroDECK",
      "description": "RetroDECK Framework",
      "emulated_system": "none",
      "path": "/app/retrodeck/components/retrodeck",
      "compatible_presets": "none"
    },
    {
      "component_name": "ppsspp",
      "component_friendly_name": "PPSSPP",
      "description": "PlayStation Portable Emulator",
      "emulated_system": "psp",
      "path": "/app/retrodeck/components/ppsspp",
      "compatible_presets": {
        "cheevos": [
          "false",
          "true"
        ],
        "cheevos_hardcore": [
          "false",
          "true"
        ]
      }
    },
    {
      "component_name": "retroarch",
      "component_friendly_name": "RetroArch",
      "description": "Libretro Multi-emulator Frontend",
      "emulated_system": "retroarch",
      "path": "/app/retrodeck/components/retroarch",
      "compatible_presets": {
        "cheevos": [
          "false",
          "true"
        ],
        "cheevos_hardcore": [
          "false",
          "true"
        ],
        "snes9x-current_libretro": {
          "borders": [
            "false",
            "true"
          ],
          "widescreen": [
            "false",
            "true"
          ]
        },
        "gambatte_libretro": {
          "borders": [
            "false",
            "true"
          ],
          "rewind": [
            "false",
            "true"
          ]
        }
      }
    },
    {
      "component_name": "steam-rom-manager",
      "component_friendly_name": "Steam ROM Manager",
      "description": "Used to sync RetroDECK favorites and Launcher with Steam",
      "emulated_system": "none",
      "path": "/app/retrodeck/components/steam-rom-manager"
    }
  ],
  "request_id": "<request_id>"
}

Failure Response: components

{
  "status": "error",
  "result": "the current component information could not be read",
  "request_id": "<request_id>"
}