Homebrew API

Get Homebrew data as clean JSON with one key: 4 endpoints, 1 to 5 credits per call, the same response shape as every other platform.

What you get#

Onekey exposes Homebrew as 4 endpoints behind one API key: 2 endpoints return one record (data is an object) and 2 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Homebrew also works for the rest of the developer platforms category.

Endpoints#

EndpointWhat it doesParametersCreditsStatus
caskHomebrew cask metadata.name*1stable
cask_analyticsMost installed Homebrew casks (install analytics).period5stable
formulaHomebrew formula metadata.name*1stable
formula_analyticsMost installed Homebrew formulae (install analytics).period5stable

A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.

Make a request#

This calls homebrew.cask (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.

curl "https://api.onekey.dev/v1/homebrew/cask?name=firefox" \
  -H "x-api-key: YOUR_API_KEY"

Fields you get back#

These unified fields come back from Homebrew, with the same names as on every other platform. The count is how many of its 4 mapped endpoints return the field; a field the source lacks is null, never missing. 4 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.

FieldTypeEndpoints
entity.namestring4
entity.descriptionstring2
entity.stats.rankinteger2
package.deprecatedboolean2
package.homepageUrlURL2
package.versionstring2
package.dependencieslist of strings1
package.licensestring1

The full schema is in Unified schema.

Pricing#

Homebrew calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.