shipapis
StarSubmit an APISubmit API

Shields

Badge data (and SVG), now available as JSON too

📚 Open DataUNMONITOREDchecked 13 min ago
AUTH NONECORS ✓AGENT ✓HTTPS ✓COMMERCIAL ?

Shields.io is the badge factory behind millions of READMEs. Beyond the usual SVG, appending .json to a /badge/ path returns the badge's label, message and color as structured JSON. It's free and keyless; very heavy users are asked to self-host.

—HOW IT'S SCORED ⓘ
▶ Run liveDocs ↗
Status badge · for your READMEshipapis health badge: — · unmonitored
Uptime history
—%90 days
—%30 days
—P50 · ms
—P95 · ms
operationalpartialdownno data
Live response samplecaptured by our last successful check
GET https://img.shields.io/badge/test-passing-green.json

{
  "label": "test",
  "message": "passing",
  "color": "green",
  "link": [],
  "name": "test",
  "value": "passing"
}
Call itcurl · fetch · python
curl "https://img.shields.io/badge/test-passing-green.json"
const res = await fetch("https://img.shields.io/badge/test-passing-green.json");
const data = await res.json();
console.log(data);
import requests

res = requests.get("https://img.shields.io/badge/test-passing-green.json")
print(res.json())
Endpoints · 5On scheduleFULL DOCS ↗
First rollup pending — GET /badge/test-passing-green.json has been probed
GET/badge/test-passing-green.jsonPROBED

Badge data (and SVG), now available as JSON too

GET/badge

Badge — documented GET route.

GET/badge/1

Badge details by ID (example: 1).

GET/badge?limit=10

Badge — documented GET route.

GET/badge/search?q=test

Search by query parameters.

Machine-readable spec

We probe a documented GET and expect 2xx JSON — full uptime and health score. Export includes every documented route below.

Response-shape history

Stable. No schema drift observed since monitoring began — the response shape has not changed under our checks.

Shields: common questions

Is Shields free to use?

Yes — Shields is a free open data API. Free tier: Free — limits not published. Whether the free tier allows commercial use is unclear — check the provider docs.

Does Shields need an API key?

No — Shields needs no API key or signup. You can call it straight away; rate limits still apply (Unpublished).

Can I call Shields from the browser?

Yes — Shields returns CORS headers over HTTPS, so front-end code can fetch it directly with no backend proxy. Use the fetch snippet on this page, or hit "Run live" to try it now.

Is Shields up right now?

As of our last scheduled check, Shields is unmonitored. We re-probe it every sweep — the status badge and uptime chart above always show the latest.