Home Connect (BSH appliances) Programs API

Start, select, monitor and stop programs

GitHub OpenAPI

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /homeappliances/{haId}/programs List all programs of a home appliance · Get all programs of a given home appliance #
Ask an LLM
“What programs does my washing machine support?”
“Can I see every program a home appliance can run?”
Tell an agent
List all programs of home appliance {haId}.
Show every program available on {haId}.
GET /homeappliances/{haId}/programs/available List programs currently available on a home appliance · Get all programs which are currently available on the given home appliance #
Ask an LLM
“Which programs can I start right now on my oven?”
“Are there any programs currently available on a home appliance?”
Tell an agent
List the programs currently available on {haId}.
Show only the programs I can start on {haId} now.
GET /homeappliances/{haId}/programs/available/{programkey} Get one program available on a home appliance · Get a specific available program #
Ask an LLM
“What are the settings of a specific program on my dishwasher?”
“Can I look up one program by its key on a home appliance?”
Tell an agent
Get program {programkey} on home appliance {haId}.
Show the available program {programkey} for {haId}.
GET /homeappliances/{haId}/programs/active Get the program currently running on a home appliance · Get the active program #
Ask an LLM
“Which program is my oven currently running?”
“What is the active program on a home appliance right now?”
Tell an agent
Get the active program on home appliance {haId}.
Tell me which program {haId} is running.
PUT /homeappliances/{haId}/programs/active Start a program on a home appliance · Start the given program #
Ask an LLM
“How do I start a program on my washing machine?”
“What preconditions must be met before a program can be started?”
Tell an agent
Start program {data} on home appliance {haId}.
Run {data} on {haId} if the appliance is connected and remote control is allowed.
DELETE /homeappliances/{haId}/programs/active Stop the program running on a home appliance · Stop the active program #
Ask an LLM
“How do I stop a program that is already running on my oven?”
“Can I halt the active program on a home appliance?”
Tell an agent destructive · confirm first
Stop the active program on home appliance {haId}.
Halt the running program on {haId}.
GET /homeappliances/{haId}/programs/active/options Get the options of the running program · Get all options of the active program #
Ask an LLM
“What options are set on the program my oven is currently running?”
“Can I read the active program's options on a home appliance?”
Tell an agent
Get the options of the active program on home appliance {haId}.
Show which settings the program running on {haId} has.
PUT /homeappliances/{haId}/programs/active/options Set all options of the running program · Set all options of the active program #
Ask an LLM
“How do I change every option of a program that is already running?”
“Do I have to send all active program options at once?”
Tell an agent
Set all options of the active program on {haId} to {data}.
Update every setting of the program running on {haId} to {data}.
GET /homeappliances/{haId}/programs/active/options/{optionkey} Get one option of the running program · Get a specific option of the active program #
Ask an LLM
“What value is a specific option of the program my oven is running set to?”
“Can I read one active program option by its key?”
Tell an agent
Get option {optionkey} of the active program on {haId}.
Show the value of {optionkey} for the program running on {haId}.
PUT /homeappliances/{haId}/programs/active/options/{optionkey} Change a running program's option · Set a specific option of the active program #
Ask an LLM
“How do I extend a program that is already running by an extra 5 minutes?”
“Can I change the selected oven program's options while it runs?”
Tell an agent
Set option {key} of the active program on appliance {haId} to {value}.
Extend the running program on {haId} by changing option {key} to {value}.
GET /homeappliances/{haId}/programs/selected Get the program shown on the home appliance display · Get the selected program #
Ask an LLM
“Which program is currently selected on my washing machine display?”
“What program is my oven showing on its control panel?”
Tell an agent
Get the selected program on home appliance {haId}.
Tell me which program {haId} is showing on its display.
PUT /homeappliances/{haId}/programs/selected Select a program on the home appliance display · Select the given program #
Ask an LLM
“How do I choose a program on my oven's display without starting it?”
“Can I select a program on a home appliance before starting it?”
Tell an agent
Select program {data} on home appliance {haId}.
Set the program shown on {haId} to {data}.
GET /homeappliances/{haId}/programs/selected/options Get the options of the selected program · Get all options of the selected program #
Ask an LLM
“What options are available for the program my oven is currently showing?”
“Can I see the constraints of the program selected on a home appliance?”
Tell an agent
Get the options of the selected program on {haId}.
Show which settings the program selected on {haId} allows.
PUT /homeappliances/{haId}/programs/selected/options Set all options of the selected program · Set all options of the selected program #
Ask an LLM
“How do I change every option of the program my oven is showing?”
“Do I have to send all selected program options at once?”
Tell an agent
Set all options of the selected program on {haId} to {data}.
Update every setting of the program selected on {haId} to {data}.
GET /homeappliances/{haId}/programs/selected/options/{optionkey} Get a selected program's option · Get a specific option of the selected program #
Ask an LLM
“What value is set for a particular option of the program I just selected?”
“Can I read one program option without knowing which program is selected?”
Tell an agent
Get option {key} of the selected program on appliance {haId}.
Show the value of program option {key} on {haId}.
PUT /homeappliances/{haId}/programs/selected/options/{optionkey} Change one option of the selected program · Set a specific option of the selected program #
Ask an LLM
“How do I change a single option of the program my oven is showing?”
“Can I adjust one setting of the program selected on a home appliance?”
Tell an agent
Set option {optionkey} of the selected program on {haId} to {data}.
Change {optionkey} on the program selected on {haId} to {data}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/home-connect:home-connect-programs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

home-connect-programs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Home Connect Programs API
  description: 'This API provides access to home appliances enabled by Home Connect

    (https://home-connect.com). Through the API programs can be started and

    stopped, or home appliances configured and monitored. For instance, you can

    start a cotton program on a washer and get a notification when the cycle is

    complete.


    To get started with this web client, visit https://developer.home-connect.com

    and register an account. An application with a client ID for this API client

    will be automatically generated for you.


    If you want to use your custom application here, please remember to set its

    Redirect URI to https://apiclient.home-connect.com/o2c.html, otherwise

    authorization process will fail.


    In order to use this API in your own client, you need an OAuth 2 client

    implementing the authorization code grant flow

    (https://api-docs.home-connect.com/authorization?#authorization-code-grant-flow).


    More details can be found here: https://www.rfc-editor.org/rfc/rfc6749.txt


    Authorization URL: https://api.home-connect.com/security/oauth/authorize


    Token URL: https://api.home-connect.com/security/oauth/token'
  version: '1'
servers:
- url: https://api.home-connect.com/api
tags:


# --- truncated at 32 KB (64 KB total) ---
# Full source: https://artifacts.apis.io/home-connect/openapi/home-connect-programs-api-openapi.yml