> Documentation index: https://api.hlplanet.com/llms.txt. Every page is also available as Markdown by adding .md to its URL.

# Measured keyboards

`GET /v1/keyboards` lists 30 keyboards with the case width and depth measured in their HLPlanet review. `GET /v1/keyboards/{id}` returns one keyboard.

## Query parameters for the list

| Parameter | Example | Meaning |
|---|---|---|
| `size` | `75` | Only keyboards of this size (any id from [Sizes](https://api.hlplanet.com/docs/sizes)) |
| `q` | `wooting` | Every word must appear in the keyboard name |

## Example

```bash
curl "https://api.hlplanet.com/v1/keyboards/wooting-80he"
```

```json
{
  "id": "wooting-80he",
  "name": "Wooting 80HE",
  "size": "80%",
  "layout_id": "tkl",
  "keys": 87,
  "width_mm": 346,
  "depth_mm": 142,
  "review_url": "https://www.hlplanet.com/wooting-80he-vs-60he/",
  "compare_url": "https://www.hlplanet.com/keyboard-layout/?compare=m-wooting-80he"
}
```

The `id` values come from the list endpoint, for example `nuphy-air75-he`, `mchose-jet75` or `drunkdeer-g60`. A unique name also works: `/v1/keyboards/jet%2075`.
