# Shields.io Badge

{% hint style="info" %}
This API can be used with the [Endpoint Badge](https://shields.io/badges/endpoint-badge) of shields.io to create badges for your `README.md`
{% endhint %}

## Installation count of specific repository

## Installation count badge

<mark style="color:blue;">`GET`</mark> `https://instl.sh/api/v1/badge/shields.io/stats/user/repo`

#### Path Parameters

| Name                                   | Type   | Description                    |
| -------------------------------------- | ------ | ------------------------------ |
| user<mark style="color:red;">\*</mark> | String | Owner of the GitHub repository |
| repo<mark style="color:red;">\*</mark> | String | Name of the GitHub repository  |

{% tabs %}
{% tab title="200: OK Shields.io badge schema response" %}

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

{% endtab %}
{% endtabs %}

## Total installations handled by instl&#x20;

## Total installations handled by instl badge

<mark style="color:blue;">`GET`</mark> `https://instl.sh/api/v1/badge/shields.io/stats/total`

{% tabs %}
{% tab title="200: OK Shields.io badge schema response" %}

```javascript
{
    "color":"orange",
    "label":"handled installations",
    "message":"1337",
    "schemaVersion":1
}
```

{% endtab %}
{% endtabs %}