# Home Connect (BSH appliances) Map API

**Canonical:** https://apis.io/apis/home-connect/home-connect-map-api/  
**Provider:** Home Connect (BSH appliances) — https://apis.io/providers/home-connect/  
**Base URL:** https://api.home-connect.com  
**Documentation:** https://developer.home-connect.com/

Home Connect (BSH appliances) Map API is one of 8 APIs that [Home Connect (BSH appliances)](https://apis.io/providers/home-connect/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include map. The published artifact set on APIs.io includes an OpenAPI specification.

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

## Operations (15)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (1)

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

## Other Home Connect (BSH appliances) APIs (7)

- [Home Connect (BSH appliances) Appliances API](https://apis.io/apis/home-connect/home-connect-appliances-api/)
- [Home Connect (BSH appliances) Commands API](https://apis.io/apis/home-connect/home-connect-commands-api/)
- [Home Connect (BSH appliances) Events API](https://apis.io/apis/home-connect/home-connect-events-api/)
- [Home Connect (BSH appliances) Images API](https://apis.io/apis/home-connect/home-connect-images-api/)
- [Home Connect (BSH appliances) Programs API](https://apis.io/apis/home-connect/home-connect-programs-api/)
- [Home Connect (BSH appliances) Settings API](https://apis.io/apis/home-connect/home-connect-settings-api/)
- [Home Connect (BSH appliances) Status API](https://apis.io/apis/home-connect/home-connect-status-api/)

## Tags

map

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/home-connect/home-connect-map-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/home-connect/.