Shields

Provides customizable status badges in SVG and JSON format for use in documentation and project READMEs, including dynamic badges that reflect live metrics from GitHub, npm, and other services.

Claim this API

Are you the operator of Shields? Submit a claim to establish contact with us.

Report an Issue

Found something wrong with Shields? Let us know about broken links, changed auth, deprecated endpoints, or other issues.
Slug: shields
Key: shields.io:shields
Base URL: https://shields.io/
Auth: none
Endpoints: 9
Reachable: unknown
CORS: unknown
Tier: verified

Topics

DEVTOOLS, IMAGES

Endpoints (9)

Path Summary Response Auth
badge/{badgeContent} Generate a static badge application/octet-stream none
badge/{badgeContent}.json Generate a static badge (JSON format) application/json none
github/contributors/{owner}/{repo} GitHub repository contributors count application/octet-stream none
github/forks/{owner}/{repo} GitHub repository fork count application/octet-stream none
github/issues/{owner}/{repo} GitHub repository issue count application/octet-stream none
github/license/{owner}/{repo} GitHub repository license application/octet-stream none
github/license/{owner}/{repo}.json GitHub repository license (JSON) application/json none
github/stars/{owner}/{repo} GitHub repository star count application/octet-stream none
github/stars/{owner}/{repo}.json GitHub repository star count (JSON) application/json none