📚 Documentation & Examples
Everything you need to integrate with Shields
🚀 Quick Start Examples
// Shields API Example
const response = await fetch('https://shields.io/', {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);The Badges API offers developers a streamlined solution for generating visually appealing badges in both SVG and raster formats. With a focus on clarity and consistency, the API allows you to create badges that effectively convey important information about your projects, services, or software metrics. Utilizing this API enhances the aesthetics of your documentation and repositories, ensuring that your audience can instantly grasp critical data at a glance. The simplicity of its design ensures that developers can seamlessly integrate badge creation into their existing workflows, enhancing the overall user experience.
By using the Badges API, you can take advantage of several key benefits:
- Generate high-quality badges in multiple formats (SVG and PNG).
- Customize badge colors and labels to fit your branding needs.
- Improve readability and visibility for code repositories or documentation.
- Save development time with easy-to-use endpoints.
- Enhance the professional appearance of your projects.
Here’s a simple JavaScript example for calling the Badges API to create a badge:
const badgeUrl = "https://img.shields.io/static/v1?label=Build&message=Passing&color=success";
fetch(badgeUrl)
.then(response => response.blob())
.then(imageBlob => {
const imageObjectURL = URL.createObjectURL(imageBlob);
document.querySelector("#badge").src = imageObjectURL;
})
.catch(error => console.error('Error fetching badge:', error));
Security Assessment
📊 30-Day Uptime History
Daily uptime tracking showing online vs offline minutes
