artifacthub.search

stable Advanced

Search Artifact Hub packages (Helm charts, operators and more).

GET /v1/artifacthub/search

What you get#

A list of Artifacthub results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/artifacthub/search?q=nginx" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Artifacthub response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "bec45f52-fe90-46a1-b6eb-a3dcd9bb203f",
        "name": "nginx",
        "description": "NGINX Open Source is a web server that can be also used as a reverse proxy, load balancer, and HTTP cache. Recommended for high-demanding sites due to its ability to provide faster content.",
        "stats": {
          "stars": 107
        },
        "updatedAt": "2026-09-28T13:44:31Z"
      },
      "package": {
        "version": "25.2.0",
        "deprecated": false
      },
      "ext": {
        "appVersion": "1.31.6",
        "repository": "bitnami",
        "verifiedPublisher": true
      },
      "author": {
        "username": "bitnami"
      }
    },
    {
      "entity": {
        "id": "ba70c546-4f86-4d82-b414-0bd0f47fc731",
        "name": "nginx",
        "description": "Nginx is a high-performance HTTP server and reverse proxy.",
        "stats": {
          "stars": 7
        },
        "updatedAt": "2026-09-22T06:01:47Z"
      },
      "package": {
        "version": "0.16.10",
        "deprecated": false
      },
      "ext": {
        "appVersion": "1.31.6",
        "repository": "cloudpirates-nginx",
        "verifiedPublisher": true
      },
      "author": {
        "username": "cloudpirates"
      }
    }
  ],
  "metadata": {
    "platform": "artifacthub",
    "endpoint": "search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`package_id`	`entity.id`	-
`name`	`entity.name`	-
`version`	`package.version`	-
`app_version`	`ext.appVersion`	-
`description`	`entity.description`	-
`stars`	`entity.stats.stars`	`toNumber`
`repository.name`	`ext.repository`	-
`repository.organization_name`	`author.username`	-
`repository.verified_publisher`	`ext.verifiedPublisher`	`toBoolean`
`ts`	`entity.updatedAt`	`toIsoDate`
`deprecated`	`package.deprecated`	`toBoolean`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).