https://github.com/qmk/qmk_api
QMK API, information on keyboards and keymaps, and a compile service.
https://github.com/qmk/qmk_api
firmware flask json qmk redis
Last synced: 9 months ago
JSON representation
QMK API, information on keyboards and keymaps, and a compile service.
- Host: GitHub
- URL: https://github.com/qmk/qmk_api
- Owner: qmk
- License: other
- Created: 2017-08-19T23:31:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-21T12:40:57.000Z (11 months ago)
- Last Synced: 2025-05-15T08:26:49.411Z (10 months ago)
- Topics: firmware, flask, json, qmk, redis
- Language: Python
- Homepage: http://api.qmk.fm/
- Size: 149 KB
- Stars: 36
- Watchers: 14
- Forks: 22
- Open Issues: 14
-
Metadata Files:
- Readme: docs/readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
# QMK Compiler
The QMK Compiler provides an asynchronous API that Web and GUI tools can use to compile arbitrary keymaps for any keyboard supported by [QMK](https://qmk.fm/). The stock keymap template supports all QMK keycodes that do not require supporting C code. Keyboard maintainers can supply their own custom templates to enable more functionality.
## App Developers
If you are an app developer interested in using this API in your application you should head over to [Using The API](api_docs.md).
## Keyboard Maintainers
If you would like to enhance your keyboard's support in the QMK Compiler API head over to the [Keyboard Support](keyboard_support.md) section.
## Backend Developers
If you are interested in working on the API itself you should start by setting up a [Development Environment](development_environment.md), then check out [Hacking On The API](development_overview.md).