Welcome to the Homey Web API reference 👋
Welcome to the documentation for
It is recommended to read the Homey Web API guide first before you use this reference.
This documentation is primarily intended by
Most likely you'll want to access a Homey from a server or front-end. Follow the installation instructions below, then head over to AthomCloudAPI to get started.
Include Homey API in your project:
npm install homey-api
Then include the API:
const AthomCloudAPI = require('homey-api/lib/AthomCloudAPI');
Include Homey API from our CDN:
You can then access the APIs using
To use Homey API inside of an Homey Pro app with the
homey:manager:api permission, see HomeyAPIApp.
Please report any issues you find in the Web API Issue Tracker.