/homebrew/casks/search

POST /api/homebrew/casks/search

Price: 20 credits

Search Homebrew casks by keyword

How to use it

Search Homebrew casks (macOS GUI applications) by keyword matched against token, display names and description. Results are ordered by relevance and install popularity. Each result carries the same full cask details as the get-by-id endpoint, including 30/90/365-day install counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search query matched against cask token, display names and description (examples: "browser", "editor"; minLength: 1)
• count integer required — Number of casks to return (min: 1)

Response

• @type string (default: "HomebrewCask")
• token string required
• full_token string (default: "")
• old_tokens array (default: [])
• tap string (default: "")
• names array (default: [])
• description string nullable
• homepage string nullable
• download_url string nullable
• version string nullable
• bundle_version string nullable
• bundle_short_version string nullable
• sha256 string nullable
• auto_updates boolean (default: false)
• apps array (default: [])
• binaries array (default: [])
• pkgs array (default: [])
• depends_on_formulae array (default: [])
• depends_on_casks array (default: [])
• macos_requirement string nullable
• conflicts_with array (default: [])
• languages array (default: [])
• caveats string nullable
• is_deprecated boolean (default: false)
• deprecation_date string nullable
• deprecation_reason string nullable
• deprecation_replacement string nullable
• is_disabled boolean (default: false)
• disable_date string nullable
• disable_reason string nullable
• disable_replacement string nullable
• install_count_30d integer (default: 0)
• install_count_90d integer (default: 0)
• install_count_365d integer (default: 0)
• source_path string nullable
• generated_date string nullable
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.