qmk_firmware/docs/api_overview.md

# QMK API

The QMK API 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).

## Keyboard Maintainers

If you would like to enhance your keyboard's support in the QMK Compiler API head over to the [Keyboard Support](reference_configurator_support) section.

## Backend Developers

If you are interested in working on the API itself you should start by setting up a [Development Environment](api_development_environment), then check out [Hacking On The API](api_development_overview).
Add API documentation 2020-02-24 06:37:25 +00:00			`# QMK API`

[Docs] Use HTTPS for images and links where possible (#11695) 2021-01-30 11:00:56 +00:00			`The QMK API 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.`
Add API documentation 2020-02-24 06:37:25 +00:00
			`## App Developers`

Vitepress conversion of docs. (#23795) 2024-05-30 02:00:41 +00:00			`If you are an app developer interested in using this API in your application you should head over to [Using The API](api_docs).`
Add API documentation 2020-02-24 06:37:25 +00:00
			`## Keyboard Maintainers`

Vitepress conversion of docs. (#23795) 2024-05-30 02:00:41 +00:00			`If you would like to enhance your keyboard's support in the QMK Compiler API head over to the [Keyboard Support](reference_configurator_support) section.`
Add API documentation 2020-02-24 06:37:25 +00:00
			`## Backend Developers`

Vitepress conversion of docs. (#23795) 2024-05-30 02:00:41 +00:00			`If you are interested in working on the API itself you should start by setting up a [Development Environment](api_development_environment), then check out [Hacking On The API](api_development_overview).`