Welcome to the Homey Web API reference 👋

npm

Welcome to the documentation for homey-api — a JavaScript client for all of Athom's Web APIs, including Homey.

It is recommended to read the Homey Web API guide first before you use this reference.

This documentation is primarily intended by homey-api users in a JavaScript environment (Node.js, Browser, React Native). However, all HTTP endpoints are documented as well, if you prefer to use another client.

Getting Started

Node.js

First, add homey-api to your project:

$ npm i homey-api

Then, most likely you'll want to access a Homey from a server or front-end. Head over to AthomCloudAPI to get started.

Browser

Include Homey API from our CDN:

<script type="text/javascript" src="https://cdn.athom.com/homey-api/latest.js"></script>

You can then access the APIs using window.AthomCloudAPI etc.

Issues

Please report any issues you find in the Web API Issue Tracker.