JSON API Documentation

Metadata

List formulae metadata for all core or cask formulae

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

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,
    "aliases": [],
    "versioned_formulae": [],
    "desc": "Internet file retriever",
    "license": "GPL-3.0-or-later",
    "homepage": "https://www.gnu.org/software/wget/",
    "versions": {
      "stable": "1.21.3",
      "head": "HEAD",
      "bottle": true
    },
    "urls": {
      "stable": {
        "url": "https://ftp.gnu.org/gnu/wget/wget-1.21.3.tar.gz",
        "tag": null,
        "revision": null,
        "checksum": "5726bb8bc5ca0f6dc7110f6416e4bb7019e2d2ff5bf93d1ca2ffcc6656f220e5"
      }
    },
    "revision": 0,
    "version_scheme": 0,
    "bottle": {
      "stable": {
        "rebuild": 0,
        "root_url": "https://ghcr.io/v2/homebrew/core",
        "files": {
          "arm64_ventura": {
            "cellar": "/opt/homebrew/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:fb2b2297226438cf2e9af9f1cf94f450730fc515eace8e21dd2db03700e77629",
            "sha256": "fb2b2297226438cf2e9af9f1cf94f450730fc515eace8e21dd2db03700e77629"
          },
          "arm64_monterey": {
            "cellar": "/opt/homebrew/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:fc83eec77acee50d2d7ce3bb0cca08d80acccc148e909921de42e57dd5fc7f3d",
            "sha256": "fc83eec77acee50d2d7ce3bb0cca08d80acccc148e909921de42e57dd5fc7f3d"
          },
          "arm64_big_sur": {
            "cellar": "/opt/homebrew/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:a0c491ae7de2b722320efa94704567e36f3a0bd04bd946b1431ecbd1bcbfb899",
            "sha256": "a0c491ae7de2b722320efa94704567e36f3a0bd04bd946b1431ecbd1bcbfb899"
          },
          "ventura": {
            "cellar": "/usr/local/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:e7c2473d1ad12f24fcfa2a2de2eea915e478f5b0204c153daa00b7d3f440b7ab",
            "sha256": "e7c2473d1ad12f24fcfa2a2de2eea915e478f5b0204c153daa00b7d3f440b7ab"
          },
          "monterey": {
            "cellar": "/usr/local/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:aa706c58ae7e97abf91be56e785335aff058c431f9973dffac06aacbea558497",
            "sha256": "aa706c58ae7e97abf91be56e785335aff058c431f9973dffac06aacbea558497"
          },
          "big_sur": {
            "cellar": "/usr/local/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:b90e0d7a4319ccdb18ee0c2ed097e9cddeeceaaf70dc0a785d96b4ba69dbeb54",
            "sha256": "b90e0d7a4319ccdb18ee0c2ed097e9cddeeceaaf70dc0a785d96b4ba69dbeb54"
          },
          "catalina": {
            "cellar": "/usr/local/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:2aadef5aae81ecdd7e28bc9a776adcf0eaa393edae904e0c69740a442b7a3e69",
            "sha256": "2aadef5aae81ecdd7e28bc9a776adcf0eaa393edae904e0c69740a442b7a3e69"
          },
          "x86_64_linux": {
            "cellar": "/home/linuxbrew/.linuxbrew/Cellar",
            "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:b6f20b1f4da03b9ee6a42f9305ee015eae7f80afea198e405c0b775eb2333de1",
            "sha256": "b6f20b1f4da03b9ee6a42f9305ee015eae7f80afea198e405c0b775eb2333de1"
          }
        }
      }
    },
    "keg_only": false,
    "keg_only_reason": null,
    "options": [],
    "build_dependencies": [
      "pkg-config"
    ],
    "dependencies": [
      "libidn2",
      "openssl@1.1"
    ],
    "test_dependencies": [],
    "recommended_dependencies": [],
    "optional_dependencies": [],
    "uses_from_macos": [],
    "requirements": [],
    "conflicts_with": [],
    "caveats": null,
    "installed": [
      {
        "version": "1.21.3",
        "used_options": [],
        "built_as_bottle": true,
        "poured_from_bottle": true,
        "time": 1669576062,
        "runtime_dependencies": [
          {
            "full_name": "gettext",
            "version": "0.21.1",
            "declared_directly": false
          },
          {
            "full_name": "libunistring",
            "version": "1.0",
            "declared_directly": false
          },
          {
            "full_name": "libidn2",
            "version": "2.3.4",
            "declared_directly": true
          },
          {
            "full_name": "ca-certificates",
            "version": "2022-10-11",
            "declared_directly": false
          },
          {
            "full_name": "openssl@1.1",
            "version": "1.1.1s",
            "declared_directly": true
          }
        ],
        "installed_as_dependency": false,
        "installed_on_request": true
      }
    ],
    "linked_keg": "1.21.3",
    "pinned": false,
    "outdated": false,
    "deprecated": false,
    "deprecation_date": null,
    "deprecation_reason": null,
    "disabled": false,
    "disable_date": null,
    "disable_reason": null,
    "variations": {
      "x86_64_linux": {
        "dependencies": [
          "libidn2",
          "openssl@1.1",
          "util-linux"
        ]
      }
    }
  },
  ...
]

List the latest versions for all core or cask formulae

List the latest version information for each formula or cask in the given tap. The result is a single JSON object with formula/cask names as keys. The values are JSON objects containing version and, for formulae, revision keys.

GET https://formulae.brew.sh/api/versions-formulae.json
GET https://formulae.brew.sh/api/versions-casks.json

Formulae Response

{
  ...
  "wget": {
    "version": "1.21.3",
    "revision": 0
  },
  ...
  "zsh": {
    "version": "5.9",
    "revision": 0
  },
  ...
}

Casks Response

{
  ...
  "docker": {
    "version": "4.15.0,93002",
    "versions": {}
  },
  ...
  "onyx": {
    "version": "4.2.6",
    "versions": {
      "ventura": "4.3.2",
      "big_sur": "4.0.2",
      "catalina": "3.8.7",
      "mojave": "3.6.8",
      "high_sierra": "3.4.9",
      "sierra": "3.3.1",
      "el_capitan": "3.1.9"
    }
  },
  ...
}

Get formula metadata for a 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

Response

{
  "name": "wget",
  "full_name": "wget",
  "tap": "homebrew/core",
  "oldname": null,
  "aliases": [],
  "versioned_formulae": [],
  "desc": "Internet file retriever",
  "license": "GPL-3.0-or-later",
  "homepage": "https://www.gnu.org/software/wget/",
  "versions": {
    "stable": "1.21.3",
    "head": "HEAD",
    "bottle": true
  },
  "urls": {
    "stable": {
      "url": "https://ftp.gnu.org/gnu/wget/wget-1.21.3.tar.gz",
      "tag": null,
      "revision": null,
      "checksum": "5726bb8bc5ca0f6dc7110f6416e4bb7019e2d2ff5bf93d1ca2ffcc6656f220e5"
    }
  },
  "revision": 0,
  "version_scheme": 0,
  "bottle": {
    "stable": {
      "rebuild": 0,
      "root_url": "https://ghcr.io/v2/homebrew/core",
      "files": {
        "arm64_ventura": {
          "cellar": "/opt/homebrew/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:fb2b2297226438cf2e9af9f1cf94f450730fc515eace8e21dd2db03700e77629",
          "sha256": "fb2b2297226438cf2e9af9f1cf94f450730fc515eace8e21dd2db03700e77629"
        },
        "arm64_monterey": {
          "cellar": "/opt/homebrew/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:fc83eec77acee50d2d7ce3bb0cca08d80acccc148e909921de42e57dd5fc7f3d",
          "sha256": "fc83eec77acee50d2d7ce3bb0cca08d80acccc148e909921de42e57dd5fc7f3d"
        },
        "arm64_big_sur": {
          "cellar": "/opt/homebrew/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:a0c491ae7de2b722320efa94704567e36f3a0bd04bd946b1431ecbd1bcbfb899",
          "sha256": "a0c491ae7de2b722320efa94704567e36f3a0bd04bd946b1431ecbd1bcbfb899"
        },
        "ventura": {
          "cellar": "/usr/local/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:e7c2473d1ad12f24fcfa2a2de2eea915e478f5b0204c153daa00b7d3f440b7ab",
          "sha256": "e7c2473d1ad12f24fcfa2a2de2eea915e478f5b0204c153daa00b7d3f440b7ab"
        },
        "monterey": {
          "cellar": "/usr/local/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:aa706c58ae7e97abf91be56e785335aff058c431f9973dffac06aacbea558497",
          "sha256": "aa706c58ae7e97abf91be56e785335aff058c431f9973dffac06aacbea558497"
        },
        "big_sur": {
          "cellar": "/usr/local/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:b90e0d7a4319ccdb18ee0c2ed097e9cddeeceaaf70dc0a785d96b4ba69dbeb54",
          "sha256": "b90e0d7a4319ccdb18ee0c2ed097e9cddeeceaaf70dc0a785d96b4ba69dbeb54"
        },
        "catalina": {
          "cellar": "/usr/local/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:2aadef5aae81ecdd7e28bc9a776adcf0eaa393edae904e0c69740a442b7a3e69",
          "sha256": "2aadef5aae81ecdd7e28bc9a776adcf0eaa393edae904e0c69740a442b7a3e69"
        },
        "x86_64_linux": {
          "cellar": "/home/linuxbrew/.linuxbrew/Cellar",
          "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:b6f20b1f4da03b9ee6a42f9305ee015eae7f80afea198e405c0b775eb2333de1",
          "sha256": "b6f20b1f4da03b9ee6a42f9305ee015eae7f80afea198e405c0b775eb2333de1"
        }
      }
    }
  },
  "keg_only": false,
  "keg_only_reason": null,
  "options": [],
  "build_dependencies": [
    "pkg-config"
  ],
  "dependencies": [
    "libidn2",
    "openssl@1.1"
  ],
  "test_dependencies": [],
  "recommended_dependencies": [],
  "optional_dependencies": [],
  "uses_from_macos": [],
  "requirements": [],
  "conflicts_with": [],
  "caveats": null,
  "installed": [
    {
      "version": "1.21.3",
      "used_options": [],
      "built_as_bottle": true,
      "poured_from_bottle": true,
      "time": 1669576062,
      "runtime_dependencies": [
        {
          "full_name": "gettext",
          "version": "0.21.1",
          "declared_directly": false
        },
        {
          "full_name": "libunistring",
          "version": "1.0",
          "declared_directly": false
        },
        {
          "full_name": "libidn2",
          "version": "2.3.4",
          "declared_directly": true
        },
        {
          "full_name": "ca-certificates",
          "version": "2022-10-11",
          "declared_directly": false
        },
        {
          "full_name": "openssl@1.1",
          "version": "1.1.1s",
          "declared_directly": true
        }
      ],
      "installed_as_dependency": false,
      "installed_on_request": true
    }
  ],
  "linked_keg": "1.21.3",
  "pinned": false,
  "outdated": false,
  "deprecated": false,
  "deprecation_date": null,
  "deprecation_reason": null,
  "disabled": false,
  "disable_date": null,
  "disable_reason": null,
  "variations": {
    "x86_64_linux": {
      "dependencies": [
        "libidn2",
        "openssl@1.1",
        "util-linux"
      ]
    }
  },
  "analytics": {
    "install": {
      "30d": {
        "wget": 103518,
        "wget --HEAD": 2
      },
      "90d": {
        "wget": 324631,
        "wget --HEAD": 10
      },
      "365d": {
        "wget": 1529435,
        "wget --HEAD": 50
      }
    },
    "install_on_request": {
      "30d": {
        "wget": 103167,
        "wget --HEAD": 2
      },
      "90d": {
        "wget": 323151,
        "wget --HEAD": 10
      },
      "365d": {
        "wget": 1521484,
        "wget --HEAD": 50
      }
    },
    "build_error": {
      "30d": {
        "wget": 13,
        "wget --HEAD": 1
      }
    }
  },
  "analytics-linux": {
    "install": {
      "30d": {
        "wget": 1116
      },
      "90d": {
        "wget": 3682
      },
      "365d": {
        "wget": 13861,
        "wget --HEAD": 2
      }
    },
    "install_on_request": {
      "30d": {
        "wget": 1053
      },
      "90d": {
        "wget": 3503
      },
      "365d": {
        "wget": 13491,
        "wget --HEAD": 2
      }
    },
    "build_error": {
      "30d": {
        "wget": 0
      }
    }
  },
  "generated_date": "2022-12-04"
}

Get bottle metadata for a core formula

Get the brew info --json --bottle --formula <formula> output for a single, current Homebrew/homebrew-core formula.

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

Variables

Response

{
  "name": "wget",
  "pkg_version": "1.21.3",
  "rebuild": 0,
  "bottles": {
    "arm64_ventura": {
      "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:fb2b2297226438cf2e9af9f1cf94f450730fc515eace8e21dd2db03700e77629"
    },
    "arm64_monterey": {
      "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:fc83eec77acee50d2d7ce3bb0cca08d80acccc148e909921de42e57dd5fc7f3d"
    },
    "arm64_big_sur": {
      "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:a0c491ae7de2b722320efa94704567e36f3a0bd04bd946b1431ecbd1bcbfb899"
    },
    "ventura": {
      "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:e7c2473d1ad12f24fcfa2a2de2eea915e478f5b0204c153daa00b7d3f440b7ab"
    },
    "monterey": {
      "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:aa706c58ae7e97abf91be56e785335aff058c431f9973dffac06aacbea558497"
    },
    "big_sur": {
      "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:b90e0d7a4319ccdb18ee0c2ed097e9cddeeceaaf70dc0a785d96b4ba69dbeb54"
    },
    "catalina": {
      "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:2aadef5aae81ecdd7e28bc9a776adcf0eaa393edae904e0c69740a442b7a3e69"
    },
    "x86_64_linux": {
      "url": "https://ghcr.io/v2/homebrew/core/wget/blobs/sha256:b6f20b1f4da03b9ee6a42f9305ee015eae7f80afea198e405c0b775eb2333de1"
    }
  },
  "dependencies": [
    {
      "name": "gettext",
      "pkg_version": "0.21.1",
      "rebuild": 0,
      "bottles": {
        "arm64_ventura": {
          "url": "https://ghcr.io/v2/homebrew/core/gettext/blobs/sha256:28c5b06e66800aa2d460336d001379e35e664310d12638de35a1b0f2b9a44913"
        },
        "arm64_monterey": {
          "url": "https://ghcr.io/v2/homebrew/core/gettext/blobs/sha256:356b52e24b883af3ef092d13b6727b76e0137154c2c9eb42fe7c272bb7d3edec"
        },
        "arm64_big_sur": {
          "url": "https://ghcr.io/v2/homebrew/core/gettext/blobs/sha256:90da957f7b8ad3d47fff7045a684060168e0433631921463fbbff09b5dc4b772"
        },
        "ventura": {
          "url": "https://ghcr.io/v2/homebrew/core/gettext/blobs/sha256:fd7e48065cf73e37dfdf4c5cb789a14b93cf58ac06060814a60c94b87d8f26e6"
        },
        "monterey": {
          "url": "https://ghcr.io/v2/homebrew/core/gettext/blobs/sha256:9318777367eae475e9ea226d2bcbd19ef8281d1dd2af3a92c20c00246677145b"
        },
        "big_sur": {
          "url": "https://ghcr.io/v2/homebrew/core/gettext/blobs/sha256:95086fa8b1b6a913ca7ef3a7c7c49e147823c26ba239003f9140cfe1252587ba"
        },
        "catalina": {
          "url": "https://ghcr.io/v2/homebrew/core/gettext/blobs/sha256:aba2b94f406a9d8784bb08f9763440297c645a7ea99f4c4dbfeccb325053322a"
        },
        "x86_64_linux": {
          "url": "https://ghcr.io/v2/homebrew/core/gettext/blobs/sha256:991579fa170ca491fd6332844b570095978961a9764e57f00180002d471cf3b8"
        }
      }
    },
    {
      "name": "libunistring",
      "pkg_version": "1.0",
      "rebuild": 0,
      "bottles": {
        "arm64_ventura": {
          "url": "https://ghcr.io/v2/homebrew/core/libunistring/blobs/sha256:25cdc9367877f369283d003e0d092c7fb8fef6f0b973a9571e1d2a8d097920f2"
        },
        "arm64_monterey": {
          "url": "https://ghcr.io/v2/homebrew/core/libunistring/blobs/sha256:b8b2f6fe30eefd002bf0dbb5fc0e5c6dc0d5f9b9219f4d6fcddc48e3bc229b23"
        },
        "arm64_big_sur": {
          "url": "https://ghcr.io/v2/homebrew/core/libunistring/blobs/sha256:df13d54b58c8c86c0e609f7343677175eae0a58ba0cceabbceb08023d23021c3"
        },
        "ventura": {
          "url": "https://ghcr.io/v2/homebrew/core/libunistring/blobs/sha256:09262440edd6c32576dae1d6aad94900ce6559df0ef3cff3de232d75b2ddbdcf"
        },
        "monterey": {
          "url": "https://ghcr.io/v2/homebrew/core/libunistring/blobs/sha256:18a1691229db1dbc9c716236df52f447aa9949121c36ae65b4d6fdf284d260c6"
        },
        "big_sur": {
          "url": "https://ghcr.io/v2/homebrew/core/libunistring/blobs/sha256:50c3003f7db296810b0fbebdb86d94edd88f56195c48327f615d6ef52608628e"
        },
        "catalina": {
          "url": "https://ghcr.io/v2/homebrew/core/libunistring/blobs/sha256:3b5bb302d087ae03b3a87b0d722a3db1a66dc83ff45f77e624a62590c3d0c95d"
        },
        "x86_64_linux": {
          "url": "https://ghcr.io/v2/homebrew/core/libunistring/blobs/sha256:b1d76e62d1bafe89c7535ca21aad48fe99370b5353d0c4efeafe564db367401d"
        }
      }
    },
    {
      "name": "libidn2",
      "pkg_version": "2.3.4",
      "rebuild": 0,
      "bottles": {
        "arm64_ventura": {
          "url": "https://ghcr.io/v2/homebrew/core/libidn2/blobs/sha256:733adfd62ece847bb7f36e57434c58582020cd7c572a2b37b6113811108ac1c1"
        },
        "arm64_monterey": {
          "url": "https://ghcr.io/v2/homebrew/core/libidn2/blobs/sha256:38eed5a97aaddeebf0c510ed609466c2c0d1fdc996452e380a4ed9366000fe5e"
        },
        "arm64_big_sur": {
          "url": "https://ghcr.io/v2/homebrew/core/libidn2/blobs/sha256:3b7b3d218a6b04a8264174da41af73e638fc75a7dcbb4f41150f2f37166d5cb9"
        },
        "ventura": {
          "url": "https://ghcr.io/v2/homebrew/core/libidn2/blobs/sha256:3561d710120deb93c7b30c1c3a9639e9649e41fc7360b25ce6a8bc53424a43da"
        },
        "monterey": {
          "url": "https://ghcr.io/v2/homebrew/core/libidn2/blobs/sha256:335207a9dc5fdab95f75b5639108c66e57d9b3fe0c632a829e05947d8e0b31ff"
        },
        "big_sur": {
          "url": "https://ghcr.io/v2/homebrew/core/libidn2/blobs/sha256:d2db4a1e16ed4293bb44a0aca0166e9a4eda64f219d655c0aa56a1014398e0ff"
        },
        "catalina": {
          "url": "https://ghcr.io/v2/homebrew/core/libidn2/blobs/sha256:9cf7ddcc4469e80d0a81bc95312e2481bdddb2b5fdd9f1a20ca8b0b37eb38af3"
        },
        "x86_64_linux": {
          "url": "https://ghcr.io/v2/homebrew/core/libidn2/blobs/sha256:e95765dc4efb32e9b9d24f3b02624d40f9c6f2753a091296900f107ada06f106"
        }
      }
    },
    {
      "name": "ca-certificates",
      "pkg_version": "2022-10-11",
      "rebuild": 0,
      "bottles": {
        "all": {
          "url": "https://ghcr.io/v2/homebrew/core/ca-certificates/blobs/sha256:1b264e579e31b3041a87ff91f09d5f7cc0d51fea1c83e63aee17a1b95509cbe1"
        }
      }
    },
    {
      "name": "openssl@1.1",
      "pkg_version": "1.1.1s",
      "rebuild": 0,
      "bottles": {
        "arm64_ventura": {
          "url": "https://ghcr.io/v2/homebrew/core/openssl/1.1/blobs/sha256:3a7812321f40490623859b1c31644c6f3ba1b76c1ca7f780b9413b912e1b1415"
        },
        "arm64_monterey": {
          "url": "https://ghcr.io/v2/homebrew/core/openssl/1.1/blobs/sha256:c11b17c8b78efa46dac2d213cd7a7b3fff75f6f5e6d2ef2248345cd4a900b1c6"
        },
        "arm64_big_sur": {
          "url": "https://ghcr.io/v2/homebrew/core/openssl/1.1/blobs/sha256:0d75960c118c72e38800212985d5eb3bec31510c3b65c5f5c0e9cf1e33a0cdc8"
        },
        "ventura": {
          "url": "https://ghcr.io/v2/homebrew/core/openssl/1.1/blobs/sha256:096c5678f17ded6e9e80b9d9d9352c5c398263bac3a8f6ca13dc270ad29372fc"
        },
        "monterey": {
          "url": "https://ghcr.io/v2/homebrew/core/openssl/1.1/blobs/sha256:d915175bedb146e38d7a2c95e86888a60a5058a5cd21f835813d43d1372a29d9"
        },
        "big_sur": {
          "url": "https://ghcr.io/v2/homebrew/core/openssl/1.1/blobs/sha256:5d05ea107240c4ed9dd06e166556063b8910773dddba5b96ccf09d405e6b6771"
        },
        "catalina": {
          "url": "https://ghcr.io/v2/homebrew/core/openssl/1.1/blobs/sha256:210eed5ef3fccfca89ce309648606b1f10a8854a922b8a62ff0dbb23050b46b5"
        },
        "x86_64_linux": {
          "url": "https://ghcr.io/v2/homebrew/core/openssl/1.1/blobs/sha256:b7c45d0cd6d99a60b1fe7511db1dd46bf2c52b2575dbf89ce195b8b078a34a42"
        }
      }
    }
  ]
}

Get formula metadata for a cask formula

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

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

Variables

Response

{
  "token": "docker",
  "full_token": "docker",
  "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/93002/Docker.dmg",
  "appcast": null,
  "version": "4.15.0,93002",
  "versions": {},
  "installed": null,
  "outdated": false,
  "sha256": "bee41d646916e579b16b7fae014e2fb5e5e7b5dbaf7c1949821fd311d3ce430b",
  "artifacts": [
    {
      "uninstall": [
        {
          "delete": [
            "/Library/PrivilegedHelperTools/com.docker.vmnetd",
            "$(brew --prefix)/bin/com.docker.cli",
            "$(brew --prefix)/bin/docker-compose-v1",
            "$(brew --prefix)/bin/docker-compose",
            "$(brew --prefix)/bin/docker-credential-desktop",
            "$(brew --prefix)/bin/docker-credential-ecr-login",
            "$(brew --prefix)/bin/docker-credential-osxkeychain",
            "$(brew --prefix)/bin/docker",
            "$(brew --prefix)/bin/hub-tool",
            "$(brew --prefix)/bin/hyperkit",
            "$(brew --prefix)/bin/kubectl.docker",
            "$(brew --prefix)/bin/kubectl",
            "$(brew --prefix)/bin/notary",
            "$(brew --prefix)/bin/vpnkit",
            "$(brew --prefix)/share/zsh/site-functions/_docker",
            "$(brew --prefix)/share/zsh/site-functions/_docker_compose",
            "$(brew --prefix)/share/fish/vendor_completions.d/docker.fish",
            "$(brew --prefix)/share/fish/vendor_completions.d/docker-compose.fish",
            "$(brew --prefix)/etc/bash_completion.d/docker",
            "$(brew --prefix)/etc/bash_completion.d/docker-compose"
          ],
          "launchctl": [
            "com.docker.helper",
            "com.docker.vmnetd"
          ],
          "quit": "com.docker.docker"
        }
      ]
    },
    {
      "app": [
        "Docker.app"
      ]
    },
    {
      "binary": [
        "/Applications/Docker.app/Contents/Resources/etc/docker-compose.bash-completion",
        {
          "target": "$(brew --prefix)/etc/bash_completion.d/docker-compose"
        }
      ]
    },
    {
      "binary": [
        "/Applications/Docker.app/Contents/Resources/etc/docker.zsh-completion",
        {
          "target": "$(brew --prefix)/share/zsh/site-functions/_docker"
        }
      ]
    },
    {
      "binary": [
        "/Applications/Docker.app/Contents/Resources/etc/docker.fish-completion",
        {
          "target": "$(brew --prefix)/share/fish/vendor_completions.d/docker.fish"
        }
      ]
    },
    {
      "binary": [
        "/Applications/Docker.app/Contents/Resources/etc/docker-compose.fish-completion",
        {
          "target": "$(brew --prefix)/share/fish/vendor_completions.d/docker-compose.fish"
        }
      ]
    },
    {
      "binary": [
        "/Applications/Docker.app/Contents/Resources/etc/docker-compose.zsh-completion",
        {
          "target": "$(brew --prefix)/share/zsh/site-functions/_docker_compose"
        }
      ]
    },
    {
      "binary": [
        "/Applications/Docker.app/Contents/Resources/etc/docker.bash-completion",
        {
          "target": "$(brew --prefix)/etc/bash_completion.d/docker"
        }
      ]
    },
    {
      "zap": [
        {
          "trash": [
            "$(brew --prefix)/bin/docker-compose.backup",
            "$(brew --prefix)/bin/docker.backup",
            "~/.docker",
            "~/Library/Application Scripts/com.docker.helper",
            "~/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.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": {
      ">=": [
        "10.15"
      ]
    }
  },
  "conflicts_with": {
    "formula": [
      "docker",
      "docker-completion",
      "docker-compose",
      "docker-compose-completion",
      "docker-credential-helper-ecr",
      "hyperkit",
      "kubernetes-cli"
    ]
  },
  "container": null,
  "auto_updates": true,
  "variations": {
    "arm64_ventura": {
      "url": "https://desktop.docker.com/mac/main/arm64/93002/Docker.dmg",
      "sha256": "fc8609d57fb8c8264122f581c0f66497e46e171f8027d85d90213527d6226362"
    },
    "arm64_monterey": {
      "url": "https://desktop.docker.com/mac/main/arm64/93002/Docker.dmg",
      "sha256": "fc8609d57fb8c8264122f581c0f66497e46e171f8027d85d90213527d6226362"
    },
    "arm64_big_sur": {
      "url": "https://desktop.docker.com/mac/main/arm64/93002/Docker.dmg",
      "sha256": "fc8609d57fb8c8264122f581c0f66497e46e171f8027d85d90213527d6226362"
    }
  },
  "analytics": {
    "install": {
      "30d": {
        "docker": 26143
      },
      "90d": {
        "docker": 78484
      },
      "365d": {
        "docker": 310784
      }
    }
  },
  "generated_date": "2022-12-04"
}

Get the source code for a cask in Homebrew/homebrew-cask

Get the latest source code for a cask that is defined in the Homebrew/homebrew-cask repo.

GET https://formulae.brew.sh/api/cask-source/${FORMULA}.rb

Variables

Response

cask "vagrant" do
  version "2.3.3"
  sha256 "3b54146c340690b5802d709825549f850673d2fb134b73e67e1fedb7cba60376"

  url "https://releases.hashicorp.com/vagrant/#{version}/vagrant_#{version}_darwin_amd64.dmg",
      verified: "hashicorp.com/vagrant/"
  name "Vagrant"
  desc "Development environment"
  homepage "https://www.vagrantup.com/"

  livecheck do
    url "https://github.com/hashicorp/vagrant"
    strategy :git
  end

  pkg "vagrant.pkg"

  uninstall script:  {
              executable: "uninstall.tool",
              input:      ["Yes"],
              sudo:       true,
            },
            pkgutil: "com.vagrant.vagrant"

  zap trash: "~/.vagrant.d"
end

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
GET https://formulae.brew.sh/api/analytics-linux/${CATEGORY}/${DAYS}.json

Variables

Response

{
  "category": "install",
  "total_items": 15033,
  "start_date": "2022-11-04",
  "end_date": "2022-12-04",
  "total_count": 44220683,
  "items": [
    ...
    {
      "number": 111,
      "formula": "wget",
      "count": "103,518",
      "percent": "0.23"
    },
    ...
  ]
}

List analytics events for all 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
GET https://formulae.brew.sh/api/analytics-linux/${CATEGORY}/homebrew-core/${DAYS}.json

Variables

Response

{
  "category": "install",
  "total_items": 6945,
  "start_date": "2022-11-04",
  "end_date": "2022-12-04",
  "total_count": 43503212,
  "formulae": {
    ...
    "wget": [
      {
        "formula": "wget",
        "count": "103,518"
      },
      {
        "formula": "wget --HEAD",
        "count": "2"
      },
      ...
    ],
    ...
  }
}

List analytics events for all cask formulae

List all the Homebrew/homebrew-cask formulae’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

Response

{
  "category": "cask_install",
  "total_items": 6268,
  "start_date": "2022-11-04",
  "end_date": "2022-12-04",
  "total_count": 992986,
  "formulae": {
    ...
    "docker": [
      {
        "cask": "docker",
        "count": "26,143"
      }
    ],
    "docker-edge": [
      {
        "cask": "docker-edge",
        "count": "26"
      }
    ],
    "docker-toolbox": [
      {
        "cask": "docker-toolbox",
        "count": "79"
      }
    ],
    ...
  }
}
Fork me on GitHub