Docker Hub image search
Images (and extensions and plugins) on Docker Hub matching a search and the Hub's filters: id, name, namespace, link, type, description, publisher, official, verified-publisher and open-source flags, stars, pull count band, dates (created, updated, last pushed and pulled), archived flag, categories, architectures, operating systems and logo. total is the number of matches. Pass next_page back as page; null on the last page.
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
q | string | Search words. Example: redis |
official | true | false | true: Docker Official Images only. |
verified | true | false | true: verified publishers only. |
open_source | true | false | true: sponsored open-source projects only. |
category | string | Category slug from /dockerhub/v1/categories, e.g. databases-and-storage. |
type | image | extension | plugin | Content type. |
architecture | string | CPU architecture, e.g. arm64, amd64, riscv64. |
os | linux | windows | Operating system. |
sort | best_match | pull_count | updated_at | best_match (default), pull_count or updated_at. |
page | integer | Page number (default 1). |
limit | integer | Results per page (default 25, max 100). |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/dockerhub/v1/search?q=redis" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/dockerhub/v1/search",
params={"q": "redis"},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json() const url = new URL("https://api.api.sh/dockerhub/v1/search");
url.searchParams.set("q", "redis");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json(); Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).