> ## Documentation Index
> Fetch the complete documentation index at: https://docs.custoden.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Custoden API

> A free, public API for checking open-source dependencies and CI pipelines before they reach your environment. No account or API key.

```bash theme={null}
curl https://api.custoden.com/v1/packages/npm/expres
```

```json theme={null}
{
  "ecosystem": "npm",
  "name": "expres",
  "version": "0.0.5",
  "verdict": "review",
  "risk": "medium",
  "findings": [
    {
      "id": "possible-typosquat",
      "severity": "medium",
      "title": "Name resembles popular package \"express\"",
      "detail": "\"expres\" differs from the widely used \"express\" by one or two characters. Confirm you meant this package."
    }
  ]
}
```

## Endpoints

> [card] [Check a package](https://docs.custoden.com/api-reference/check-a-package.md)
>
> Malware, install-time code, typosquatting and known vulnerabilities for one npm or PyPI package.

> [card] [Check multiple packages](https://docs.custoden.com/api-reference/check-multiple-packages.md)
>
> Up to 10 packages in one request.

> [card] [Analyze a workflow](https://docs.custoden.com/api-reference/analyze-a-workflow.md)
>
> Secret theft, script injection, risky actions and permission issues in a GitHub Actions workflow.

> [card] [Scan recent runs](https://docs.custoden.com/api-reference/scan-recent-runs.md)
>
> The workflows that actually ran, including ones later reverted or force-pushed away.

## Base URL

```
https://api.custoden.com
```

All responses are JSON. Requests with a body accept JSON, and the workflow endpoint also accepts raw YAML.

## Data sources

* Package metadata and published artifacts from the npm registry and PyPI
* Vulnerability and malware advisories from [OSV](https://osv.dev), which includes the GitHub Advisory Database and the OpenSSF Malicious Packages dataset
* Download counts from the npm downloads API and [pypistats.org](https://pypistats.org)
* Workflow runs and repository metadata from the GitHub API
* Indicators and techniques from published campaign research. See [Threat intelligence](https://docs.custoden.com/reference/threat-intelligence.md)

Workflows and package contents are analyzed in memory and not stored.

> [card] [Quickstart](https://docs.custoden.com/getting-started/quickstart.md)

> [card] [Rate limits](https://docs.custoden.com/getting-started/rate-limits.md)

> [card] [OpenAPI spec](https://docs.custoden.com/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.