# Home Assistant Integrations Scraper (`crawlerbros/home-assistant-integrations-scraper`) Actor Scrape the Home Assistant integrations catalog - 1,400+ smart home integrations. Search by keyword, browse by category/IoT class, or fetch specific integrations by domain name. - **URL**: https://apify.com/crawlerbros/home-assistant-integrations-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** Automation, Integrations - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. 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 Integrations Scraper Extract integrations from the Home Assistant official catalog — 1,400+ smart home integrations covering lighting, climate, media, energy, security, and more. ### What does this actor do? Home Assistant is the world's most popular open-source home automation platform. Its integration catalog documents all supported devices, services, and protocols. This actor scrapes the catalog to help you: - **Search** integrations by keyword (e.g., "philips", "sonos", "nest") - **Browse** by IoT class (Local Push, Cloud Polling, etc.), quality scale, or integration type - **Fetch specific integrations** by domain name Each record includes the domain name, title, description, IoT class, quality scale, integration type, and a link to the official documentation. ### Modes | Mode | Description | |------|-------------| | `search` | Full-text search in title, description, and domain | | `browse` | Filter integrations by IoT class, quality scale, or type | | `getByDomain` | Fetch one or more specific integrations by domain name | ### Input | Parameter | Type | Description | |-----------|------|-------------| | `mode` | String (required) | Operation mode: `search`, `browse`, or `getByDomain` | | `query` | String | Keyword to search for (mode=search) | | `iotClass` | String | Filter by IoT communication class (mode=browse) | | `qualityScale` | String | Filter by quality tier: platinum, gold, silver, bronze, legacy, internal | | `integrationType` | String | Filter by type: integration, device, service, hub, helper, etc. | | `domains` | Array | Domain names to fetch (mode=getByDomain) | | `maxItems` | Integer | Maximum number of records (1–10000, default 100) | #### Example: Search for Philips integrations ```json { "mode": "search", "query": "philips", "maxItems": 10 } ```` #### Example: Browse all platinum-quality local push integrations ```json { "mode": "browse", "iotClass": "Local Push", "qualityScale": "platinum", "maxItems": 50 } ``` #### Example: Get specific integrations by domain ```json { "mode": "getByDomain", "domains": ["hue", "mqtt", "sonos", "nest"], "maxItems": 10 } ``` ### Output Each record contains: | Field | Type | Description | |-------|------|-------------| | `domain` | String | Integration domain name (e.g., `hue`) | | `title` | String | Integration display name | | `description` | String | What the integration does | | `qualityScale` | String | Quality tier: `platinum`, `gold`, `silver`, `bronze`, `legacy`, `internal` | | `iotClass` | String | Communication method: `Local Push`, `Cloud Polling`, etc. | | `integrationType` | String | Type: `integration`, `device`, `service`, `hub`, `helper`, etc. | | `docUrl` | String | URL to the official Home Assistant documentation page | | `isLocalIntegration` | Boolean | True if the integration communicates locally (not via cloud) | | `isCloudIntegration` | Boolean | True if the integration requires cloud connectivity | | `sourceUrl` | String | Same as docUrl — canonical URL for this record | | `recordType` | String | Always `integration` | | `scrapedAt` | String | ISO 8601 timestamp of when the record was scraped | #### Sample output ```json { "domain": "hue", "title": "Philips Hue", "description": "Instructions on setting up Philips Hue within Home Assistant.", "qualityScale": "platinum", "iotClass": "Local Push", "integrationType": "hub", "docUrl": "https://www.home-assistant.io/integrations/hue/", "isLocalIntegration": true, "isCloudIntegration": false, "sourceUrl": "https://www.home-assistant.io/integrations/hue/", "recordType": "integration", "scrapedAt": "2026-05-30T12:00:00+00:00" } ``` ### IoT Classes | IoT Class | Description | |-----------|-------------| | `Local Push` | Device pushes state changes to Home Assistant locally (no cloud) | | `Local Polling` | Home Assistant polls the device locally (no cloud) | | `Cloud Push` | Cloud service pushes state changes to Home Assistant | | `Cloud Polling` | Home Assistant polls a cloud service for state | | `Assumed State` | State is assumed (e.g., after sending a command), not verified | | `Calculated` | State is derived/calculated from other entities | ### Quality Scales | Scale | Description | |-------|-------------| | `platinum` | Highest quality — full test coverage, strict code review | | `gold` | High quality — well maintained, good test coverage | | `silver` | Good quality — stable, functional tests | | `bronze` | Basic quality — functional but minimal tests | | `legacy` | Older integration — maintained but not actively improved | | `internal` | Internal Home Assistant integration (e.g., helpers, utilities) | ### FAQ **Is authentication required?** No. The integration catalog is publicly available at `https://www.home-assistant.io/integrations.json`. **How many integrations are available?** Over 1,400 integrations at time of writing, covering smart home devices, cloud services, protocols, and utilities. **What is the `domain` field?** The domain is Home Assistant's internal identifier for an integration (e.g., `hue` for Philips Hue, `mqtt` for MQTT). It's the URL slug in the documentation: `https://www.home-assistant.io/integrations/{domain}/`. **Can I find only locally-controlled integrations?** Yes — use `iotClass: "Local Push"` or `iotClass: "Local Polling"` in browse mode to find integrations that work without internet connectivity. **Can I filter by multiple criteria?** Yes — the `browse` mode supports combining `iotClass`, `qualityScale`, and `integrationType` filters simultaneously. # Actor input Schema ## `mode` (type: `string`): What to fetch: search by keyword, browse by category, or get specific integrations by domain name. ## `query` (type: `string`): Keyword to search for in integration title and description (e.g. 'philips', 'nest', 'sonos'). ## `iotClass` (type: `string`): Filter by how the integration communicates with devices. ## `qualityScale` (type: `string`): Filter by Home Assistant integration quality tier. ## `integrationType` (type: `string`): Filter by the type of integration. ## `domains` (type: `array`): Domain names of specific integrations to fetch (e.g. 'hue', 'sonos', 'nest', 'mqtt'). ## `maxItems` (type: `integer`): Hard cap on emitted records. ## Actor input object example ```json { "mode": "search", "query": "philips", "iotClass": "", "qualityScale": "", "integrationType": "", "maxItems": 5 } ``` # Actor output Schema ## `integrations` (type: `string`): Dataset containing all scraped Home Assistant integrations. # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "mode": "search", "query": "philips", "iotClass": "", "qualityScale": "", "integrationType": "", "maxItems": 5 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/home-assistant-integrations-scraper").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "mode": "search", "query": "philips", "iotClass": "", "qualityScale": "", "integrationType": "", "maxItems": 5, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/home-assistant-integrations-scraper").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 '{ "mode": "search", "query": "philips", "iotClass": "", "qualityScale": "", "integrationType": "", "maxItems": 5 }' | apify call crawlerbros/home-assistant-integrations-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/home-assistant-integrations-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Home Assistant Integrations Scraper", "description": "Scrape the Home Assistant integrations catalog - 1,400+ smart home integrations. Search by keyword, browse by category/IoT class, or fetch specific integrations by domain name.", "version": "1.0", "x-build-id": "pxp9BNGOgtkpSPpvG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~home-assistant-integrations-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-home-assistant-integrations-scraper", "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/crawlerbros~home-assistant-integrations-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-home-assistant-integrations-scraper", "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/crawlerbros~home-assistant-integrations-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-home-assistant-integrations-scraper", "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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "browse", "getByDomain" ], "type": "string", "description": "What to fetch: search by keyword, browse by category, or get specific integrations by domain name.", "default": "search" }, "query": { "title": "Search query (mode=search)", "type": "string", "description": "Keyword to search for in integration title and description (e.g. 'philips', 'nest', 'sonos')." }, "iotClass": { "title": "IoT class filter (mode=browse)", "enum": [ "", "Local Push", "Local Polling", "Cloud Push", "Cloud Polling", "Assumed State", "Calculated" ], "type": "string", "description": "Filter by how the integration communicates with devices.", "default": "" }, "qualityScale": { "title": "Quality scale filter", "enum": [ "", "platinum", "gold", "silver", "bronze", "legacy", "internal" ], "type": "string", "description": "Filter by Home Assistant integration quality tier.", "default": "" }, "integrationType": { "title": "Integration type filter", "enum": [ "", "integration", "device", "service", "hub", "helper", "brand", "entity", "hardware", "system", "virtual" ], "type": "string", "description": "Filter by the type of integration.", "default": "" }, "domains": { "title": "Domains (mode=getByDomain)", "type": "array", "description": "Domain names of specific integrations to fetch (e.g. 'hue', 'sonos', 'nest', 'mqtt').", "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on emitted records.", "default": 100 } } }, "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 } } } } } } } } } } ```