---
sidebar_position: 1
title: Introduction
---

# Badge API

<div className="flex justify-center"><img src="/assets/badges/badges-stacked.svg" alt="Badges" className="h-32"/></div>

The Badge API is a service scanning repositories for specific criteria and generating badges based on the results. 
The badges are displayed in the [OpenCode software catalog](https://opencode.de/en/software) and indicate the status of the repository in terms of **security**, **maintenance**, and **reuse**.

You can interact with the Badge API by submitting a repository URL and receiving a badge based on the criteria that the repository meets. The API will 
provide you a detailed explanation of the result too. 

## Concepts & Criteria

You can find details about the concepts and criteria for each badge in the [Concepts](/concepts) section.

## RESTful API

The Badge API is a RESTful API. A documentation of the API can be found in the [API](/api-docs) section.