# Markdown Badge API

The Markdown Badge API provided by Runway enables teams to display badges on their repositories, showcasing either the number of completed releases (release\_count) or the live release version (live\_release) of their app. These badges offer a dynamic way to present project status directly on markdown files, such as READMEs, and automatically link back to Runway for additional insights.

## **API Endpoint**

To access the Markdown Badge API, use the following URL format:

`https://app.runway.team/api/markdownBadge?app_id={APP_ID}&style={STYLE}&badge_type={TYPE}`

### **Parameters**

* **`app_id` (required)**: The unique identifier of your team’s app in Runway. You can find your app’s app\_id by going to App settings > General > App identifier on the Runway dashboard
* **`style`**: Defines the appearance of the badge. Options include:
  * `flat` (default)

<figure><img src="https://727226624-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MjFmyReUsbJqDjHEAlW%2Fuploads%2FmXYqmv9x1a2mWLPrnRs8%2Fflat.png?alt=media&#x26;token=a0afc873-756c-4ffa-956d-92893b9be94f" alt=""><figcaption></figcaption></figure>

* `flat-square`

<figure><img src="https://727226624-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MjFmyReUsbJqDjHEAlW%2Fuploads%2F1iCD7fBIuzZLZSM1aNso%2Fflat-square.png?alt=media&#x26;token=1f6fad93-68a2-4528-802c-954630e33c91" alt=""><figcaption></figcaption></figure>

* `plastic`

<figure><img src="https://727226624-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MjFmyReUsbJqDjHEAlW%2Fuploads%2Fc8amw5Q6JtDjkEFHdEM8%2Fplastic.png?alt=media&#x26;token=a3884c9d-2966-4bcf-a698-902c104d067f" alt=""><figcaption></figcaption></figure>

* `for-the-badge`

<figure><img src="https://727226624-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MjFmyReUsbJqDjHEAlW%2Fuploads%2FIuT5mCWJW5quxGW1wlYZ%2Ffor-the-badge.png?alt=media&#x26;token=0754f467-3c33-40c1-b21f-3bbda9916a0f" alt=""><figcaption></figcaption></figure>

* `social`

<figure><img src="https://727226624-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MjFmyReUsbJqDjHEAlW%2Fuploads%2FJeYYTcBTMUVW9p3nHh7G%2Fsocial.png?alt=media&#x26;token=4143f147-2298-4c6b-8a5e-3e442a2edf7b" alt=""><figcaption></figcaption></figure>

* `badge_type`: Specifies the type of information the badge displays. Options are:
  * `release_count` (default): Shows the number of completed releases on Runway
  * `live_release`: Displays the live release version number

**Usage Example**

To create a badge displaying the latest release version of your app in a flat style, your URL might look like this:<br>

`https://app.runway.team/api/markdownBadge?app_id=12345&style=flat&badge_type=live_release`

This URL can be embedded in markdown files to display the badge.

### **Embedding in Markdown**

To embed the badge in your markdown file, use the following syntax:

`![Badge](https://app.runway.team/api/markdownBadge?app_id={APP_ID}&style={STYLE}&badge_type={TYPE})`

Replace `{APP_ID}`, `{STYLE}`, and `{TYPE}` with your app's details.\ <br>

<br>