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.

​
Prerequisites

Before you begin, you’ll need:
1

Create an Account

Sign up at oathnet.org if you haven’t already.
2

Get Your API Key

Go to Dashboard > Account and generate a new API key.
3

Store It Securely

Keep the key in an environment variable or secret manager.
Never commit your API key to version control or ship it in client-side code.

​
Try the API Playground

Each endpoint page includes an interactive playground where you can:
  1. enter your API key in the authorization section
  2. set request parameters
  3. send the request and inspect the live response

Try V2 Breach Search

Open the current breach search endpoint in the playground

​
Your First API Call

Start with the current breach search endpoint: 
curl -X GET "https://oathnet.org/api/service/v2/breach/search?q=test@example.com" \
  -H "x-api-key: YOUR_API_KEY"

​
Example Response

{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "items": [
      {
        "id": "rec_01",
        "email": "test@example.com",
        "username": "testuser",
        "password": "p@ssw0rd123",
        "dbname": "example_breach_2023",
        "indexed_at": "2026-04-18T12:00:00Z"
      }
    ],
    "meta": {
      "count": 1,
      "total": 1,
      "took_ms": 4,
      "has_more": false,
      "total_pages": 1
    },
    "next_cursor": null
  }
}

​
Understanding the Response

FieldDescription
successtrue if the request succeeded
messageHuman-readable status message
data.itemsArray of breach records for this page
data.meta.totalTotal number of matching records
data.meta.countNumber of records in this response
data.next_cursorCursor for the next page when available

​
Search Sessions

Legacy and v2 search endpoints can still participate in the search-session flow when you want related lookups grouped under a shared search_id. 
import os
import requests

API_KEY = os.environ["OATHNET_API_KEY"]

session_response = requests.post(
    "https://oathnet.org/api/service/search/init",
    json={"query": "user@company.com"},
    headers={"x-api-key": API_KEY},
)
session_id = session_response.json()["data"]["session"]["id"]

breach_response = requests.get(
    "https://oathnet.org/api/service/v2/breach/search",
    params={"q": "user@company.com", "search_id": session_id},
    headers={"x-api-key": API_KEY},
)

stealer_response = requests.get(
    "https://oathnet.org/api/service/v2/stealer/search",
    params={"q": "user@company.com", "search_id": session_id},
    headers={"x-api-key": API_KEY},
)

​
Common Query Types

OathNet automatically detects many common query types from the q parameter:
QueryDetected Type
user@example.comEmail
example.comDomain
192.168.1.1IP
123456789012345678Discord ID
johndoeUsername

​
Next Steps

API Reference

Explore the full endpoint reference

Scanners Guide

Learn how to monitor new results automatically