# Artifact Hub on Onekey

> 3 endpoints for Artifact Hub (3 stable, 0 beta), 1 to 5 credits each. Category: Developer platforms. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/artifacthub
Reference (Markdown): https://onekey.dev/docs/api/artifacthub.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 3 mapped Artifact Hub endpoints return each:

- `author.username` (string): 3
- `entity.id` (string): 3
- `entity.name` (string): 3
- `entity.description` (string): 2
- `entity.stats.stars` (integer): 2
- `entity.updatedAt` (ISO 8601 date): 2
- `package.deprecated` (boolean): 2
- `package.version` (string): 2
- `entity.tags` (list of strings): 1
- `entity.url` (URL): 1
- `package.homepageUrl` (URL): 1
- `package.license` (string): 1
- plus 5 platform-specific fields under `ext.`

## Endpoints

### artifacthub.helm_chart

Metadata of a Helm chart on Artifact Hub.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/artifacthub/helm_chart?repo=bitnami&chart=nginx` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `repo` (string, required): Helm repository name
  - `chart` (string, required): Chart name
- Fields returned: `entity.id`, `entity.name`, `package.version`, `entity.description`, `entity.stats.stars`, `author.username`, `entity.updatedAt`, `package.deprecated`, `package.homepageUrl`, `package.license`, `entity.tags`, `ext.appVersion`, `ext.repository`, `ext.verifiedPublisher`
- Reference: https://onekey.dev/docs/api/artifacthub/helm_chart.md

### artifacthub.repositories

Search Artifact Hub repositories.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/artifacthub/repositories?q=bitnami` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Repository name
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `author.username`, `ext.displayName`, `ext.verifiedPublisher`, `ext.official`
- Reference: https://onekey.dev/docs/api/artifacthub/repositories.md

### artifacthub.search

Search Artifact Hub packages (Helm charts, operators and more).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/artifacthub/search?q=nginx` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `entity.id`, `entity.name`, `package.version`, `entity.description`, `entity.stats.stars`, `author.username`, `entity.updatedAt`, `package.deprecated`, `ext.appVersion`, `ext.repository`, `ext.verifiedPublisher`
- Reference: https://onekey.dev/docs/api/artifacthub/search.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/artifacthub/helm_chart?repo=bitnami&chart=nginx" \
  -H "x-api-key: YOUR_API_KEY"
```