Skip to content

Quick Start

Get your first CVE intelligence response in under 5 minutes.

Step 1 - Create an Account

Sign up at breachspider.com/signup. Free tier includes CVE search (10 results per page) with no credit card required.

Step 2 - Generate an API Key

API keys require Professional tier or above. Navigate to Integrations > API Keys > Generate New Key.

Copy the key immediately - it is shown only once.

Your key looks like this:

bs_live_a3f7c291d8e4b6f2c8d9e1a0b4c7d3e6

Step 3 - Make Your First Request

curl -H "Authorization: Bearer bs_live_your_key_here" \
  "https://breachspider.com/api/v1/cves/CVE-2025-32433"

Step 4 - Check the Health Endpoint

For a no-auth liveness check, use the public ping endpoint:

curl https://breachspider.com/api/v1/health/ping
# {"ping": "pong"}

The full health payload below requires an authenticated session. You can also open breachspider.com/api/v1/health in a browser for the live status page.

curl -H "Accept: application/json" -b "bs_session=..." \
  https://breachspider.com/api/v1/health

Response:

{
  "api": {
    "version": "1.0.0",
    "request_id": "bs-req-384e74ed2b69",
    "timestamp": "2026-06-07T13:34:43.881825Z",
    "processing_ms": 1
  },
  "data": {
    "status": "healthy",
    "database": "connected",
    "counts": {
      "total_cves": 360581,
      "pending_enrichment": 0
    }
  }
}

Step 5 - Search CVEs by Vendor

curl -H "Authorization: Bearer bs_live_your_key_here" \
  "https://breachspider.com/api/v1/cves/vendor/siemens?per_page=5"

Next Steps