Class QMK

Retrieve the list of compiled firmware files from the QMK CI server

const { last_updated, files } = await client.firmware();
Copy

Retrieve metadata for a single keyboard. Cached after first fetch.

const kb = await client.keyboard('crkbd/rev1');
Copy

Retrieve keyboard metadata. By default returns a name-only dictionary (keyboards values are undefined). Pass detailed: true to fetch full keyboard objects for every entry (~28MB download). Results are cached after the first fetch.

const { keyboards } = await client.keyboards();
const { keyboards } = await client.keyboards({ detailed: true });
Copy

Retrieve keyboard metadata. By default returns a name-only dictionary (keyboards values are undefined). Pass detailed: true to fetch full keyboard objects for every entry (~28MB download). Results are cached after the first fetch.

const { keyboards } = await client.keyboards();
const { keyboards } = await client.keyboards({ detailed: true });
Copy

Get keymap data for a keyboard

const { keyboards } = await client.keymaps('crkbd/rev1', 'default');
Copy

Retrieve keyboard metadata by USB vendor and product ID. Returns an object since multiple keyboards can share a product ID.

const keyboards = await client.product('0x04D8', '0xEED3');
Copy

Get the readme for a keyboard

const md = await client.readme('crkbd/rev1');
Copy

Retrieve keyboard metadata indexed by USB vendor and product ID

const vendors = await client.usb();
Copy

Retrieve keyboards for a given USB vendor ID

const products = await client.vendor('0x04D8');
Copy