/anaconda/packages/search

POST /api/anaconda/packages/search

Price: 10 credits

Search conda packages across Anaconda.org channels by name, optionally filtered by platform or type

How to use it

Search conda packages across all Anaconda.org channels by name. Because a package name is unique only within a channel, results can include the same name from multiple channels. Optionally restrict results to a platform (build subdir, e.g. win-64, osx-arm64, noarch) or to an artifact type (conda, pypi, ...). Each result returns the name, channel, summary, description, package types, homepage, latest version, per-platform latest versions, license, development/documentation/source links, and download count.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• name string required — Search query matched against package names (examples: "numpy", "pytest"; minLength: 1)
• count integer required — Number of packages to return (min: 1)
• platform string nullable — Restrict to packages that provide a build for this platform (subdir) (one of: "noarch", "linux-64", "linux-aarch64", "linux-ppc64le", "linux-s390x", "linux-32", "linux-armv6l", "linux-armv7l", "osx-64", "osx-arm64", "win-64", "win-32", "win-arm64", "zos-z")
• package_type string nullable — Restrict to packages of this artifact type (one of: "conda", "pypi", "env", "ipynb", "installer")

Response

• @type string (default: "AnacondaSearchPackage")
• name string required
• channel string required
• full_name string (default: "")
• summary string nullable
• description string nullable
• package_types array (default: [])
• homepage string nullable
• latest_version string nullable
• version_count integer (default: 0)
• platforms object (default: {})
  • * string
• conda_platforms array (default: [])
• license string nullable
• license_url string nullable
• dev_url string nullable
• doc_url string nullable
• source_git_url string nullable
• download_count integer (default: 0)
• 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.