### Shields.io Core Badges

Source: https://shields.io/badges/visual-studio-marketplace-installs

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Visual Studio Marketplace Installs - Azure DevOps Extension API

Source: https://shields.io/badges/visual-studio-marketplace-installs-azure-dev-ops-extension

This API endpoint generates badges displaying install counts for Azure DevOps extensions from the Visual Studio Marketplace. It supports filtering by total installs, on-premises installs, or cloud services installs.

```APIDOC
Visual Studio Marketplace Installs - Azure DevOps Extension Badge:

Generates a badge showing the install count for a Visual Studio Marketplace extension for Azure DevOps.

Endpoint:
`https://img.shields.io/visual-studio-marketplace/installs/azure-devops-extension/{measure}/{extensionId}`

Path Parameters:
- `measure` (string, REQUIRED): Specifies the type of install count to display. Possible values: `total`, `onprem`, `services`.
  Example: `total`
- `extensionId` (string, REQUIRED): The unique identifier for the Azure DevOps extension.
  Example: `swellaby.mirror-git-repository`

Query Parameters:
- `style` (string): The style of the badge. Possible values: `flat`, `flat-square`, `plastic`, `for-the-badge`, `social`. Defaults to `flat`.
  Example: `flat-square`
- `logo` (string): An icon slug from simple-icons to display on the badge. Refer to simple-icons documentation for available slugs.
  Example: `appveyor`
- `logoColor` (string): The color of the logo icon. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
  Example: `violet`
- `logoSize` (string): Controls the adaptive resizing of the logo. Use `auto` for adaptive sizing.
  Example: `auto`
- `label` (string): Overrides the default text on the left side of the badge. URL-encoding is required for spaces or special characters.
  Example: `healthiness`
- `labelColor` (string): The background color for the left part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
  Example: `abcdef`
- `color` (string): The background color for the right part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
  Example: `fedcba`
- `cacheSeconds` (string): Sets the HTTP cache lifetime for the badge in seconds. Default values are inferred per-badge.
  Example: `3600`
- `link` (string[]): Specifies the URL to navigate to when the badge is clicked. This functionality is only supported when the badge is integrated using an `<object>` HTML tag, not `<img>` or markup languages.

Example Usage:
`https://img.shields.io/visual-studio-marketplace/installs/azure-devops-extension/total/swellaby.mirror-git-repository?style=flat-square&logo=azuredevops&logoColor=white`
```

--------------------------------

### Jenkins Plugin Installs Badge API

Source: https://shields.io/badges/jenkins-plugin-installs

API documentation for generating a badge that displays the number of installs for a Jenkins plugin. It supports various customization options via query parameters.

```APIDOC
Jenkins Plugin Installs Badge:
  Generates a badge showing the install count for a Jenkins plugin.

  Endpoint:
    /jenkins-plugin-installs/{plugin}

  Path Parameters:
    plugin string — REQUIRED. The name of the Jenkins plugin.
      Example: `view-job-filters`

  Query Parameters:
    style string — The visual style of the badge.
      Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]
      Default: `flat`
      Example: `flat-square`

    logo string — Icon slug from simple-icons. Used to display an icon on the badge.
      Refer to simple-icons for available slugs.
      Example: `appveyor`

    logoColor string — The color of the logo.
      Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
      Example: `violet`

    logoSize string — Adjusts the logo size. Set to `auto` for adaptive resizing.
      Example: `auto`

    label string — Overrides the default left-hand side text.
      URL-encoding is required for spaces or special characters.
      Example: `healthiness`

    labelColor string — Background color of the left part of the badge.
      Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
      Example: `abcdef`

    color string — Background color of the right part of the badge.
      Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
      Example: `fedcba`

    cacheSeconds string — HTTP cache lifetime in seconds.
      Example: `3600`

    link string[] — Specifies the URL for the badge click action.
      Note: Only works with `<object>` HTML tags, not `<img>` or markup.

  Example Usage:
    https://img.shields.io/jenkins-plugin-installs/view-job-filters
    https://img.shields.io/jenkins-plugin-installs/view-job-filters?style=flat-square&logo=jenkins&logoColor=white
    https://img.shields.io/jenkins-plugin-installs/workflow-aggregator?label=installs&color=blue
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/open-vsx-downloads-version

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/my-get-downloads-tenant

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Wikiapiary Installs Badge API

Source: https://shields.io/badges/wikiapiary-installs

This API endpoint generates badges displaying the number of installs for a given Wikiapiary entry. It supports customization through various query parameters for styling, logos, labels, and caching.

```APIDOC
Endpoint: /wikiapiary-installs/{variant}/{name}

Description:
  Generates a badge showing the number of installs for a Wikiapiary entry.

Path Parameters:
  - variant (string, REQUIRED): Specifies the type of Wikiapiary entry. Possible values: [`extension`, `skin`, `farm`, `generator`, `host`]. Example: `extension`
  - name (string, REQUIRED): The name of the Wikiapiary entry. Case-sensitive for characters after the first. Example: `ParserFunctions`

Query Parameters:
  - style (string): The visual style of the badge. Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]. Defaults to `flat`.
  - logo (string): An icon slug from simple-icons to display on the badge. Example: `appveyor`
  - logoColor (string): The color of the logo. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Supported for simple-icons logos only. Example: `violet`
  - logoSize (string): Adjusts logo size. Use `auto` for adaptive resizing, useful for wider logos. Supported for simple-icons logos only. Example: `auto`
  - label (string): Overrides the default left-hand side text. URL-encoding is needed for spaces or special characters. Example: `healthiness`
  - labelColor (string): Background color of the left part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Example: `abcdef`
  - color (string): Background color of the right part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Example: `fedcba`
  - cacheSeconds (string): HTTP cache lifetime in seconds. Rules infer defaults, specified values below default are ignored. Example: `3600`
  - link (string[]): Specifies what clicking on the badge should do. Only works with `<object>` HTML tags, not `<img>` or markup languages.

Example Usage:
  https://img.shields.io/wikiapiary-installs/extension/ParserFunctions
  https://img.shields.io/wikiapiary-installs/extension/ParserFunctions?style=flat-square&logo=mediawiki&logoColor=white
  https://img.shields.io/wikiapiary-installs/skin/Vector?label=Installs&color=blue
```

--------------------------------

### Jenkins Plugin Installs Badge API

Source: https://shields.io/badges/jenkins-plugin-installs-version

This API endpoint generates a badge displaying the installation count and version of a Jenkins plugin. It supports customization through various query parameters for styling, logos, colors, and caching.

```APIDOC
Jenkins Plugin Installs Badge:
  /jenkins-plugin-installs/:plugin/:version

  This badge displays the installation count and version for a Jenkins plugin.

  Path Parameters:
    plugin (string) - REQUIRED. The name of the Jenkins plugin.
      Example: `view-job-filters`
    version (string) - REQUIRED. The version of the Jenkins plugin.
      Example: `1.26`

  Query Parameters:
    style (string) - Optional. The visual style of the badge.
      Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]
      Default: `flat`
      Example: `flat-square`

    logo (string) - Optional. Icon slug from simple-icons. Use the icon title from simple-icons.org or the slugs.md file in the simple-icons repository.
      Example: `appveyor`

    logoColor (string) - Optional. The color of the logo. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Only supported for simple-icons logos.
      Example: `violet`

    logoSize (string) - Optional. Makes icons adaptively resize by setting `auto`. Useful for wider logos. Supported for simple-icons logos.
      Example: `auto`

    label (string) - Optional. Overrides the default left-hand-side text. URL-encoding is needed for spaces or special characters.
      Example: `healthiness`

    labelColor (string) - Optional. Background color of the left part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
      Example: `abcdef`

    color (string) - Optional. Background color of the right part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
      Example: `fedcba`

    cacheSeconds (string) - Optional. HTTP cache lifetime in seconds. Values below the default are ignored.
      Example: `3600`

    link (string[]) - Optional. Specifies what clicking on the left/right of a badge should do. Only works with `<object>` HTML tags, not `<img>` or markup languages.

  Example Usage:
    https://img.shields.io/jenkins-plugin-installs/view-job-filters/1.26?style=flat-square&logo=jenkins&logoColor=white&label=Installs&color=blue

```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/visual-studio-marketplace-installs-azure-dev-ops-extension

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Visual Studio Marketplace Installs Badge API

Source: https://shields.io/badges/visual-studio-marketplace-installs

This API endpoint generates a badge displaying the install count for Visual Studio Marketplace extensions. It requires the extension ID and supports various customization options via query parameters.

```APIDOC
Visual Studio Marketplace Installs Badge:

This badge displays the install count for Visual Studio Marketplace extensions.

For correct results on Azure DevOps Extensions, use the Azure DevOps Installs badge instead.

Endpoint:
/visual-studio-marketplace-installs/{extensionId}

Path Parameters:
- extensionId: string (REQUIRED) - The ID of the Visual Studio Marketplace extension. Example: `ritwickdey.LiveServer`

Query Parameters:
- style: string (Optional) - The style of the badge. Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]. Defaults to `flat`.
- logo: string (Optional) - Icon slug from simple-icons. Example: `appveyor`.
- logoColor: string (Optional) - The color of the logo. Supported for simple-icons logos. Example: `violet`.
- logoSize: string (Optional) - Adaptive resizing for icons. Use `auto` for wider logos. Supported for simple-icons logos. Example: `auto`.
- label: string (Optional) - Override the default left-hand-side text. URL-encoding is needed for spaces or special characters. Example: `healthiness`.
- labelColor: string (Optional) - Background color of the left part. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Example: `abcdef`.
- color: string (Optional) - Background color of the right part. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Example: `fedcba`.
- cacheSeconds: string (Optional) - HTTP cache lifetime in seconds. Example: `3600`.
- link: string[] (Optional) - Specify what clicking on the badge should do. Works only with `<object>` HTML tags, not `<img>` or markup languages.
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/open-vsx-downloads

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/visual-studio-marketplace-downloads

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### WordPress Plugin Active Installs Badge API

Source: https://shields.io/badges/word-press-plugin-active-installs

Generates a badge displaying the active install count for a WordPress plugin. Note that the underlying API is no longer officially supported by WordPress, so functionality may be affected. Ensure the provided slug is correct for accurate results.

```APIDOC
Endpoint: /wp-plugin-active-installs/{slug}

Description:
Displays the number of active installations for a given WordPress plugin.

Limitations:
The API used by this badge is no longer supported by WordPress. Shields.io cannot guarantee future functionality.

Path Parameters:
- slug (string, REQUIRED): The unique slug of the WordPress plugin (e.g., `bbpress`).

Query Parameters:
- style (string, optional): The visual style of the badge. Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]. Defaults to `flat`.
- logo (string, optional): An icon slug from simple-icons. Example: `appveyor`. Refer to [simple-icons](https://simpleicons.org/) for available icons.
- logoColor (string, optional): The color of the logo. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Applicable to simple-icons logos.
- logoSize (string, optional): Controls logo resizing. Set to `auto` for adaptive resizing, useful for wide logos. Applicable to simple-icons logos.
- label (string, optional): Overrides the default left-hand side text. URL-encoding is required for spaces or special characters.
- labelColor (string, optional): Background color for the left part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
- color (string, optional): Background color for the right part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
- cacheSeconds (string, optional): Sets the HTTP cache lifetime in seconds. Values below the default are ignored.
- link (string[], optional): Specifies the URL for clicking the badge. Works only with `<object>` HTML tags, not `<img>` or markup languages.

Example Usage:
https://img.shields.io/wp-plugin-active-installs/bbpress?style=flat-square&logo=wordpress&logoColor=white
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/raycast-extension-downloads-count

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### WordPress Theme Active Installs Badge API

Source: https://shields.io/badges/word-press-theme-active-installs

This API endpoint generates a badge displaying the number of active installs for a given WordPress theme. It requires a theme slug and supports various customization options for appearance and behavior. Please be aware that the API it relies on is no longer officially supported by WordPress.

```APIDOC
Endpoint: /wordpress-theme-active-installs/{slug}

Description:
Generates a badge showing the active install count for a specified WordPress theme.

Path Parameters:
- slug (string, REQUIRED): The unique slug of the WordPress theme. Example: `twentyseventeen`

Query Parameters:
- style (string, optional): The visual style of the badge. Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]. Defaults to `flat`.
- logo (string, optional): An icon slug from simple-icons to display on the badge. Example: `appveyor`
- logoColor (string, optional): The color of the logo. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Example: `violet`
- logoSize (string, optional): Adjusts the logo size. Use `auto` for adaptive resizing, useful for wider logos. Example: `auto`
- label (string, optional): Overrides the default left-hand side text. URL-encoding is required for spaces or special characters. Example: `healthiness`
- labelColor (string, optional): The background color of the left part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Example: `abcdef`
- color (string, optional): The background color of the right part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Example: `fedcba`
- cacheSeconds (string, optional): Sets the HTTP cache lifetime in seconds. Values below the default are ignored. Example: `3600`
- link (string[], optional): Defines the URL that clicking on the badge should navigate to. This parameter is effective only when the badge is integrated within an `<object>` HTML tag, not `<img>` or markup languages.

Limitations:
The underlying API is no longer supported by WordPress, so badge functionality is not guaranteed.

Example Usage:
`https://img.shields.io/wordpress-theme-active-installs/twentyseventeen`
`https://img.shields.io/wordpress-theme-active-installs/twentyseventeen?style=flat-square&logo=wordpress`
```

--------------------------------

### Scoop Version Badge Generation

Source: https://shields.io/badges/scoop-version

Generates a Shields.io badge to display the version of an application installed via Scoop. It supports various customization options for styling, logos, and labels.

```APIDOC
Scoop Version Badge:
  Generates a badge displaying the version of a Scoop package.

  Base URL: https://img.shields.io/scoop-version

  Path Parameters:
    app string — REQUIRED. The name of the Scoop application.
      Example: `ngrok`

  Query Parameters:
    bucket string — The Scoop bucket containing the app. Can be a name (e.g., `extras`) or a GitHub Repo URL (e.g., `https://github.com/jewlexx/personal-scoop`).
      Example: `extras`
    style string — The visual style of the badge. Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]. Defaults to `flat`.
      Example: `flat-square`
    logo string — Icon slug from simple-icons. Use `auto` for adaptive resizing. See [simple-icons](https://simpleicons.org/) for available icons.
      Example: `scoop`
    logoColor string — The color of the logo. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
      Example: `violet`
    logoSize string — Controls logo resizing. Set to `auto` for adaptive sizing.
      Example: `auto`
    label string — Overrides the default left-hand-side text. URL-encoding is needed for spaces or special characters.
      Example: `scoop-version`
    labelColor string — Background color of the left part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
      Example: `abcdef`
    color string — Background color of the right part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
      Example: `fedcba`
    cacheSeconds string — HTTP cache lifetime in seconds. Values below the default are ignored.
      Example: `3600`
    link string[] — Specifies what clicking on the badge should do. Only works with `<object>` HTML tags, not `<img>` or markup languages.

  Example Usage:
    https://img.shields.io/scoop-version/ngrok?bucket=extras&style=flat-square&logo=scoop&label=scoop-version&color=blue
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/hex-pm-downloads

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Discourse Topics Badge API Documentation

Source: https://shields.io/badges/discourse-topics

Provides details on how to generate a Discourse Topics badge. It outlines the required and optional query parameters, their types, possible values, and usage examples.

```APIDOC
Discourse Topics Badge:
  Generates a badge displaying the number of topics for a Discourse forum.

  Query Parameters:
    server (string): **REQUIRED**. The base URL of the Discourse instance. Example: `https://meta.discourse.org`
    style (string): Optional. The visual style of the badge. Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]. Defaults to "flat". Example: `flat`
    logo (string): Optional. Icon slug from simple-icons. Refer to simple-icons.org or slugs.md for available icons. Example: `appveyor`
    logoColor (string): Optional. The color of the logo. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Supported for simple-icons logos. Example: `violet`
    logoSize (string): Optional. Sets adaptive resizing for icons. Use `auto` for wider logos like `amd`. Supported for simple-icons logos. Example: `auto`
    label (string): Optional. Overrides the default left-hand-side text. URL-encoding is needed for spaces or special characters. Example: `healthiness`
    labelColor (string): Optional. Background color of the left part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Example: `abcdef`
    color (string): Optional. Background color of the right part of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Example: `fedcba`
    cacheSeconds (string): Optional. HTTP cache lifetime in seconds. Values below the default are ignored. Example: `3600`
    link (string[]): Optional. Specifies the URL for badge clicks. Only works with `<object>` HTML tags, not `<img>` or markup languages.
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/wikiapiary-installs

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/jenkins-plugin-installs

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Liberapay Receiving Badge API

Source: https://shields.io/badges/liberapay-receiving

API documentation for generating a badge that displays the amount of money received via Liberapay. It includes path parameters, query parameters for customization, and examples.

```APIDOC
Endpoint: /Liberapay receiving

Description: Generates a badge displaying the amount of money received via Liberapay.

Path Parameters:
  entity: string - REQUIRED. The Liberapay entity name (e.g., Changaco).

Query Parameters:
  style: string - Optional. The style of the badge. Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]. Defaults to "flat". Example: `flat`
  logo: string - Optional. Icon slug from simple-icons. Example: `appveyor`
  logoColor: string - Optional. The color of the logo. Supported for simple-icons logos. Example: `violet`
  logoSize: string - Optional. Make icons adaptively resize by setting `auto`. Supported for simple-icons logos. Example: `auto`
  label: string - Optional. Override the default left-hand-side text. URL-Encoding needed for spaces or special characters. Example: `healthiness`
  labelColor: string - Optional. Background color of the left part. Example: `abcdef`
  color: string - Optional. Background color of the right part. Example: `fedcba`
  cacheSeconds: string - Optional. HTTP cache lifetime. Example: `3600`
  link: string[] - Optional. Specify what clicking on the left/right of a badge should do. Works only when integrating badge in an `<object>` HTML tag.

Example Usage:
  https://img.shields.io/liberapay/receives/Changaco?label=Donations&color=blue
  https://img.shields.io/liberapay/receives/Changaco?style=flat-square&logo=liberapay&logoColor=white
```

--------------------------------

### Shields.io Badge Generation API

Source: https://shields.io/badges/elm-package

Describes the general structure for generating badges via Shields.io, including path and query parameters. This example uses the Elm package badge endpoint.

```APIDOC
Badge Generation Endpoint:

Base URL: https://img.shields.io/badge/<PATH>

Path Parameters:
  - user: string (REQUIRED) - The user or organization name.
    Example: `elm`
  - packageName: string (REQUIRED) - The name of the package or project.
    Example: `core`

Query Parameters:
  - style: string (Optional) - The visual style of the badge.
    Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]
    Default: `flat`
    Example: `flat-square`
  - logo: string (Optional) - Icon slug from simple-icons. Refer to simple-icons.org for available slugs.
    Example: `appveyor`
  - logoColor: string (Optional) - Color of the logo. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
    Example: `violet`
  - logoSize: string (Optional) - Controls logo resizing. Use `auto` for adaptive resizing.
    Example: `auto`
  - label: string (Optional) - Custom text for the left side of the badge. URL-encoding is required for spaces/special characters.
    Example: `healthiness`
  - labelColor: string (Optional) - Background color for the left side of the badge.
    Example: `abcdef`
  - color: string (Optional) - Background color for the right side of the badge.
    Example: `fedcba`
  - cacheSeconds: string (Optional) - HTTP cache lifetime in seconds.
    Example: `3600`
  - link: string[] (Optional) - Specifies the URL for badge clicks. Works with `<object>` tags, not `<img>` or markup.

Example Badge URL (Elm Package):
https://img.shields.io/badge/elm-core-blue?style=flat-square&logo=elm
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/word-press-theme-active-installs

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Get Clojars Downloads Badge - Shields.io API

Source: https://shields.io/badges/clojars-downloads

Generates a badge displaying the download count for a Clojure library hosted on Clojars. Customize the badge's appearance using various query parameters.

```APIDOC
Clojars Downloads Badge API

This API endpoint generates a badge displaying the download count for a Clojure library hosted on Clojars.

Parameters:
  Path Parameters:
    clojar (string, REQUIRED): The name of the Clojure library on Clojars.
      Example: `prismic`

  Query Parameters:
    style (string, optional): The visual style of the badge.
      Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]
      Default: `flat`
      Example: `flat`

    logo (string, optional): Icon slug from simple-icons. You can click the icon title on simple-icons (https://simpleicons.org/) to copy the slug or they can be found in the slugs.md file (https://github.com/simple-icons/simple-icons/blob/master/slugs.md) in the simple-icons repository. Further info: /docs/logos.
      Example: `appveyor`

    logoColor (string, optional): The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.
      Example: `violet`

    logoSize (string, optional): Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.
      Example: `auto`

    label (string, optional): Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!).
      Example: `healthiness`

    labelColor (string, optional): Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).
      Example: `abcdef`

    color (string, optional): Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).
      Example: `fedcba`

    cacheSeconds (string, optional): HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).
      Example: `3600`

    link (string[], optional): Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an <object> HTML tag, but not an <img> tag or a markup language.

Example Usage:
  https://img.shields.io/clojars/v/prismic?style=flat-square
  https://img.shields.io/clojars/downloads/prismic?label=downloads&logo=clojure&logoColor=white
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/git-hub-downloads-all-assets-latest-release

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/gem-downloads-for-specified-version

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Azure DevOps REST API to Get Project ID

Source: https://shields.io/badges/azure-dev-ops-builds-branch

Retrieves the Project ID from Azure DevOps using the organization name and project name. This ID is required for generating Azure DevOps badges.

```APIDOC
API Endpoint:
https://dev.azure.com/{organization}/_apis/projects/{project_name}

Parameters:
- organization (string, REQUIRED): The Azure DevOps organization name.
- project_name (string, REQUIRED): The name of the project.

Response:
Returns a JSON object containing project details, including the 'id' property which is the PROJECT_ID.
Example Response Snippet:
{
  "id": "8cf3ec0e-d0c2-4fcd-8206-ad204f254a96",
  "name": "MyProject",
  "url": "..."
}
```

--------------------------------

### PingPong Uptime Badge API

Source: https://shields.io/badges/ping-pong-uptime-last-30-days

This section details the API for generating the PingPong uptime badge. It covers required path parameters, optional query parameters for customization, and provides examples of how to construct the badge URL.

```APIDOC
PingPong Uptime Badge:
  Generates a badge displaying PingPong uptime status.

  Base URL: https://img.shields.io/badge/dynamic/json?url=https://api.pingpong.one/v1/badge/uptime/&label=PingPong&query=response.data.uptime&color=success&style=flat

  Path Parameters:
    apiKey string — REQUIRED. Your PingPong API key.
      Example: sp_2e80bc00b6054faeb2b87e2464be337e

  Query Parameters:
    style string — Controls the badge's visual style.
      Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]
      Default: `flat`
      Example: `flat`

    logo string — Icon slug from simple-icons. Specifies an icon to display on the badge.
      Example: `appveyor`

    logoColor string — Color of the logo icon.
      Supported formats: hex, rgb, rgba, hsl, hsla, css named colors.
      Example: `violet`

    logoSize string — Adjusts the size of the logo icon.
      Use `auto` for adaptive resizing, useful for wider logos.
      Example: `auto`

    label string — Overrides the default left-hand-side text.
      URL-Encoding is required for spaces or special characters.
      Example: `healthiness`

    labelColor string — Background color of the left part of the badge.
      Supported formats: hex, rgb, rgba, hsl, hsla, css named colors.
      Example: `abcdef`

    color string — Background color of the right part of the badge.
      Supported formats: hex, rgb, rgba, hsl, hsla, css named colors.
      Example: `fedcba`

    cacheSeconds string — HTTP cache lifetime in seconds.
      Values below the default are ignored.
      Example: `3600`

    link string[] — Specifies the URL to navigate to when the badge is clicked.
      Note: This only works when integrating the badge in an `<object>` HTML tag, not `<img>` or markup languages.

  Example Usage:
    To get the PingPong uptime badge with a specific API key and custom color:
    https://img.shields.io/badge/dynamic/json?url=https://api.pingpong.one/v1/badge/uptime/sp_2e80bc00b6054faeb2b87e2464be337e&query=response.data.uptime&color=brightgreen&style=flat-square

  Related Information:
    - Simple Icons: https://simpleicons.org/
    - Simple Icons slugs.md: https://github.com/simple-icons/simple-icons/blob/master/slugs.md
    - Further logo info: /docs/logos
```

--------------------------------

### Shields.io Core Badges

Source: https://shields.io/badges/jenkins-plugin-installs-version

Provides basic static badges and links to core documentation for Shields.io.

```APIDOC
Shields.io Core Badges:
  - /badges/static-badge
    - Description: Provides static badges with customizable text and color.
    - Parameters:
      - text: The text to display on the badge.
      - color: The color of the badge (e.g., 'brightgreen', 'yellow', 'red').
    - Example: /badges/static-badge?text=Hello&color=blue
```

--------------------------------

### Get Eclipse Marketplace Version Badge

Source: https://shields.io/badges/eclipse-marketplace-version

Generates a version badge for an Eclipse Marketplace package. Requires the package name and supports various query parameters for customization like style, logo, colors, and labels.

```APIDOC
Endpoint: /badges/eclipse-marketplace-version

Description: Generates a version badge for a specified Eclipse Marketplace package.

Path Parameters:
  name (string, REQUIRED): The name of the Eclipse Marketplace package. Example: `notepad4e`

Query Parameters:
  style (string, optional): The visual style of the badge. Possible values: [`flat`, `flat-square`, `plastic`, `for-the-badge`, `social`]. Defaults to `flat`.
    Example: `flat`
  logo (string, optional): The slug of an icon from simple-icons to display on the badge. Refer to simple-icons for available slugs.
    Example: `appveyor`
  logoColor (string, optional): The color of the logo. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors. Only applicable for simple-icons logos.
    Example: `violet`
  logoSize (string, optional): Controls logo resizing. Set to `auto` for adaptive resizing, useful for wider logos. Only applicable for simple-icons logos.
    Example: `auto`
  label (string, optional): Overrides the default text on the left side of the badge. URL-encoding is required for spaces or special characters.
    Example: `healthiness`
  labelColor (string, optional): The background color of the left side of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
    Example: `abcdef`
  color (string, optional): The background color of the right side of the badge. Supports hex, rgb, rgba, hsl, hsla, and CSS named colors.
    Example: `fedcba`
  cacheSeconds (string, optional): Specifies the HTTP cache lifetime in seconds. Values below the default are ignored.
    Example: `3600`
  link (string[], optional): Defines the URL that the badge should link to when integrated using an HTML `<object>` tag.
    Example: `["https://example.com"]`

Example Usage:
  https://img.shields.io/badge/eclipse-marketplace-version-notepad4e?style=flat-square&logo=eclipse&logoColor=white
```