catalog
Search for packages
Search the catalog(s) under the given criteria for matching packages.
Required Query Parameters:
- system: The system architecture to search for (e.g., x86_64-linux)
Optional Query Parameters:
- search_term: The search term to filter packages by
- catalogs: Comma separated list of catalog names to search; defaults to all catalogs. Note: when searching base catalog, search_term is required.
- page: Page number for pagination (default: 0)
- pageSize: Page size for pagination (default: 10) Returns:
- PackageSearchResult: A list of PackageInfoSearch items and total count
get/api/v1/catalog/search
Query parameters
system'aarch64-darwin' | 'aarch64-linux' | 'x86_64-darwin' | 'x86_64-linux' | 'invalid' required
search_termstring nullable
catalogsstring nullable
pageinteger
pageSizeinteger
Response
A list of matching packages
Example response
{
"items": [
{
"attr_path": "foo.bar.curl",
"catalog": "nixpkgs",
"description": "A very nice Item",
"name": "curl",
"pkg_path": "foo.bar.curl",
"pname": "curl",
"stabilities": [
"stable",
"unstable"
],
"system": "x86_64-linux",
"version": "1.0"
}
],
"total_count": 1
}