# Homebrew on Onekey

> 4 endpoints for Homebrew (4 stable, 0 beta), 1 to 5 credits each. Category: Developer platforms. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/homebrew
Reference (Markdown): https://onekey.dev/docs/api/homebrew.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 4 mapped Homebrew endpoints return each:

- `entity.name` (string): 4
- `entity.description` (string): 2
- `entity.stats.rank` (integer): 2
- `package.deprecated` (boolean): 2
- `package.homepageUrl` (URL): 2
- `package.version` (string): 2
- `package.dependencies` (list of strings): 1
- `package.license` (string): 1
- plus 4 platform-specific fields under `ext.`

## Endpoints

### homebrew.cask

Homebrew cask metadata.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/homebrew/cask?name=firefox` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): Formula or cask name
- Fields returned: `entity.name`, `package.version`, `entity.description`, `package.homepageUrl`, `package.deprecated`, `ext.tap`, `ext.autoUpdates`
- Reference: https://onekey.dev/docs/api/homebrew/cask.md

### homebrew.cask_analytics

Most installed Homebrew casks (install analytics).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/homebrew/cask_analytics` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `period` (string, optional, default 30d): 30d, 90d or 365d
- Fields returned: `entity.stats.rank`, `entity.name`, `ext.installs`, `ext.percent`
- Reference: https://onekey.dev/docs/api/homebrew/cask_analytics.md

### homebrew.formula

Homebrew formula metadata.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/homebrew/formula?name=wget` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): Formula or cask name
- Fields returned: `entity.name`, `package.version`, `entity.description`, `package.homepageUrl`, `package.license`, `package.dependencies`, `package.deprecated`, `ext.tap`
- Reference: https://onekey.dev/docs/api/homebrew/formula.md

### homebrew.formula_analytics

Most installed Homebrew formulae (install analytics).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/homebrew/formula_analytics` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `period` (string, optional, default 30d): 30d, 90d or 365d
- Fields returned: `entity.stats.rank`, `entity.name`, `ext.installs`, `ext.percent`
- Reference: https://onekey.dev/docs/api/homebrew/formula_analytics.md

## Sample request

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