BreachSquare API

Developer docs

All data access goes through BreachSquare. Authenticate with your session (browser) or an API key on Operator/Desk plans. Every billed call spends credits server-side — guests get 2 free searches.

Auth

Browser: email/password, Google, or Discord
API: Authorization: Bearer bs_… (coming with Operator/Desk keys)

Example

POST /api/v1/search
Content-Type: application/json

{
  "q": "test@example.com",
  "mode": "smart"
}

// 200
{
  "ok": true,
  "data": { "...": "..." },
  "credits_remaining": 49
}

// 401 / 402
{
  "ok": false,
  "code": "LOGIN_REQUIRED" | "PAYWALL" | "RATE_LIMITED",
  "error": "..."
}

POST /api/v1/searchSmart / breach / stealer search
POST /api/v1/enrichIdentity & network enrichment
POST /api/v1/investigateDeep investigate (Starter+)
POST /api/v1/monitorsMonitoring tools (Operator+)
POST /api/v1/jobsBulk / export jobs (Operator+)
GET /api/v1/meProfile & credit balance

Credit packs live on Pricing. Try searches in the dashboard.