# Matter Device Lookup (`firedanceio/matter-device-lookup`) Actor

Turn Matter Vendor ID / Product ID pairs into real product names, device types, support links and certification status, straight from the official CSA Distributed Compliance Ledger.

- **URL**: https://apify.com/firedanceio/matter-device-lookup.md
- **Developed by:** [Firedance](https://apify.com/firedanceio) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.00 / 1,000 device founds

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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Matter Device Lookup

Turn Matter **Vendor ID / Product ID** pairs into real product names, device types, support links and certification
status, straight from the official **CSA Distributed Compliance Ledger** (DCL), the public registry of every Matter
vendor, product and certification.

Paste a list of devices and get a clean table back:

| Query | Vendor | Product | Device type | Certification |
|---|---|---|---|---|
| `0x100B/0x2184` | Signify | WiZ P45.E27 | Extended Color Light | certified |

### Who it's for

- **Smart home and IoT app developers** who see raw IDs during discovery or commissioning and need a name to show users.
- **Installers and integrators** auditing a site's devices: what each one is, who made it, and whether it's certified.
- **Retail, support and data teams** enriching device inventories or support tickets with product names and manuals.

### Input

- **Devices:** one per line as `VID/PID` or `VID+PID`. Use decimal (`4107`) or `0x` for hex (`0x100B`); digits alone are
  read as decimal. IDs come from a device's DNS-SD record (`VP=4107+8580`), its Basic Information cluster, or the
  onboarding payload in its QR code.
- **Vendor or brand names:** map names to Vendor IDs. Brands registered under another company are handled for you:
  Philips Hue and WiZ are registered by Signify, LIFX by Feit Electric.
- **Include certification:** adds status, certificate ID, date, Matter version and transport for the newest
  registered software version.
- **Ledger:** production (mainnet) or the test ledger.

### Output

One row per device with: vendor name, legal name and website; product name, label and part number; device type;
support, product and user manual links; pairing and factory reset hints; certification status, certificate ID, date,
software version, Matter version and transport. Vendor searches return the best-matching Vendor IDs.

Devices that aren't registered come back with `found: false`; malformed lines come back with an `error`, so one bad
line never stops a batch.

### Pricing

Pay per result:

- **$0.003 per device found** ($3 per 1,000)
- **$0.002 per vendor search**

Lookups that find nothing aren't charged. Each run also has Apify's standard start event ($0.00005), and platform usage is
included in the price.

### Notes

- Data is read live from the public DCL (`on.dcl.csa-iot.org`). Nothing is stored beyond your run's dataset.
- Not affiliated with the Connectivity Standards Alliance.
- Built by [Firedance](https://firedance.io), who make FirePod, a speaker that syncs smart lights to music. More of our
  open source smart home tools: [firedance.io/open-source](https://firedance.io/open-source/).

# Actor input Schema

## `devices` (type: `array`):

One device per line as VID/PID or VID+PID. Use decimal (4107) or 0x for hex (0x100B); digits alone are read as decimal. Examples: 0x100B/0x2184, 4107+8580. These come from a device's DNS-SD record (VP=4107+8580), its Basic Information cluster or its QR onboarding payload.

## `vendorSearch` (type: `array`):

Company or brand names to map to Vendor IDs, for example Eve, WiZ or LIFX. Brands registered under another company (Philips Hue and WiZ under Signify, LIFX under Feit Electric) are mapped for you.

## `includeCertification` (type: `boolean`):

Add certification status, certificate ID, date, Matter version and transport for the newest registered software version.

## `network` (type: `string`):

The production ledger (mainnet) or the test ledger (testnet).

## Actor input object example

```json
{
  "devices": [
    "0x100B/0x2184"
  ],
  "includeCertification": true,
  "network": "mainnet"
}
```

# Actor output Schema

## `devices` (type: `string`):

No description

## `allFields` (type: `string`):

No description

# 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 = {
    "devices": [
        "0x100B/0x2184"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("firedanceio/matter-device-lookup").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 = { "devices": ["0x100B/0x2184"] }

# Run the Actor and wait for it to finish
run = client.actor("firedanceio/matter-device-lookup").call(run_input=run_input)

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

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

```

## CLI example

```bash
echo '{
  "devices": [
    "0x100B/0x2184"
  ]
}' |
apify call firedanceio/matter-device-lookup --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,firedanceio/matter-device-lookup"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/Ibk5xAkPL4WTRrOwx/builds/JRP8clN5kT3H4GxRM/openapi.json