Getting Started

Vulnpatch provides a REST API for querying security vulnerabilities across multiple sources and ecosystems. This guide will help you get started with the API.

Base URL

All API endpoints are available at:

https://api.vulnpatch.dev/api/v1/

Quick Start

Check API Status

curl https://api.vulnpatch.dev/api/v1/stats

Query Vulnerabilities for a Package

# Get OSV vulnerabilities for curl
curl https://api.vulnpatch.dev/api/v1/osv/curl

# Get OSV vulnerabilities with ecosystem filter
curl "https://api.vulnpatch.dev/api/v1/osv/express?ecosystem=npm"

Get Tracked CVE Issues

curl https://api.vulnpatch.dev/api/v1/issues

Response Format

All API responses follow a consistent JSON format:

{
  "success": true,
  "data": { ... },
  "timestamp": "2024-01-15T12:00:00.000Z"
}

Error responses include an error message:

{
  "success": false,
  "error": "Error description"
}

Next Steps

• Authentication - Learn about API authentication
• Rate Limits - Understand rate limiting
• API Reference - Full API documentation