Skip to main content

Quickstart

This guide walks through the current DarkRecon flow: submit either keywords or domain, store the returned scan_id, and retrieve the raw stored result.
Use keywords in the request body. Older docs used queries, which no longer matches the live API.

1) Set your API key

2) Start a keyword scan

Example response:

3) Start a domain scan

Domain scans can include discovered_emails in the initial response when the service enumerates breached addresses before running the follow-on scan.

4) Retrieve full scan results

Example stored result:

5) Parse the result safely

  • total_breaches is the number of matched breach sources, not the total number of rows in all Data arrays.
  • results is keyed by breach database name.
  • Every source exposes InfoLeak, NumOfResults, and Data.
  • Records inside Data are source-specific and can have different field names across breaches.
  • Password-like values are masked in the API output.

Next steps

  • /darkrecon/api/start-scan
  • /darkrecon/api/get-scan-results
  • /darkrecon/schemas/scan-request
  • /darkrecon/schemas/scan-result
  • /darkrecon/schemas/http-validation-error