Home Assistant REST API

www.home-assistant.io

Home Assistant provides a JSON REST API for reading configuration and state and controlling integrations in a self-hosted home automation instance.

API

What your agent can do

  • Returns a message if the API is up and running.

    Via API.

Tasks depend on the interface and permissions.

Connection methods

Choose a route that fits your agent.

API connection
API path
http://IP_ADDRESS:8123/api/

Authentication
All API calls have to be accompanied by the header `Authorization: Bearer TOKEN`, where `TOKEN` is replaced by your unique access token. You obtain a token ("Long-Lived Access Token") by logging into the frontend using a web browser, and going to your profile `http://IP_ADDRESS:8123/profile`.

Documentation & experience

  • 1 connection path
View sources and checks
How documentation is checked