Docs
View as Markdown

artifacthub.helm_chart

stable Standard

Metadata of a Helm chart on Artifact Hub.

GET /v1/artifacthub/helm_chart

What you get#

One Artifacthub record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

  • Standard · 1 credit 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#

NameTypeRequiredDefaultWhat it isConstraints
repostringyes(required)Helm repository namemax 100 chars; must match [a-z0-9][a-z0-9._-]{0,99}; trimmed, lowercased
chartstringyes(required)Chart namemax 100 chars; must match [a-z0-9][a-z0-9._-]{0,99}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/artifacthub/helm_chart?repo=bitnami&chart=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": null
      },
      "updatedAt": "2026-09-28T13:44:31Z",
      "tags": [
        "nginx",
        "http",
        "web"
      ]
    },
    "package": {
      "version": "25.2.0",
      "deprecated": false,
      "homepageUrl": "https://bitnami.com",
      "license": null
    },
    "ext": {
      "appVersion": "1.31.6",
      "repository": "bitnami",
      "verifiedPublisher": true
    },
    "author": {
      "username": "bitnami"
    }
  },
  "metadata": {
    "platform": "artifacthub",
    "endpoint": "helm_chart",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "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 pathOnekey fieldTransform
package_identity.id-
nameentity.name-
versionpackage.version-
app_versionext.appVersion-
descriptionentity.description-
starsentity.stats.starstoNumber
repository.nameext.repository-
repository.organization_nameauthor.username-
repository.verified_publisherext.verifiedPublishertoBoolean
tsentity.updatedAttoIsoDate
deprecatedpackage.deprecatedtoBoolean
home_urlpackage.homepageUrlsafeUrl
licensepackage.license-
keywordsentity.tags-

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day 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 3 days more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).