# Home Assistant Integration Health Monitor (`animizio/home-assistant-integration-health-monitor`) Actor

Check Home Assistant and HACS integrations for stale repos, breaking changes, release activity, open issues, and update risk.

- **URL**: https://apify.com/animizio/home-assistant-integration-health-monitor.md
- **Developed by:** [Daniel](https://apify.com/animizio) (community)
- **Categories:** Automation, Integrations, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $10.00 / 1,000 integration health checks

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## Home Assistant Integration Health Monitor

Check Home Assistant Core integrations and HACS/GitHub repositories for update risk, maintenance status, and breaking-change signals.

This Apify Actor is designed for Home Assistant power users, smart-home maintainers, and AI agents that need a structured signal before updating integrations.

### What it checks

- GitHub repository activity: archived status, recent commits, recent releases, open issue count
- Open issue titles for failure keywords such as `not working`, `crash`, `setup failed`
- Breaking/deprecation keywords in issues and recent release titles
- Optional matching against a Home Assistant version string
- Home Assistant integration docs availability and selected docs keywords

### What it does **not** do

- It does not connect to your private Home Assistant instance.
- It does not control devices or access secrets.
- It does not guarantee that an update is safe.
- It does not replace backups, staging tests, or reading release notes.

### Example input

```json
{
  "homeAssistantVersion": "2026.7.0",
  "integrations": ["reolink", "mqtt", "hue"],
  "hacsRepos": ["hacs/integration"],
  "includeCoreIntegrations": true,
  "includeHacsRepos": true,
  "lookbackDays": 90,
  "riskOnly": false,
  "maxItems": 10,
  "githubToken": "",
  "outputMode": "summary"
}
````

### Example output

```json
{
  "id": "github:hacs/integration",
  "name": "integration",
  "source_type": "hacs_repo",
  "repo": "hacs/integration",
  "health_score": 86,
  "risk_level": "low",
  "recommendation": "Low risk (86/100): recent commit activity. Review release notes before updating.",
  "open_issues": 42,
  "critical_issue_count": 0,
  "breaking_change_count": 0,
  "sources": ["https://github.com/hacs/integration"]
}
```

### Risk scoring

- `low`: score >= 80 and no hard red flags
- `medium`: score 55-79 or update-related warnings
- `high`: score < 55, archived repos, or strong abandonment/deprecation signals

Scoring uses a transparent heuristic, not a hidden LLM. It is intended to prioritize review work, not to make final update decisions.

### Pricing recommendation

Recommended pay-per-event setup:

- Keep Apify's synthetic `apify-actor-start` event at its default price.
- Add one custom event: `integration-check`.
- Suggested initial price for `integration-check`: `$0.01`.

The code pushes each dataset item with the `integration-check` event name and stops when the user's configured charge limit is reached.

### Local development

```bash
python -m venv .venv
. .venv/bin/activate
pip install -r requirements-dev.txt
pytest
python scripts/run_local.py examples/input.json
```

### Apify deployment

```bash
apify login
apify push
```

Then configure monetization in Apify Console under the Actor's **Publication** tab.

# Actor input Schema

## `homeAssistantVersion` (type: `string`):

Optional Home Assistant version to look for in issues and release notes, e.g. 2026.7.0.

## `integrations` (type: `array`):

Home Assistant core integration domains to check, e.g. reolink, mqtt, hue.

## `hacsRepos` (type: `array`):

GitHub repositories in owner/repo format, e.g. hacs/integration.

## `includeCoreIntegrations` (type: `boolean`):

When enabled, check Home Assistant core integration domains listed in integrations.

## `includeHacsRepos` (type: `boolean`):

When enabled, check HACS or GitHub repositories listed in hacsRepos.

## `lookbackDays` (type: `integer`):

Used for activity and risk scoring.

## `riskOnly` (type: `boolean`):

When enabled, output only records with medium or high risk.

## `maxItems` (type: `integer`):

Maximum number of integrations/repositories to check in one run.

## `githubToken` (type: `string`):

Optional token for higher GitHub API rate limits. Leave empty for public unauthenticated requests.

## `outputMode` (type: `string`):

summary keeps rows compact; detailed includes more raw counters and matched issue titles.

## Actor input object example

```json
{
  "integrations": [
    "reolink",
    "mqtt",
    "hue"
  ],
  "hacsRepos": [
    "hacs/integration"
  ],
  "includeCoreIntegrations": true,
  "includeHacsRepos": true,
  "lookbackDays": 90,
  "riskOnly": false,
  "maxItems": 50,
  "outputMode": "summary"
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("animizio/home-assistant-integration-health-monitor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("animizio/home-assistant-integration-health-monitor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call animizio/home-assistant-integration-health-monitor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=animizio/home-assistant-integration-health-monitor",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Home Assistant Integration Health Monitor",
        "description": "Check Home Assistant and HACS integrations for stale repos, breaking changes, release activity, open issues, and update risk.",
        "version": "0.1",
        "x-build-id": "yfLQVjixgWwY5Ifv0"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/animizio~home-assistant-integration-health-monitor/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-animizio-home-assistant-integration-health-monitor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/animizio~home-assistant-integration-health-monitor/runs": {
            "post": {
                "operationId": "runs-sync-animizio-home-assistant-integration-health-monitor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/animizio~home-assistant-integration-health-monitor/run-sync": {
            "post": {
                "operationId": "run-sync-animizio-home-assistant-integration-health-monitor",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "homeAssistantVersion": {
                        "title": "Home Assistant version",
                        "type": "string",
                        "description": "Optional Home Assistant version to look for in issues and release notes, e.g. 2026.7.0."
                    },
                    "integrations": {
                        "title": "Core integration domains",
                        "type": "array",
                        "description": "Home Assistant core integration domains to check, e.g. reolink, mqtt, hue.",
                        "default": [
                            "reolink",
                            "mqtt",
                            "hue"
                        ],
                        "items": {
                            "type": "string"
                        }
                    },
                    "hacsRepos": {
                        "title": "HACS or GitHub repositories",
                        "type": "array",
                        "description": "GitHub repositories in owner/repo format, e.g. hacs/integration.",
                        "default": [
                            "hacs/integration"
                        ],
                        "items": {
                            "type": "string"
                        }
                    },
                    "includeCoreIntegrations": {
                        "title": "Check core integrations",
                        "type": "boolean",
                        "description": "When enabled, check Home Assistant core integration domains listed in integrations.",
                        "default": true
                    },
                    "includeHacsRepos": {
                        "title": "Check HACS/GitHub repositories",
                        "type": "boolean",
                        "description": "When enabled, check HACS or GitHub repositories listed in hacsRepos.",
                        "default": true
                    },
                    "lookbackDays": {
                        "title": "Activity lookback days",
                        "minimum": 7,
                        "maximum": 730,
                        "type": "integer",
                        "description": "Used for activity and risk scoring.",
                        "default": 90
                    },
                    "riskOnly": {
                        "title": "Only output medium/high risk records",
                        "type": "boolean",
                        "description": "When enabled, output only records with medium or high risk.",
                        "default": false
                    },
                    "maxItems": {
                        "title": "Maximum items to check",
                        "minimum": 1,
                        "maximum": 500,
                        "type": "integer",
                        "description": "Maximum number of integrations/repositories to check in one run.",
                        "default": 50
                    },
                    "githubToken": {
                        "title": "GitHub token (optional)",
                        "type": "string",
                        "description": "Optional token for higher GitHub API rate limits. Leave empty for public unauthenticated requests."
                    },
                    "outputMode": {
                        "title": "Output mode",
                        "enum": [
                            "summary",
                            "detailed"
                        ],
                        "type": "string",
                        "description": "summary keeps rows compact; detailed includes more raw counters and matched issue titles.",
                        "default": "summary"
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
