homey-api
    TypeScript icon, indicating that this package has built-in type declarations

    1.5.30 • Public • Published

    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

    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.

    Node.js

    Include Homey API in your project:

    npm install homey-api

    Then include the API:

    const AthomCloudAPI = require('homey-api/lib/AthomCloudAPI');

    Browser

    Include Homey API from our CDN:

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

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

    In-app

    To use Homey API inside of an Homey Pro app with the homey:manager:api permission, see {@link HomeyAPIApp}.

    Issues

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

    Keywords

    none

    Install

    npm i homey-api

    DownloadsWeekly Downloads

    245

    Version

    1.5.30

    License

    none

    Unpacked Size

    648 kB

    Total Files

    78

    Last publish

    Collaborators

    • robinbolscher
    • weejewel
    • athombv-github-actions