qmk / qmk_api

QMK API, information on keyboards and keymaps, and a compile service.

QMK Compiler API

JSON API for building a customized firmware.

Goals

• Make it easy for apps to compile custom firmware
• Generate a compiled firmware for any QMK keyboard

Style

We follow the style guidelines for QMK and have provided a yapf config in setup.cfg.

How Do I Use This API?

Our documentation lives on GitBook and can be found here:

https://docs.api.qmk.fm/using-the-api