Data endpoints

Endpoints

The four segment manifests share one shape: count and apps differ, and so does updated — the latest verification-or-addition date within that segment, not catalogue-wide. Everything else is identical, so a client that reads one manifest can read them all. /api/{slug}.json serves one full entry at a time.

Payload schema

Every field actually emitted by /api/{slug}.json, field by field. The lightweight manifest entries in the segment manifests above carry a subset of these same values (slug, name, category, totalShortcuts, lastVerified, hash, page) plus one field of their own: data, the absolute URL of the full payload below for that entry.

dataVersion and hash

Every manifest carries a top-level dataVersion, rolled up from every app's own hash. Each app's hash fingerprints one subset of that entry — slug, name, category, os, platforms, lastVerified, and every shortcut and binding in the entry — but not the rest of the payload: categoryLabel, website, stores, description, totalShortcuts, added, sources, hasPoster, page, and the order of the items within each group — which follows an editorial priority the payload does not expose — all sit outside it. Editing one of those alone changes the JSON a client receives but moves neither the per-app hash nor dataVersion. So comparing dataVersion, then per-app hash, reliably catches changed shortcuts, bindings, or a new verification date — it is not a full-payload integrity check.

{
  "dataVersion": "e3f1a9c7d5b2846f",
  "apps": [
    {
      "slug": "blender",
      "hash": "9f3a2c1d4b6e",
      "data": "https://shortcutposters.com/api/blender.json"
    }
  ]
}

Feeds

Recently-added entries, as RSS and JSON Feed, one pair per segment.

Version policy

• Existing field names never disappear and never change type.
• Adding a new field is not a breaking change.
• dataVersion changes exactly when a fingerprinted field changes — see dataVersion and hash above for what that covers.
• A breaking change would live under a new /api/v2/ path — the current, flat paths stay in place during the transition. /api/v1/ already works today as an alias of those same flat paths.

Terms of use

• Keyboard shortcuts and gamepad bindings are facts: nobody owns them, and you are free to use them.
• The compilation is our editorial work — the normalisation, the categories, and the source and verification metadata attached to every entry.
• Reuse of this data requires visible attribution: credit ShortcutPosters and link to shortcutposters.com.
• Reselling or redistributing the compiled database, in whole or in substantial part, is not permitted.
• These terms cover the data only. Logos, icons and cover art shown on the site are their owners' and are not licensed here.

Full terms on the licensing page →

Examples

The games manifest, then one entry's shortcut groups:

# The games manifest, then the detail of one entry
curl -s https://shortcutposters.com/api/games.json | jq '.apps[0]'
curl -s https://shortcutposters.com/api/baldurs-gate-3.json | jq '.groups[0]'

The same walk in JavaScript, following the manifest's own links:

const index = await fetch("https://shortcutposters.com/api/apps.json").then((r) => r.json());
const app = index.apps.find((a) => a.slug === "blender");
const data = await fetch(app.data).then((r) => r.json());
console.log(data.groups.flatMap((g) => g.items).length, "shortcuts");