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

total_countinteger required

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
}

Changes

Changed in 14 of the 53 revisions of this API.341031

Aug 27, 20268ec561551880241See the full diff
- ▲
  the // response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ●
  for the query request parameter page, the min was set to 0.00
  request-parameter-min-set
- ●
  for the query request parameter pageSize, the min was set to 0.00
  request-parameter-min-set
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  added to the // response property allOf list for the response status
  response-property-all-of-added
Jul 23, 202605d6283fc201111See the full diff
- ▲
  for the query request parameter search_term, the minLength was increased from 0 to 2
  request-parameter-min-length-increased
- ●
  for the query request parameter search_term, the maxLength was set to 200
  request-parameter-max-length-set
- ○
  removed the pattern [a-zA-Z0-9\-\.\\@%_,]{2,200} from the query request parameter search_term
  request-parameter-pattern-removed
Mar 18, 2026b99206a49d271See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 23, 202529c059f1823a1See the full diff
- ○
  the endpoint scheme security HTTPBasic was added to the API
  api-security-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 18, 202503a19e372fd811See the full diff
- ▲
  for the query request parameter catalogs, default value nixpkgs was removed
  request-parameter-default-value-removed
- ○
  the query request parameter search_term became optional
  request-parameter-became-optional
Feb 10, 2025b1a16c027df31See the full diff
- ○
  added the required property // to the response with the status
  response-required-property-added
Nov 20, 2024da0b62672ad13See the full diff
- ○
  the endpoint scheme security HTTPBearer was added to the API
  api-security-added
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
Oct 3, 202400ece6bb6c9111See the full diff
- ●
  added the new invalid enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new enum value invalid to the query request parameter system
  request-parameter-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 12, 202449bbb9914d801See the full diff
- ●
  changed the pattern of the query request parameter search_term from [a-zA-Z0-9\-\._,]{2,200} to [a-zA-Z0-9\-\.\\@%_,]{2,200}
  request-parameter-pattern-changed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 13, 2024201fc251983f8See the full diff
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (14 revisions)