API made by us for you to explore
Home Connect offers a RESTful API to control and monitor enabled home appliances. The following chapters provide details about the usage of this API. For a quick start you can use our API client based on Swagger.
We completely rebuilt the API Docs. Be one of the first to have a look at the new beta version
- General
- Authorization
- Programs and Options
- States
- Settings
- Power State
- Temperature Unit
- Liquid Volume Unit
- Setpoint Temperature Refrigerator
- Setpoint Temperature Freezer
- Setpoint Temperature Bottle Cooler
- Setpoint Temperature Chiller
- Setpoint Temperature Wine Comp.
- Super Mode Refrigerator
- Super Mode Freezer
- Eco Mode
- Sabbath Mode
- Vacation Mode
- Fresh Mode
- Current Map
- Names of Maps
- Functional Light
- Functional Light Brightness
- Ambient Light
- Ambient Light Brightness
- Ambient Light Color
- Ambient Light Custom Color
- Events
- Commands
Endpoints and Data Encoding
API of simulated home appliances
https://simulator.home-connect.com
API of physical home appliances
https://api.home-connect.com or
https://api.home-connect.cn - This domain has to be used if you want to create an application for China. In this case please enable Sync to China in the account settings.
Data Encoding
The Home Connect API is based on HTTPS carrier with JSON data encoding.
All JSON transfer units are encoded with the following structure:
{ // API Response Object
"data": { ... }, // JSON Object containing the content of a successful request. Absent in case of error.
"error": { ... } // API Error Object containing details / reasons for the error. Absent in case of success.
}