BrokerBlitzer
Documentation

The contract.

This reference is generated from the OpenAPI documents the services are built against, so it cannot describe a shape the API does not serve. The full integration guide is served by the API itself, to your key.

Free tier

Synchronous scan

  • POST /v1/exposure/scan Run a free exposure scan for a subject
  • GET /health Liveness (does not touch Redis)
  • GET /ready Readiness (checks Redis)
Premium tier

Jobs, results and webhooks

  • POST /v1/premium/jobs Create a premium job (deep scan, optionally + removal) · bearer key
  • GET /v1/premium/jobs List the calling key's jobs (operational) · bearer key
  • GET /v1/premium/credits Prepaid credit balance and remaining daily quota · bearer key
  • GET /v1/premium/jobs/{jobId} Get a job (status + result when done) · bearer key
  • DELETE /v1/premium/jobs/{jobId} Cancel a job · bearer key
  • GET /v1/premium/openapi.yaml This document · bearer key
  • GET /health Liveness (does not touch Redis/Postgres)
  • GET /ready Readiness (checks Redis + Postgres)

The full guide

The complete integration guide, including request and response schemas, error taxonomy, webhook contract and the removal state model, is served by the API to an authenticated key:

Fetch the guide
curl -H "Authorization: Bearer $KEY" \
     https://api.brokerblitzer.com/v1/premium/docs

curl -H "Authorization: Bearer $KEY" \
     https://api.brokerblitzer.com/v1/premium/docs.json    # version + changelog

It is served from the same build as the API, so the guide can never describe a version you are not talking to. docs.json reports the version and a changelog, so you can detect a change without diffing prose.

Contract versions in this build: Free 1.0.0 · Premium 1.2.0.

Request a key