Homey Python API Docs | dltHub

Homey's Web API allows external servers to control devices and start flows. To use it, create a Web API Client for credentials. The Homey Web API uses HTTP and Socket.IO for communication. The REST API base URL is https://<cloudid>.connect.athom.com/api/ and OAuth2-based flow for API Clients + delegation to Homey; final requests use Bearer JWT tokens in Authorization header..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Homey data in under 10 minutes.

---

What data can I load from Homey?

Here are some of the endpoints you can load from Homey:

---

How do I authenticate with the Homey API?

Authentication involves an OAuth2-based flow to obtain a token, which is then used as a Bearer token in the Authorization header for all subsequent API requests.

1. Get your credentials

1. Navigate to the Homey Developer website (api.developer.homey.app).
2. Create your own Web API Client to obtain your Client ID and Client Secret.
3. Implement the OAuth2 authentication flow with your application to allow customers to authenticate and grant your application access to their Homey data.
4. Upon successful OAuth2 authentication, you will receive an access token (Bearer token) that can be used for API calls.

2. Add them to .dlt/secrets.toml

Copy
[sources.homey_web_api_source]
token = "your_bearer_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Homey API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python homey_web_api_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline homey_web_api_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset homey_web_api_data
The duckdb destination used duckdb:/homey_web_api.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline homey_web_api_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads devices and sessions from the Homey API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def homey_web_api_source(token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://<cloudid>.connect.athom.com/api/",
            "auth": {
                "type": "bearer",
                "token": token,
            },
        },
        "resources": [
            {"name": "devices", "endpoint": {"path": "api/manager/devices/device/"}},
            {"name": "sessions", "endpoint": {"path": "api/manager/sessions/session/"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="homey_web_api_pipeline",
        destination="duckdb",
        dataset_name="homey_web_api_data",
    )
    load_info = pipeline.run(homey_web_api_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("homey_web_api_pipeline").dataset()
sessions_df = data.sessions.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM homey_web_api_data.sessions LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("homey_web_api_pipeline").dataset()
data.sessions.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Homey data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack