JSON API Documentation

Metadata

List metadata for all Homebrew/core formulae or Homebrew/cask casks

List the brew info --json --all output for all current Homebrew/homebrew-core formulae or Homebrew/homebrew-cask casks.

GET https://formulae.brew.sh/api/formula.json
GET https://formulae.brew.sh/api/cask.json

Response

[
  ...
  {
    "name": "wget",
    "full_name": "wget",
    "tap": "homebrew/core",
    "oldname": null,
    "oldnames": [],
    "aliases": [],
    "versioned_formulae": [],
    "desc": "Internet file retriever",
    "license": "GPL-3.0-or-later",
    "homepage": "https://www.gnu.org/software/wget/",
    "versions": {
      "stable": "1.21.4",
      "head": "HEAD",
      "bottle": true
    },
    "urls": {
      "stable": {
        "url": "https://ftp.gnu.org/gnu/wget/wget-1.21.4.tar.gz",
        "tag": null,
        "revision": null,
        "checksum": "81542f5cefb8faacc39bbbc6c82ded80e3e4a88505ae72ea51df27525bcde04c"
      },
      "head": {
        "url": "https://git.savannah.gnu.org/git/wget.git",
        "branch": null
      }
    },
    "revision": 0,
    "version_scheme": 0,
    "bottle": {
      "stable": {
        "rebuild": 0,
        "root_url": "https://ghcr.io/v2/homebrew/core",
        "files": {
          "arm64_sonoma": {
            "cellar": "/opt/homebrew/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:47cb2b77bcb48ee8d8b8fb222bcafe0febe11195ac6476402917da03211412d8",
            "sha256": "47cb2b77bcb48ee8d8b8fb222bcafe0febe11195ac6476402917da03211412d8"
          },
          "arm64_ventura": {
            "cellar": "/opt/homebrew/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:c7b3fe54045aa9dc0d4da59adc8776a781766b9d72cf629ea6ac3d0935f2e8de",
            "sha256": "c7b3fe54045aa9dc0d4da59adc8776a781766b9d72cf629ea6ac3d0935f2e8de"
          },
          "arm64_monterey": {
            "cellar": "/opt/homebrew/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:f24fa0ffc6139c1063772ce054602910f6178ae636e32c150c2e6e81a61aa10b",
            "sha256": "f24fa0ffc6139c1063772ce054602910f6178ae636e32c150c2e6e81a61aa10b"
          },
          "arm64_big_sur": {
            "cellar": "/opt/homebrew/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:5d481ab27cab089083c35830f28e9e8c069708c8692e5ab35160b91f0ada90dd",
            "sha256": "5d481ab27cab089083c35830f28e9e8c069708c8692e5ab35160b91f0ada90dd"
          },
          "sonoma": {
            "cellar": "/usr/local/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:3def758612b330624284f14c2617b04caa03f910ee7ee0921553a85f99d541f0",
            "sha256": "3def758612b330624284f14c2617b04caa03f910ee7ee0921553a85f99d541f0"
          },
          "ventura": {
            "cellar": "/usr/local/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:f1d0f59e9cd5863d4d4e29a4f0d7cf1c34da8ab4535d9b9a7b8822dbc4ce5e1b",
            "sha256": "f1d0f59e9cd5863d4d4e29a4f0d7cf1c34da8ab4535d9b9a7b8822dbc4ce5e1b"
          },
          "monterey": {
            "cellar": "/usr/local/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:cf388783b9a7c9f017b3d7f176e8dbf6963f4a96d321a171a14e403b005b1bd4",
            "sha256": "cf388783b9a7c9f017b3d7f176e8dbf6963f4a96d321a171a14e403b005b1bd4"
          },
          "big_sur": {
            "cellar": "/usr/local/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:5d2a224fb078f5b344070188c8b44307b52610f459104b0b08aa62d4e4016716",
            "sha256": "5d2a224fb078f5b344070188c8b44307b52610f459104b0b08aa62d4e4016716"
          },
          "x86_64_linux": {
            "cellar": "/home/linuxbrew/.linuxbrew/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:f73c136ea66bb8c7dfd4c35ef3b247ec588ed622c72ad7b425dc4f7a1922dce9",
            "sha256": "f73c136ea66bb8c7dfd4c35ef3b247ec588ed622c72ad7b425dc4f7a1922dce9"
          }
        }
      }
    },
    "keg_only": false,
    "keg_only_reason": null,
    "options": [],
    "build_dependencies": [
      "pkg-config"
    ],
    "dependencies": [
      "libidn2",
      "openssl@3"
    ],
    "test_dependencies": [],
    "recommended_dependencies": [],
    "optional_dependencies": [],
    "uses_from_macos": [],
    "uses_from_macos_bounds": [],
    "requirements": [],
    "conflicts_with": [],
    "conflicts_with_reasons": [],
    "link_overwrite": [],
    "caveats": null,
    "installed": [
      {
        "version": "1.21.4",
        "used_options": [],
        "built_as_bottle": true,
        "poured_from_bottle": true,
        "time": 1695346511,
        "runtime_dependencies": [
          {
            "full_name": "libunistring",
            "version": "1.1",
            "declared_directly": false
          },
          {
            "full_name": "gettext",
            "version": "0.22.2",
            "declared_directly": false
          },
          {
            "full_name": "libidn2",
            "version": "2.3.4",
            "declared_directly": true
          },
          {
            "full_name": "ca-certificates",
            "version": "2023-08-22",
            "declared_directly": false
          },
          {
            "full_name": "openssl@3",
            "version": "3.1.2",
            "declared_directly": true
          }
        ],
        "installed_as_dependency": false,
        "installed_on_request": true
      }
    ],
    "linked_keg": "1.21.4",
    "pinned": false,
    "outdated": false,
    "deprecated": false,
    "deprecation_date": null,
    "deprecation_reason": null,
    "disabled": false,
    "disable_date": null,
    "disable_reason": null,
    "post_install_defined": false,
    "service": null,
    "tap_git_head": "e2e6826665291cedc326d89186208aa085c9ac2a",
    "ruby_source_path": "Formula/w/wget.rb",
    "ruby_source_checksum": {
      "sha256": "2e6ee904e732f3f40f7459d566d4dc6a6e6c6105ff80721e2afe3cbb21d76fde"
    },
    "head_dependencies": {
      "build_dependencies": [
        "autoconf",
        "automake",
        "xz",
        "pkg-config"
      ],
      "dependencies": [
        "gettext",
        "libidn2",
        "openssl@3"
      ],
      "test_dependencies": [],
      "recommended_dependencies": [],
      "optional_dependencies": [],
      "uses_from_macos": [],
      "uses_from_macos_bounds": []
    },
    "variations": {
      "x86_64_linux": {
        "dependencies": [
          "libidn2",
          "openssl@3",
          "util-linux"
        ],
        "head_dependencies": {
          "build_dependencies": [
            "autoconf",
            "automake",
            "xz",
            "pkg-config"
          ],
          "dependencies": [
            "gettext",
            "libidn2",
            "openssl@3",
            "util-linux"
          ],
          "test_dependencies": [],
          "recommended_dependencies": [],
          "optional_dependencies": [],
          "uses_from_macos": [],
          "uses_from_macos_bounds": []
        }
      }
    }
  },
  ...
]

Get formula metadata for a Homebrew/core formula

Get the brew info --json --formula <formula> output for a single, current Homebrew/homebrew-core formula with extra keys containing analytics data and generation date.

GET https://formulae.brew.sh/api/formula/${FORMULA}.json

Variables

${FORMULA}: the name of the formula, e.g. wget

Response

{
  "name": "wget",
  "full_name": "wget",
  "tap": "homebrew/core",
  "oldname": null,
  "oldnames": [],
  "aliases": [],
  "versioned_formulae": [],
  "desc": "Internet file retriever",
  "license": "GPL-3.0-or-later",
  "homepage": "https://www.gnu.org/software/wget/",
  "versions": {
    "stable": "1.21.4",
    "head": "HEAD",
    "bottle": true
  },
  "urls": {
    "stable": {
      "url": "https://ftp.gnu.org/gnu/wget/wget-1.21.4.tar.gz",
      "tag": null,
      "revision": null,
      "checksum": "81542f5cefb8faacc39bbbc6c82ded80e3e4a88505ae72ea51df27525bcde04c"
    },
    "head": {
      "url": "https://git.savannah.gnu.org/git/wget.git",
      "branch": null
    }
  },
  "revision": 0,
  "version_scheme": 0,
  "bottle": {
    "stable": {
      "rebuild": 0,
      "root_url": "https://ghcr.io/v2/homebrew/core",
      "files": {
        "arm64_sonoma": {
          "cellar": "/opt/homebrew/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:47cb2b77bcb48ee8d8b8fb222bcafe0febe11195ac6476402917da03211412d8",
          "sha256": "47cb2b77bcb48ee8d8b8fb222bcafe0febe11195ac6476402917da03211412d8"
        },
        "arm64_ventura": {
          "cellar": "/opt/homebrew/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:c7b3fe54045aa9dc0d4da59adc8776a781766b9d72cf629ea6ac3d0935f2e8de",
          "sha256": "c7b3fe54045aa9dc0d4da59adc8776a781766b9d72cf629ea6ac3d0935f2e8de"
        },
        "arm64_monterey": {
          "cellar": "/opt/homebrew/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:f24fa0ffc6139c1063772ce054602910f6178ae636e32c150c2e6e81a61aa10b",
          "sha256": "f24fa0ffc6139c1063772ce054602910f6178ae636e32c150c2e6e81a61aa10b"
        },
        "arm64_big_sur": {
          "cellar": "/opt/homebrew/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:5d481ab27cab089083c35830f28e9e8c069708c8692e5ab35160b91f0ada90dd",
          "sha256": "5d481ab27cab089083c35830f28e9e8c069708c8692e5ab35160b91f0ada90dd"
        },
        "sonoma": {
          "cellar": "/usr/local/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:3def758612b330624284f14c2617b04caa03f910ee7ee0921553a85f99d541f0",
          "sha256": "3def758612b330624284f14c2617b04caa03f910ee7ee0921553a85f99d541f0"
        },
        "ventura": {
          "cellar": "/usr/local/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:f1d0f59e9cd5863d4d4e29a4f0d7cf1c34da8ab4535d9b9a7b8822dbc4ce5e1b",
          "sha256": "f1d0f59e9cd5863d4d4e29a4f0d7cf1c34da8ab4535d9b9a7b8822dbc4ce5e1b"
        },
        "monterey": {
          "cellar": "/usr/local/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:cf388783b9a7c9f017b3d7f176e8dbf6963f4a96d321a171a14e403b005b1bd4",
          "sha256": "cf388783b9a7c9f017b3d7f176e8dbf6963f4a96d321a171a14e403b005b1bd4"
        },
        "big_sur": {
          "cellar": "/usr/local/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:5d2a224fb078f5b344070188c8b44307b52610f459104b0b08aa62d4e4016716",
          "sha256": "5d2a224fb078f5b344070188c8b44307b52610f459104b0b08aa62d4e4016716"
        },
        "x86_64_linux": {
          "cellar": "/home/linuxbrew/.linuxbrew/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:f73c136ea66bb8c7dfd4c35ef3b247ec588ed622c72ad7b425dc4f7a1922dce9",
          "sha256": "f73c136ea66bb8c7dfd4c35ef3b247ec588ed622c72ad7b425dc4f7a1922dce9"
        }
      }
    }
  },
  "keg_only": false,
  "keg_only_reason": null,
  "options": [],
  "build_dependencies": [
    "pkg-config"
  ],
  "dependencies": [
    "libidn2",
    "openssl@3"
  ],
  "test_dependencies": [],
  "recommended_dependencies": [],
  "optional_dependencies": [],
  "uses_from_macos": [],
  "uses_from_macos_bounds": [],
  "requirements": [],
  "conflicts_with": [],
  "conflicts_with_reasons": [],
  "link_overwrite": [],
  "caveats": null,
  "installed": [
    {
      "version": "1.21.4",
      "used_options": [],
      "built_as_bottle": true,
      "poured_from_bottle": true,
      "time": 1695346511,
      "runtime_dependencies": [
        {
          "full_name": "libunistring",
          "version": "1.1",
          "declared_directly": false
        },
        {
          "full_name": "gettext",
          "version": "0.22.2",
          "declared_directly": false
        },
        {
          "full_name": "libidn2",
          "version": "2.3.4",
          "declared_directly": true
        },
        {
          "full_name": "ca-certificates",
          "version": "2023-08-22",
          "declared_directly": false
        },
        {
          "full_name": "openssl@3",
          "version": "3.1.2",
          "declared_directly": true
        }
      ],
      "installed_as_dependency": false,
      "installed_on_request": true
    }
  ],
  "linked_keg": "1.21.4",
  "pinned": false,
  "outdated": false,
  "deprecated": false,
  "deprecation_date": null,
  "deprecation_reason": null,
  "disabled": false,
  "disable_date": null,
  "disable_reason": null,
  "post_install_defined": false,
  "service": null,
  "tap_git_head": "e2e6826665291cedc326d89186208aa085c9ac2a",
  "ruby_source_path": "Formula/w/wget.rb",
  "ruby_source_checksum": {
    "sha256": "2e6ee904e732f3f40f7459d566d4dc6a6e6c6105ff80721e2afe3cbb21d76fde"
  },
  "head_dependencies": {
    "build_dependencies": [
      "autoconf",
      "automake",
      "xz",
      "pkg-config"
    ],
    "dependencies": [
      "gettext",
      "libidn2",
      "openssl@3"
    ],
    "test_dependencies": [],
    "recommended_dependencies": [],
    "optional_dependencies": [],
    "uses_from_macos": [],
    "uses_from_macos_bounds": []
  },
  "variations": {
    "x86_64_linux": {
      "dependencies": [
        "libidn2",
        "openssl@3",
        "util-linux"
      ],
      "head_dependencies": {
        "build_dependencies": [
          "autoconf",
          "automake",
          "xz",
          "pkg-config"
        ],
        "dependencies": [
          "gettext",
          "libidn2",
          "openssl@3",
          "util-linux"
        ],
        "test_dependencies": [],
        "recommended_dependencies": [],
        "optional_dependencies": [],
        "uses_from_macos": [],
        "uses_from_macos_bounds": []
      }
    }
  },
  "analytics": {
    "install": {
      "30d": {
        "wget": 66716
      },
      "90d": {
        "wget": 207166
      },
      "365d": {
        "wget": 550638
      }
    },
    "install_on_request": {
      "30d": {
        "wget": 66596
      },
      "90d": {
        "wget": 206824
      },
      "365d": {
        "wget": 549567
      }
    },
    "build_error": {
      "30d": {
        "wget": 16
      }
    }
  },
  "generated_date": "2023-09-28"
}

Get cask metadata for a Homebrew/cask cask

Get the brew info --json=v2 --cask <cask> JSON output for a single, current Homebrew/homebrew-cask cask with extra keys containing analytics data and generation date.

GET https://formulae.brew.sh/api/cask/${CASK}.json

Variables

${CASK}: the name of the cask, e.g. docker

Response

{
  "token": "docker",
  "full_token": "docker",
  "old_tokens": [],
  "tap": "homebrew/cask",
  "name": [
    "Docker Desktop",
    "Docker Community Edition",
    "Docker CE"
  ],
  "desc": "App to build and share containerized applications and microservices",
  "homepage": "https://www.docker.com/products/docker-desktop",
  "url": "https://desktop.docker.com/mac/main/amd64/120376/Docker.dmg",
  "url_specs": {},
  "appcast": null,
  "version": "4.23.0,120376",
  "installed": null,
  "outdated": false,
  "sha256": "30bf23633840a5d129c7e125f940f41336176ea0235c7592ab9b5b3f775d5b3e",
  "artifacts": [
    {
      "uninstall": [
        {
          "delete": [
            "/Library/PrivilegedHelperTools/com.docker.socket",
            "/Library/PrivilegedHelperTools/com.docker.vmnetd"
          ],
          "rmdir": "~/.docker/bin",
          "launchctl": [
            "com.docker.helper",
            "com.docker.socket",
            "com.docker.vmnetd"
          ],
          "quit": "com.docker.docker"
        }
      ]
    },
    {
      "app": [
        "Docker.app"
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/docker",
        {
          "target": "/usr/local/bin/docker"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/docker-compose",
        {
          "target": "/usr/local/bin/docker-compose"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/docker-credential-desktop",
        {
          "target": "/usr/local/bin/docker-credential-desktop"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/docker-credential-ecr-login",
        {
          "target": "/usr/local/bin/docker-credential-ecr-login"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/docker-credential-osxkeychain",
        {
          "target": "/usr/local/bin/docker-credential-osxkeychain"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/docker-index",
        {
          "target": "/usr/local/bin/docker-index"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/hub-tool",
        {
          "target": "/usr/local/bin/hub-tool"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/com.docker.vpnkit",
        {
          "target": "/usr/local/bin/vpnkit"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/etc/docker.bash-completion",
        {
          "target": "$HOMEBREW_PREFIX/etc/bash_completion.d/docker"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/etc/docker.zsh-completion",
        {
          "target": "$HOMEBREW_PREFIX/share/zsh/site-functions/_docker"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/etc/docker.fish-completion",
        {
          "target": "$HOMEBREW_PREFIX/share/fish/vendor_completions.d/docker.fish"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/kubectl",
        {
          "target": "/usr/local/bin/kubectl.docker"
        }
      ]
    },
    {
      "binary": [
        "Docker.app/Contents/Resources/bin/com.docker.cli",
        {
          "target": "/usr/local/bin/com.docker.cli"
        }
      ]
    },
    {
      "uninstall_postflight": null
    },
    {
      "postflight": null
    },
    {
      "zap": [
        {
          "trash": [
            "/usr/local/bin/docker-compose.backup",
            "/usr/local/bin/docker.backup",
            "~/.docker",
            "~/Library/Application Scripts/com.docker.helper",
            "~/Library/Application Scripts/group.com.docker",
            "~/Library/Application Support/com.bugsnag.Bugsnag/com.docker.docker",
            "~/Library/Application Support/Docker Desktop",
            "~/Library/Caches/com.docker.docker",
            "~/Library/Caches/com.plausiblelabs.crashreporter.data/com.docker.docker",
            "~/Library/Caches/KSCrashReports/Docker",
            "~/Library/Containers/com.docker.docker",
            "~/Library/Containers/com.docker.helper",
            "~/Library/Group Containers/group.com.docker",
            "~/Library/HTTPStorages/com.docker.docker",
            "~/Library/HTTPStorages/com.docker.docker.binarycookies",
            "~/Library/Logs/Docker Desktop",
            "~/Library/Preferences/com.docker.docker.plist",
            "~/Library/Preferences/com.electron.docker-frontend.plist",
            "~/Library/Preferences/com.electron.dockerdesktop.plist",
            "~/Library/Saved Application State/com.electron.docker-frontend.savedState",
            "~/Library/Saved Application State/com.electron.dockerdesktop.savedState"
          ],
          "rmdir": [
            "~/Library/Caches/com.plausiblelabs.crashreporter.data",
            "~/Library/Caches/KSCrashReports"
          ]
        }
      ]
    }
  ],
  "caveats": null,
  "depends_on": {
    "macos": {
      ">=": [
        "11"
      ]
    }
  },
  "conflicts_with": {
    "formula": [
      "docker",
      "docker-completion",
      "docker-compose",
      "docker-compose-completion",
      "docker-credential-helper-ecr"
    ]
  },
  "container": null,
  "auto_updates": true,
  "tap_git_head": "2dd9902a7e59acce5f7d4e9b9ee483117d7508de",
  "languages": [],
  "ruby_source_path": "Casks/d/docker.rb",
  "ruby_source_checksum": {
    "sha256": "de76d4233693ad6f2697226789e8655bd76f5d14603a5efdec4e5abd10889fc8"
  },
  "variations": {
    "arm64_sonoma": {
      "url": "https://desktop.docker.com/mac/main/arm64/120376/Docker.dmg",
      "sha256": "88813e65928d86d2ad301e51619109aeb3f46f6e135b355000c8854ac4737cca"
    },
    "arm64_ventura": {
      "url": "https://desktop.docker.com/mac/main/arm64/120376/Docker.dmg",
      "sha256": "88813e65928d86d2ad301e51619109aeb3f46f6e135b355000c8854ac4737cca"
    },
    "arm64_monterey": {
      "url": "https://desktop.docker.com/mac/main/arm64/120376/Docker.dmg",
      "sha256": "88813e65928d86d2ad301e51619109aeb3f46f6e135b355000c8854ac4737cca"
    },
    "arm64_big_sur": {
      "url": "https://desktop.docker.com/mac/main/arm64/120376/Docker.dmg",
      "sha256": "88813e65928d86d2ad301e51619109aeb3f46f6e135b355000c8854ac4737cca"
    },
    "catalina": {
      "url": "https://desktop.docker.com/mac/main/amd64/93002/Docker.dmg",
      "version": "4.15.0,93002",
      "sha256": "bee41d646916e579b16b7fae014e2fb5e5e7b5dbaf7c1949821fd311d3ce430b",
      "depends_on": {
        "macos": {
          ">=": [
            "10.15"
          ]
        }
      }
    },
    "mojave": {
      "url": "https://desktop.docker.com/mac/main/amd64/93002/Docker.dmg",
      "version": "4.15.0,93002",
      "sha256": "bee41d646916e579b16b7fae014e2fb5e5e7b5dbaf7c1949821fd311d3ce430b",
      "depends_on": {
        "macos": {
          ">=": [
            "10.15"
          ]
        }
      }
    },
    "high_sierra": {
      "url": "https://desktop.docker.com/mac/main/amd64/93002/Docker.dmg",
      "version": "4.15.0,93002",
      "sha256": "bee41d646916e579b16b7fae014e2fb5e5e7b5dbaf7c1949821fd311d3ce430b",
      "depends_on": {
        "macos": {
          ">=": [
            "10.15"
          ]
        }
      }
    },
    "sierra": {
      "url": "https://desktop.docker.com/mac/main/amd64/93002/Docker.dmg",
      "version": "4.15.0,93002",
      "sha256": "bee41d646916e579b16b7fae014e2fb5e5e7b5dbaf7c1949821fd311d3ce430b",
      "depends_on": {
        "macos": {
          ">=": [
            "10.15"
          ]
        }
      }
    },
    "el_capitan": {
      "url": "https://desktop.docker.com/mac/main/amd64/93002/Docker.dmg",
      "version": "4.15.0,93002",
      "sha256": "bee41d646916e579b16b7fae014e2fb5e5e7b5dbaf7c1949821fd311d3ce430b",
      "depends_on": {
        "macos": {
          ">=": [
            "10.15"
          ]
        }
      }
    }
  },
  "analytics": {
    "install": {
      "30d": {
        "docker": 18631
      },
      "90d": {
        "docker": 49622
      },
      "365d": {
        "docker": 123410
      }
    }
  },
  "generated_date": "2023-09-28"
}

Analytics

List one category of analytics events

List all analytics events for a specified category over a number of days, ordered by event frequency count. This is the data source for brew info --analytics.

GET https://formulae.brew.sh/api/analytics/${CATEGORY}/${DAYS}.json

Variables

${CATEGORY}: the analytics event category, i.e.
- install: the installation of all formulae
- install-on-request: the requested installation of all formulae (i.e. not as a dependency of other formulae)
- build-error: the installation failure of all formulae
${DAYS}: the number of days of analytics events, i.e.
- 30d: 30 days
- 90d: 90 days
- 365d: 365 days

Response

{
  "category": "formula_install",
  "total_items": 19250,
  "start_date": "2023-08-29",
  "end_date": "2023-09-28",
  "total_count": 17570736,
  "items": [
    ...
    {
      "number": 56,
      "formula": "wget",
      "count": "66,890",
      "percent": "0.38"
    },
    ...
  ]
}

List analytics events for all Homebrew/core formulae

List all the Homebrew/homebrew-core formulae’s analytics events for a specified category over a number of days, grouped by formula name. This is the data source for brew info --analytics --formula <formula>.

GET https://formulae.brew.sh/api/analytics/${CATEGORY}/homebrew-core/${DAYS}.json

Variables

${CATEGORY}: the analytics event category, i.e.
- install: the installation of all core formulae
- install-on-request: the requested installation of all core formulae (i.e. not as a dependency of other formulae)
- build-error: the installation failure of all core formulae
  - only ${DAYS}: 30d (30 days) is available
${DAYS}: the number of days of analytics events, i.e.
- 30d: 30 days
- 90d: 90 days
- 365d: 365 days

Response

{
  "category": "formula_install",
  "total_items": 11984,
  "start_date": "2023-08-29",
  "end_date": "2023-09-28",
  "total_count": 17124644,
  "formulae": {
    ...
    "wget": [
      {
        "formula": "wget",
        "count": "66,716"
      },
      ...
    ],
    ...
  }
}

List analytics events for all Homebrew/cask casks

List all the Homebrew/homebrew-cask cask’s analytics events for the cask-install category over a number of days, grouped by cask token. This is the data source for brew info --analytics --cask <cask>.

GET https://formulae.brew.sh/api/analytics/cask-install/homebrew-cask/${DAYS}.json

Variables

${DAYS}: the number of days of analytics events, i.e.
- 30d: 30 days
- 90d: 90 days
- 365d: 365 days

Response

{
  "category": "cask_install",
  "total_items": 5753,
  "start_date": "2023-08-29",
  "end_date": "2023-09-28",
  "total_count": 938863,
  "formulae": {
    ...
    "docker": [
      {
        "cask": "docker",
        "count": "18,631"
      }
    ],
    "docker-toolbox": [
      {
        "cask": "docker-toolbox",
        "count": "122"
      }
    ],
    ...
  }
}

Homebrew Formulae

JSON API Documentation

Metadata

List metadata for all Homebrew/core formulae or Homebrew/cask casks

Response

Get formula metadata for a Homebrew/core formula

Variables

Response

Get cask metadata for a Homebrew/cask cask

Variables

Response

Analytics

List one category of analytics events

Variables

Response

List analytics events for all Homebrew/core formulae

Variables

Response

List analytics events for all Homebrew/cask casks

Variables

Response