Welcome to the Web API documentation 👋

🌍 Learn how to build great integrations.

The Homey Web API is a HTTP + Socket.IO API to control devices, manage Flows etc. It is used by Athom for the Homey Mobile App, Homey Web App, Alexa, Google Assistant etc.

The Web API is also used by HomeyScript and apps using the homey:manager:api permission.

The Web API is not yet available to the public.

Does your company have a great idea for an app? Contact us to request a Web API key.

Local Development

While the Web API is not yet available, you can use these API Credentials to test your project locally.

Key

Value

Client ID

5a8d4ca6eb9f7a2c9d6ccf6d

Client Secret

e3ace394af9f615857ceaa61b053f966ddcfb12a

Callback URL

http://localhost, http://localhost/oauth2/callback

Scopes

homey

It is not allowed to use these credentials for commercial or non-development purposes.

Example

const AthomCloudAPI = require('homey-api/lib/AthomCloudAPI');
// Create a Cloud API instance
const cloudApi = new AthomCloudAPI({
clientId: '...',
clientSecret: '...',
});
// Get the logged in user
const user = await cloudApi.getAuthenticatedUser();
// Get the first Homey of the logged in user
const homeyApi = await user.getFirstHomey();
// Create a session on this Homey
const homey = await homey.authenticate();
// Loop all devices
const devices = await homey.devices.getDevices();
for(const device of Object.values(devices)) {
// Turn device on
await device.setCapabilityValue('onoff', true);
}

👥 Community