Skip to main content
POST
/
api
/
homebrew
/
formulae
/
search
/homebrew/formulae/search
curl --request POST \
  --url https://api.anysite.io/api/homebrew/formulae/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "name": "<string>",
    "@type": "HomebrewFormula",
    "full_name": "",
    "tap": "",
    "aliases": [],
    "oldnames": [],
    "versioned_formulae": [],
    "description": "<string>",
    "license": "<string>",
    "homepage": "<string>",
    "version": "<string>",
    "head_version": "<string>",
    "is_bottled": false,
    "revision": 0,
    "stable_url": "<string>",
    "dependencies": [],
    "build_dependencies": [],
    "test_dependencies": [],
    "uses_from_macos": [],
    "requirements": [],
    "service": {
      "@type": "HomebrewFormulaService",
      "run": [],
      "run_type": "<string>",
      "keep_alive": {},
      "working_dir": "<string>",
      "log_path": "<string>",
      "error_log_path": "<string>",
      "environment_variables": {}
    },
    "conflicts_with": [],
    "keg_only": false,
    "keg_only_reason": "<string>",
    "caveats": "<string>",
    "executables": [],
    "is_deprecated": false,
    "deprecation_date": "<string>",
    "deprecation_reason": "<string>",
    "deprecation_replacement": "<string>",
    "is_disabled": false,
    "disable_date": "<string>",
    "disable_reason": "<string>",
    "disable_replacement": "<string>",
    "install_count_30d": 0,
    "install_count_90d": 0,
    "install_count_365d": 0,
    "source_path": "<string>",
    "generated_date": "<string>",
    "web_url": ""
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
query
string
required

Search query matched against formula name, description and aliases

Minimum string length: 1
Examples:

"compiler"

"video"

count
integer
required

Number of formulae to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

name
string
required
@type
string
default:HomebrewFormula
full_name
string
default:""
tap
string
default:""
aliases
string[]
oldnames
string[]
versioned_formulae
string[]
description
string | null
license
string | null
homepage
string | null
version
string | null
head_version
string | null
is_bottled
boolean
default:false
revision
integer
default:0
stable_url
string | null
dependencies
string[]
build_dependencies
string[]
test_dependencies
string[]
uses_from_macos
string[]
requirements
object[]
service
object | null
conflicts_with
string[]
keg_only
boolean
default:false
keg_only_reason
string | null
caveats
string | null
executables
string[]
is_deprecated
boolean
default:false
deprecation_date
string | null
deprecation_reason
string | null
deprecation_replacement
string | null
is_disabled
boolean
default:false
disable_date
string | null
disable_reason
string | null
disable_replacement
string | null
install_count_30d
integer
default:0
install_count_90d
integer
default:0
install_count_365d
integer
default:0
source_path
string | null
generated_date
string | null
web_url
string
default:""