Class QMK

Retrieve metadata about keyboards

const { git_hash, last_updated, keyboards } = await client.keyboards('massdrop/alt');

Retrieve keyboard metadata by product ID. Product IDs can be shared among multiple keyboards. As a result, an object will always be returned from this function, even if there's only one matching keyboard

const vendor = '0x04D8'; // Massdrop
const product = '0xEED3'; // Alt
const keyboards = await client.product(vendor, product);
console.info(keyboards);

Get the readme file associated with the keyboard

Retrieve keyboard metadata by vendor and product ID

const vendor = '0x04D8';
const { [vendor]: massdrop } = await client.usb('https://api.qmk.fm/');
console.info(massdrop);

Retrieve keyboard metadata by vendor ID

const vendor = '0x04D8'; // Massdrop
const massdropKeyboards = await client.vendor(vendor);
console.info(massdropKeyboards);