Find a key

GET /v1/keys/{key} tells you which sizes keep a key. Sizes without it usually reach it through an Fn layer.

Key names

Use a key or a group, with hyphens or URL-encoded spaces: delete, insert, home, end, page-up, page-down, print-screen, f1 to f12, esc, backtick, right-ctrl, menu, arrow-keys, f-keys, navigation-keys or numpad. Add ?iso=true for UK/EU layouts.

Example

curl "https://api.hlplanet.com/v1/keys/f5"

{
  "key": "F5",
  "codes": [
    "F5"
  ],
  "layout": "ANSI",
  "sizes": [
    {
      "id": "full",
      "name": "Full-size (100%)",
      "has": "yes",
      "present": 1,
      "total": 1
    },
    {
      "id": "1800",
      "name": "98% (1800)",
      "has": "yes",
      "present": 1,
      "total": 1
    },
    {
      "id": "tkl",
      "name": "TKL (tenkeyless) (80%)",
      "has": "yes",
      "present": 1,
      "total": 1
    },
    {
      "id": "75",
      "name": "75%",
      "has": "yes",
      "present": 1,
      "total": 1
    },
    {
      "id": "65",
      "name": "65%",
      "has": "no",
      "present": 0,
      "total": 1
    },
    {
      "id": "60",
      "name": "60%",
      "has": "no",
      "present": 0,
      "total": 1
    }
  ],
  "notes": "Sizes without the key usually reach it through an Fn layer. Layouts vary slightly by brand.",
  "source": "https://www.hlplanet.com/keyboard-layout/"
}