# HLPlanet Keyboard API

> Free JSON API for keyboard size data from HLPlanet: standard layouts from full-size to 60%, the measured case size of 30 keyboards, side-by-side comparisons, desk and mousepad fit, and which sizes have a given key. No API key. Base URL: https://api.hlplanet.com/v1

Every docs page is available as HTML and as Markdown (add .md to the URL, or send Accept: text/markdown).

## Docs

- [Overview](https://api.hlplanet.com/index.md): Overview, base URL, quick start and the list of endpoints.
- [Keyboard sizes](https://api.hlplanet.com/docs/sizes.md): GET /v1/sizes and GET /v1/sizes/{id}: standard layouts from full-size to 60%.
- [Measured keyboards](https://api.hlplanet.com/docs/keyboards.md): GET /v1/keyboards and GET /v1/keyboards/{id}: case sizes measured in HLPlanet reviews.
- [Compare keyboards](https://api.hlplanet.com/docs/compare.md): GET /v1/compare: two to six sizes or keyboards side by side, with width, depth and key differences.
- [Desk fit](https://api.hlplanet.com/docs/desk-fit.md): GET /v1/desk-fit: whether a keyboard and mousepad fit side by side on a desk, and whether a 360° turn fits.
- [Find a key](https://api.hlplanet.com/docs/keys.md): GET /v1/keys/{key}: which keyboard sizes have a key or key group, such as Delete, F5 or the numpad.
- [Testing tools](https://api.hlplanet.com/docs/tools.md): GET /v1/tools: free HLPlanet browser tools for testing keyboards and controllers.
- [MCP server](https://api.hlplanet.com/docs/mcp.md): Remote MCP server at /mcp: the keyboard data as tools for Claude, Cursor, VS Code and Hermes Agent.
- [Errors](https://api.hlplanet.com/docs/errors.md): Error format and codes shared by every endpoint.

## Reference

- [OpenAPI 3.0 specification](https://api.hlplanet.com/openapi.json): every endpoint, parameter and response.

## Optional

- [HLPlanet keyboard size comparison](https://www.hlplanet.com/keyboard-layout/): the interactive tool that draws these layouts to scale.
- [HLPlanet MCP server](https://github.com/hlplanet/hlplanet-mcp): the same data as MCP tools for AI assistants (npx -y hlplanet-mcp).