# Docker Hub on Onekey

> 6 endpoints for Docker Hub (6 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/dockerhub
Reference (Markdown): https://onekey.dev/docs/api/dockerhub.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

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

- `entity.name` (string): 5
- `entity.updatedAt` (ISO 8601 date): 4
- `entity.description` (string): 3
- `entity.stats.stars` (integer): 3
- `author.username` (string): 2
- `entity.createdAt` (ISO 8601 date): 2
- `entity.status` (string): 2
- `package.namespace` (string): 2
- `author.createdAt` (ISO 8601 date): 1
- `author.displayName` (string): 1
- `author.id` (string): 1
- `author.location` (string): 1
- `author.type` (string): 1
- `author.url` (URL): 1
- plus 7 platform-specific fields under `ext.`

## Endpoints

### dockerhub.namespace_repos

Public repositories of a Docker Hub user or organisation.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/dockerhub/namespace_repos?namespace=docker` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `namespace` (string, required): Docker Hub namespace (use library for official images)
- Fields returned: `package.namespace`, `entity.name`, `entity.description`, `entity.stats.stars`, `entity.updatedAt`, `entity.createdAt`, `ext.pulls`, `ext.private`
- Reference: https://onekey.dev/docs/api/dockerhub/namespace_repos.md

### dockerhub.repo

Docker Hub repository metadata (stars, pulls).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/dockerhub/repo?namespace=library&repo=nginx` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `namespace` (string, required): Docker Hub namespace (use library for official images)
  - `repo` (string, required): Docker Hub repository
- Fields returned: `package.namespace`, `entity.name`, `entity.description`, `entity.stats.stars`, `entity.updatedAt`, `entity.createdAt`, `ext.pulls`, `ext.private`
- Reference: https://onekey.dev/docs/api/dockerhub/repo.md

### dockerhub.search

Search Docker Hub repositories.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/dockerhub/search?q=nginx` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `entity.name`, `entity.description`, `entity.stats.stars`, `ext.pulls`, `ext.official`
- Reference: https://onekey.dev/docs/api/dockerhub/search.md

### dockerhub.tag

Details of one Docker Hub image tag.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/dockerhub/tag?namespace=library&repo=nginx&tag=latest` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `namespace` (string, required): Docker Hub namespace (use library for official images)
  - `repo` (string, required): Docker Hub repository
  - `tag` (string, required): Image tag
- Fields returned: `entity.name`, `entity.updatedAt`, `entity.status`, `author.username`, `ext.size`, `ext.digest`
- Reference: https://onekey.dev/docs/api/dockerhub/tag.md

### dockerhub.tags

Most recently pushed tags of a Docker Hub repository.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/dockerhub/tags?namespace=library&repo=nginx` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `namespace` (string, required): Docker Hub namespace (use library for official images)
  - `repo` (string, required): Docker Hub repository
- Fields returned: `entity.name`, `entity.updatedAt`, `entity.status`, `ext.size`, `ext.digest`
- Reference: https://onekey.dev/docs/api/dockerhub/tags.md

### dockerhub.user

Docker Hub user or organisation profile.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/dockerhub/user?name=docker` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): Docker Hub namespace (use library for official images)
- Fields returned: `author.id`, `author.username`, `author.displayName`, `author.url`, `author.createdAt`, `author.type`, `author.location`, `ext.orgname`, `ext.company`
- Reference: https://onekey.dev/docs/api/dockerhub/user.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/dockerhub/repo?namespace=library&repo=nginx" \
  -H "x-api-key: YOUR_API_KEY"
```