INSTL
🔗 Instl.sh🐙 GitHub💙 Donate
  • 👋Welcome
  • 🔥Usage
    • Getting Started
    • Supported Project Structure
    • Verbose Output
  • 🥇Badges
    • Installation Count
  • 📊Statistics
    • Installation Statistics
  • 📦API
    • Installation Statistics
    • Shields.io Badge
  • 💙contributing
    • Writing Code
Powered by GitBook

Made with 💙

  • Marvin Wendt
On this page
  • Installation count of specific repository
  • Installation count badge
  • Total installations handled by instl
  • Total installations handled by instl badge

Was this helpful?

Edit on GitHub
  1. API

Shields.io Badge

Badge API for shields.io support

PreviousInstallation StatisticsNextWriting Code

Last updated 1 year ago

Was this helpful?

This API can be used with the of shields.io to create badges for your README.md

Installation count of specific repository

Installation count badge

GET https://instl.sh/api/v1/badge/shields.io/stats/user/repo

Path Parameters

Name
Type
Description

user*

String

Owner of the GitHub repository

repo*

String

Name of the GitHub repository

{
    "color":"orange",
    "label":"installations",
    "message":"4",
    "schemaVersion":1
}

Total installations handled by instl

Total installations handled by instl badge

GET https://instl.sh/api/v1/badge/shields.io/stats/total

{
    "color":"orange",
    "label":"handled installations",
    "message":"1337",
    "schemaVersion":1
}
📦
Endpoint Badge