MIDI Guide API v4.0.0

GET /v4/devices/ ¶

Index of all manufacturers and devices

Every manufacturer and device in the database, keyed by slug, with per-device metadata. Fetch a device's data from its url.

Example request

curl https://api.midi.guide/v4/devices/

Example response (truncated)

{
  "manufacturers": {
    "arturia": {
      "name": "Arturia",
      "slug": "arturia",
      "url": "https://api.midi.guide/v4/devices/arturia/",
      "devices": {
        "microfreak": {
          "name": "MicroFreak",
          "slug": "microfreak",
          "last_updated": "2026-04-27T19:08:37Z",
          "has_ccs": true,
          "has_triggers": false,
          "parameter_count": 21,
          "trigger_count": 0,
          "url": "https://api.midi.guide/v4/devices/arturia/microfreak/"
        },
        …
      }
    },
    …
  }
}

Try it live:
/v4/devices/

GET /v4/devices/{manufacturer_slug}/ ¶

Index of one manufacturer's devices

The same shape as the full index, scoped to one manufacturer.

Example request

curl https://api.midi.guide/v4/devices/elektron/

Example response (truncated)

{
  "name": "Elektron",
  "slug": "elektron",
  "url": "https://api.midi.guide/v4/devices/elektron/",
  "devices": {
    "analog-four": {
      "name": "Analog Four",
      "slug": "analog-four",
      "last_updated": "2024-09-12T13:45:16Z",
      "has_ccs": true,
      "has_triggers": false,
      "parameter_count": 32,
      "trigger_count": 0,
      "url": "https://api.midi.guide/v4/devices/elektron/analog-four/"
    },
    …
  }
}

Try it live:
/v4/devices/elektron/

GET /v4/devices/{manufacturer_slug}/{device_slug}/ ¶

One device's MIDI implementation

The canonical JSON (metadata + ccs + triggers), or a device/software-specific export chosen with ?format= - see the format table in the API description. ?download=true serves the export as an attachment with its conventional filename.

Example request

curl https://api.midi.guide/v4/devices/elektron/digitakt-ii/

Example response (truncated)

{
  "metadata": {
    "manufacturer": "Elektron",
    "device": "Digitakt II",
    "manufacturer_slug": "elektron",
    "device_slug": "digitakt-ii",
    "last_updated": "2026-07-06T22:33:39Z",
    "repo_url": "https://github.com/pencilresearch/midi/blob/main/Elektron/Digitakt%20II.csv",
    "triggers_repo_url": "https://github.com/pencilresearch/midi/blob/main/Elektron/Digitakt%20II.triggers.csv",
    "license": "https://github.com/pencilresearch/midi/blob/main/LICENSE",
    "has_ccs": true,
    "has_triggers": true,
    "parameter_count": 276,
    "trigger_count": 17
  },
  "ccs": {
    "Track": [
      {
        "parameter_name": "Track: Mute",
        "parameter_description": null,
        "cc_msb": 94,
        "cc_lsb": null,
        "cc_min_value": 0,
        "cc_max_value": 1,
        "cc_default_value": 0,
        "nrpn_msb": 1,
        "nrpn_lsb": 101,
        "nrpn_min_value": 0,
        "nrpn_max_value": 1,
        "nrpn_default_value": 0,
        "orientation": "0-based",
        "usage": "0: Unmuted; 1: Muted",
        "notes": null
      },
      …
    ],
    …
  },
  "triggers": {
    "General": [
      {
        "sound_name": "Track 1",
        "sound_description": null,
        "midi_channel": "1",
        "note_number_min_value": 0,
        "note_number_max_value": 127,
        "note_number_default_value": null,
        "comments": null,
        "velocity_usage": "1~127: Volume"
      },
      …
    ]
  }
}

Try it live:
/v4/devices/elektron/digitakt-ii/ /v4/devices/elektron/digitakt-ii/?format=oxi /v4/devices/elektron/digitakt-ii/?format=hapax&download=true

GET /v4/dump/ ¶

The whole database

Every device's data in one response. ?format=json (default) is the canonical shape; ?format=oxi returns OXI device objects instead. This is a large response - prefer the per-device endpoints unless you really need everything.

Example request

curl https://api.midi.guide/v4/dump/

Example response (truncated)

{
  "manufacturers": {
    "arturia": {
      "name": "Arturia",
      "slug": "arturia",
      "devices": {
        "microfreak": {
          "metadata": …,
          "ccs": …,
          "triggers": …
        }
      }
    },
    …
  }
}

Try it live:
/v4/dump/

DeviceSummary¶

DevicesIndex¶

ManufacturerIndex¶

Error¶

Device¶

DeviceMetadata¶

Parameter¶

Trigger¶

FormatError¶

Dump¶

DumpManufacturer¶