Home Connect (BSH appliances)

Home Connect (BSH appliances) Map API

Get information from Cleaning Robot: maps, rooms, zones, robot position, cleaning summaries

Documentation GitHub OpenAPI

Operations 15

GET /homeappliances/{haId}/map/maps Get all maps of a cleaning robot #

GET /homeappliances/{haId}/map/maps/{mapId} Get a specific map #

GET /homeappliances/{haId}/map/maps/{mapId}/occupancyGrid Get the occupancy grid of a map #

GET /homeappliances/{haId}/map/maps/{mapId}/layout Get the layout of a map #

GET /homeappliances/{haId}/map/maps/{mapId}/cleaningStatus Get the cleaning status of a map #

GET /homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects Get all detected objects of a map #

GET /homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects/{objectId} Get a specific detected object #

GET /homeappliances/{haId}/map/maps/{mapId}/rooms Get all rooms of a map #

GET /homeappliances/{haId}/map/maps/{mapId}/rooms/{roomId} Get a specific room #

GET /homeappliances/{haId}/map/maps/{mapId}/zones Get all zones of a map #

GET /homeappliances/{haId}/map/maps/{mapId}/zones/{zoneId} Get a specific zone #

GET /homeappliances/{haId}/map/robot/position Get the current position of the cleaning robot #

GET /homeappliances/{haId}/map/config/restrictions Get the map configuration restrictions #

GET /homeappliances/{haId}/map/cleaningSummary Get all cleaning summaries #

GET /homeappliances/{haId}/map/cleaningSummary/{counter} Get a specific cleaning summary #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/home-connect/openapi/home-connect-map-api-openapi.yml

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-map-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Home Connect Map 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 (44 KB total) ---
# Full source: https://artifacts.apis.io/home-connect/openapi/home-connect-map-api-openapi.yml