{ "openapi": "3.0.1", "info": { "title": "Matter & Zigbee Device Compatibility Database", "description": "Is this device Matter-certified or supported by Zigbee2MQTT? Every Matter product (official CSA ledger) and every Zigbee2MQTT device in one filterable dataset: brand, model, category, connectivity, certification. Monitor new devices.", "version": "1.0", "x-build-id": "CD2DuyKhzVgqzJvx2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jet_mythology~smart-home-device-compatibility/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jet_mythology-smart-home-device-compatibility", "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/jet_mythology~smart-home-device-compatibility/runs": { "post": { "operationId": "runs-sync-jet_mythology-smart-home-device-compatibility", "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/jet_mythology~smart-home-device-compatibility/run-sync": { "post": { "operationId": "run-sync-jet_mythology-smart-home-device-compatibility", "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": { "sources": { "title": "Sources", "type": "array", "description": "Matter = products certified by the Connectivity Standards Alliance. Zigbee2MQTT = Zigbee devices supported by Zigbee2MQTT / Home Assistant.", "items": { "type": "string", "enum": [ "matter", "zigbee2mqtt" ], "enumTitles": [ "Matter (CSA certified)", "Zigbee (Zigbee2MQTT)" ] }, "default": [ "matter", "zigbee2mqtt" ] }, "brands": { "title": "Brands", "type": "array", "description": "Keep only these brands (case-insensitive, partial match: 'aqara' matches 'Aqara'). Empty = all brands.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep devices whose brand, model, name, description, device type or features contain at least one keyword.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Keep only these device categories. Empty = all.", "items": { "type": "string", "enum": [ "light", "plug", "switch", "remote", "motion-sensor", "contact-sensor", "climate-sensor", "leak-sensor", "smoke-co-alarm", "air-quality-sensor", "thermostat", "radiator-valve", "lock", "blind", "camera", "doorbell", "water-valve", "siren", "energy", "fan", "air-purifier", "vacuum", "appliance", "media", "hub", "other" ] } }, "connectivity": { "title": "Connectivity", "type": "array", "description": "Keep devices using at least one of these radios / networks.", "items": { "type": "string", "enum": [ "thread", "wi-fi", "ethernet", "bluetooth", "zigbee" ], "enumTitles": [ "Thread", "Wi-Fi", "Ethernet", "Bluetooth", "Zigbee" ] } }, "addedWithinDays": { "title": "Added in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only devices certified (Matter) or added to Zigbee2MQTT in the last N days. Empty = no date filter." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Upper limit of devices output (and charged) per run.", "default": 1000 }, "monitorNewDevices": { "title": "Monitor mode: output only new devices", "type": "boolean", "description": "Remembers the devices already output and, on the next runs, outputs only devices that appeared since. Schedule the Actor daily or weekly to get a feed of new products.", "default": false }, "monitorKey": { "title": "Monitor name", "type": "string", "description": "Use a different name for each saved search you monitor (e.g. 'aqara-sensors').", "default": "default" }, "monitorFirstRun": { "title": "First monitoring run", "enum": [ "outputAll", "baselineOnly" ], "type": "string", "description": "What to do the first time a monitor runs.", "default": "outputAll" }, "includeRevoked": { "title": "Include revoked Matter certifications", "type": "boolean", "description": "Also output Matter products whose certification was revoked (marked certificationStatus = revoked).", "default": false }, "dclNodeUrl": { "title": "DCL node URL", "type": "string", "description": "Public REST endpoint of a CSA Distributed Compliance Ledger node. Leave empty for the default (https://on.dcl.csa-iot.org)." }, "zigbee2mqttUrl": { "title": "Zigbee2MQTT list URL", "type": "string", "description": "Leave empty for the default (the supported-devices page source on GitHub)." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }