Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.oathnet.org/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

All requests require the x-api-key header. 
curl -H "x-api-key: YOUR_API_KEY" https://oathnet.org/api/service/v2/health

​
Search Session

curl -X POST "https://oathnet.org/api/service/search/init" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "user@example.com"}'
Prefer /service/v2/breach/search for new integrations. The older /service/search-breach endpoint is compatibility-only.
curl -G "https://oathnet.org/api/service/v2/breach/search" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "q=user@example.com" \
  --data-urlencode "dbname[]=linkedin_2012"

​
V2 AI Filter

curl -X POST "https://oathnet.org/api/service/v2/ai/filter" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "index": "breach",
    "query": "US banking users with gmail addresses"
  }'

​
V2 Breach Autocomplete

curl -G "https://oathnet.org/api/service/v2/breach/autocomplete/dbnames" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "q=link"

curl -G "https://oathnet.org/api/service/v2/stealer/search" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "q=user@example.com" \
  --data-urlencode "has_log_id=true" \
  --data-urlencode "domain[]=google.com"

​
V2 Victims

​
Search Victims

curl -G "https://oathnet.org/api/service/v2/victims/search" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "q=user@example.com" \
  --data-urlencode "total_docs_min=10"

​
Get Manifest

curl -X GET "https://oathnet.org/api/service/v2/victims/vic_xxx_user_yyy" \
  -H "x-api-key: YOUR_API_KEY"

​
Get File Content

curl -X GET "https://oathnet.org/api/service/v2/victims/vic_xxx_user_yyy/files/file_id" \
  -H "x-api-key: YOUR_API_KEY"

​
Download Archive

curl -X GET "https://oathnet.org/api/service/v2/victims/vic_xxx_user_yyy/archive" \
  -H "x-api-key: YOUR_API_KEY" \
  -o victim_archive.zip

​
Create Job

curl -X POST "https://oathnet.org/api/service/v2/file-search" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "expression": "api[_-]?key",
    "search_mode": "regex",
    "log_ids": ["vic_xxx_user_yyy"],
    "include_matches": true,
    "context_lines": 2,
    "max_matches": 100
  }'

​
Poll Job

curl -X GET "https://oathnet.org/api/service/v2/file-search/JOB_ID" \
  -H "x-api-key: YOUR_API_KEY"

​
V2 Exports

​
Create Export

curl -X POST "https://oathnet.org/api/service/v2/exports" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "breach",
    "format": "csv",
    "limit": 10000,
    "fields": ["email", "password", "dbname"],
    "search": {
      "query": "user@example.com"
    }
  }'

​
Poll Export

curl -X GET "https://oathnet.org/api/service/v2/exports/JOB_ID" \
  -H "x-api-key: YOUR_API_KEY"

​
Download Export

curl -X GET "https://oathnet.org/api/service/v2/exports/JOB_ID/download" \
  -H "x-api-key: YOUR_API_KEY" \
  -o export.csv

​
Scanners API

​
Check Quota

curl -X GET "https://oathnet.org/api/scanners/quota" \
  -H "x-api-key: YOUR_API_KEY"

​
List Scanners

curl -X GET "https://oathnet.org/api/scanners" \
  -H "x-api-key: YOUR_API_KEY"

​
Create Scanner

curl -X POST "https://oathnet.org/api/scanners/create" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Credential Exposure Monitor",
    "scanner_type": "breach",
    "query_config": {
      "q": "user@example.com"
    },
    "notification_type": "email",
    "notify_on_zero_results": false
  }'

​
Legacy Utility

curl -G "https://oathnet.org/api/service/dbname-autocomplete" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "q=link"

​
Tips

​
Pretty-print JSON

curl ... | jq .

​
Save A File

curl ... -o output.json

​
Reuse Shell Variables

API_KEY="your_api_key"
QUERY="user@example.com"

curl -G "https://oathnet.org/api/service/v2/breach/search" \
  -H "x-api-key: ${API_KEY}" \
  --data-urlencode "q=${QUERY}"

SDK Overview

Back to SDK overview

API Reference

Full API documentation