Home Connect (BSH appliances) Map API

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

GitHub OpenAPI

Operations 15

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}/map/maps List saved cleaning maps of a robot · Get all maps of a cleaning robot #
Ask an LLM
“Which cleaning maps does my robot remember?”
“Can I see temporary maps that are not saved yet?”
Tell an agent
List cleaning maps for robot {haId}.
Show every map known to robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId} Get a map's basic info · Get a specific map #
Ask an LLM
“What is the basic information for one map on my robot?”
“Can I fetch a single map by its ID?”
Tell an agent
Get map {mapId} on robot {haId}.
Show the metadata of map {mapId} from robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId}/occupancyGrid Get a map's raw grid layout · Get the occupancy grid of a map #
Ask an LLM
“How do I get the raw grid layout of a robot map?”
“Is the occupancy grid delivered compressed?”
Tell an agent
Get the occupancy grid of map {mapId} on robot {haId}.
Download the raw layout grid for map {mapId} from robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId}/layout Get a map's vector walls and doors · Get the layout of a map #
Ask an LLM
“Where are the walls and doors on my robot's map?”
“Can I get the vector-based layout of a map?”
Tell an agent
Get the vector layout of map {mapId} on robot {haId}.
Show the walls and doors on map {mapId} from robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId}/cleaningStatus Get how far a map is cleaned · Get the cleaning status of a map #
Ask an LLM
“Which parts of the saved map have already been cleaned?”
“What cleaning progress has the robot made so far on this map?”
Tell an agent
Get the cleaning status of map {mapId} on robot {haId}.
Show which path map {mapId} has already covered on robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects List objects detected on a map · Get all detected objects of a map #
Ask an LLM
“What stains or pets has my robot detected on a map?”
“Can I see all detected objects on one map?”
Tell an agent
List detected objects on map {mapId} of robot {haId}.
Show every object detected on map {mapId} from robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects/{objectId} Get one detected object on a map · Get a specific detected object #
Ask an LLM
“Can I look up a single detected object by its ID?”
“What does one detected object on a map look like?”
Tell an agent
Get detected object {objectId} on map {mapId} of robot {haId}.
Show the details of object {objectId} detected on map {mapId} from robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId}/rooms List rooms defined on a map · Get all rooms of a map #
Ask an LLM
“Which rooms are defined on my robot's map?”
“Can I see all the room boundaries on a map?”
Tell an agent
List rooms on map {mapId} of robot {haId}.
Show every room defined on map {mapId} from robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId}/rooms/{roomId} Get one room on a map · Get a specific room #
Ask an LLM
“Can I fetch a single room by its ID?”
“What are the details of one room on a map?”
Tell an agent
Get room {roomId} on map {mapId} of robot {haId}.
Show the details of room {roomId} from map {mapId} on robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId}/zones List zones and no-go areas on a map · Get all zones of a map #
Ask an LLM
“What no-go zones or virtual barriers are on my robot's map?”
“Can I see all zones defined on a map?”
Tell an agent
List zones on map {mapId} of robot {haId}.
Show every no-go zone on map {mapId} from robot {haId}.
GET /homeappliances/{haId}/map/maps/{mapId}/zones/{zoneId} Get one zone on a map · Get a specific zone #
Ask an LLM
“Can I fetch a single zone by its ID?”
“What are the details of one zone on a map?”
Tell an agent
Get zone {zoneId} on map {mapId} of robot {haId}.
Show the details of zone {zoneId} from map {mapId} on robot {haId}.
GET /homeappliances/{haId}/map/robot/position Get the robot's current position · Get the current position of the cleaning robot #
Ask an LLM
“Where is my robot right now?”
“Which map is the robot currently on?”
Tell an agent
Get the current position of robot {haId}.
Tell me where robot {haId} is located and which map it's on.
GET /homeappliances/{haId}/map/config/restrictions Get map, room and zone limits · Get the map configuration restrictions #
Ask an LLM
“What map and zone limits does my robot support?”
“Which values are allowed for rooms and zones on my robot?”
Tell an agent
Get the map configuration restrictions for robot {haId}.
Show which map, room and zone properties robot {haId} supports.
GET /homeappliances/{haId}/map/cleaningSummary List cleaning run summaries · Get all cleaning summaries #
Ask an LLM
“What cleaning runs has my robot stored?”
“Can I see summaries of past cleanings with their map data?”
Tell an agent
List all cleaning summaries for robot {haId}.
Show every cleaning run summary stored on robot {haId}.
GET /homeappliances/{haId}/map/cleaningSummary/{counter} Get a cleaning run's summary · Get a specific cleaning summary #
Ask an LLM
“What does the summary of one cleaning run say?”
“Can I read the result of a specific cleaning pass?”
Tell an agent
Get cleaning summary {counter} for robot {haId}.
Show the cleaning result for cleaning run {counter} on robot {haId}.

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"

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-map-api-openapi.yml Raw ↑
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