Quickstart

Prerequisites

Before you begin, you’ll need:

Create an Account

Get Your API Key

Open Dashboard > Account and generate a new API key.

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

The OpenAPI reference includes an interactive playground where you can:

enter your API key in the authorization section
set request parameters
send the request and inspect the live response

Try V2 Breach Search

Learn the workflow first, then use OpenAPI for the exact request shape

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"

import os
import requests

API_KEY = os.environ["OATHNET_API_KEY"]

response = requests.get(
    "https://oathnet.org/api/service/v2/breach/search",
    params={"q": "test@example.com"},
    headers={"x-api-key": API_KEY},
)

payload = response.json()

if payload["success"]:
    print(f"Found {payload['data']['meta']['total']} results")
    for item in payload["data"]["items"]:
        print(f"- {item.get('email')} in {item.get('dbname', 'unknown source')}")
else:
    print(payload["message"])

const API_KEY = process.env.OATHNET_API_KEY;

const response = await fetch(
  "https://oathnet.org/api/service/v2/breach/search?q=test@example.com",
  {
    headers: { "x-api-key": API_KEY },
  }
);

const payload = await response.json();

if (payload.success) {
  console.log(`Found ${payload.data.meta.total} results`);
  payload.data.items.forEach((item) => {
    console.log(`- ${item.email} in ${item.dbname || "unknown source"}`);
  });
} else {
  console.error(payload.message);
}

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "os"
)

func main() {
    apiKey := os.Getenv("OATHNET_API_KEY")

    req, _ := http.NewRequest(
        "GET",
        "https://oathnet.org/api/service/v2/breach/search?q=test@example.com",
        nil,
    )
    req.Header.Add("x-api-key", apiKey)

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var payload map[string]any
    _ = json.NewDecoder(resp.Body).Decode(&payload)

    if payload["success"].(bool) {
        data := payload["data"].(map[string]any)
        meta := data["meta"].(map[string]any)
        fmt.Printf("Found %.0f results\n", meta["total"])
    }
}

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

Field	Description
`success`	`true` if the request succeeded
`message`	Human-readable status message
`data.items`	Array of breach records for this page
`data.meta.total`	Total number of matching records
`data.meta.count`	Number of records in this response
`data.next_cursor`	Cursor for the next page when available

Search Sessions

Search-session and v2 search endpoints can participate in the same 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},
)

const sessionRes = await fetch("https://oathnet.org/api/service/search/init", {
  method: "POST",
  headers: {
    "x-api-key": API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ query: "user@company.com" }),
});

const sessionPayload = await sessionRes.json();
const searchId = sessionPayload.data.session.id;

const breachRes = await fetch(
  `https://oathnet.org/api/service/v2/breach/search?q=user@company.com&search_id=${searchId}`,
  { headers: { "x-api-key": API_KEY } }
);

Common Query Types

OathNet automatically detects many common query types from the q parameter:

Query	Detected Type
`user@example.com`	Email
`example.com`	Domain
`192.168.1.1`	IP
`123456789012345678`	Discord ID
`johndoe`	Username

Getting Started

Search Guides

OSINT And Utility Guides

Integration Guides

Resources

Prerequisites

Try the API Playground

Try V2 Breach Search

Your First API Call

Example Response

Understanding the Response

Search Sessions

Common Query Types

Next Steps

API Reference

Scanners Guide

​Prerequisites

​Try the API Playground

Try V2 Breach Search

​Your First API Call

​Example Response

​Understanding the Response

​Search Sessions

​Common Query Types

​Next Steps

API Reference

Scanners Guide

Prerequisites

Try the API Playground

Your First API Call

Example Response

Understanding the Response

Search Sessions

Common Query Types

Next Steps