> ## 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.

# Welcome to OathNet

> Learn about OathNet's data intelligence platform and what you can build with our API

## What is OathNet?

OathNet is a data intelligence platform that provides programmatic access to breach data, stealer logs, victim files, and OSINT enrichment. Teams use the API to:

* detect compromised credentials before they are abused
* investigate incidents with breach and stealer context
* monitor new exposure with automated scanners
* build custom security workflows on top of a single API surface

## Platform Capabilities

<CardGroup cols={2}>
  <Card title="Breach Database" icon="database">
    Search large breach datasets by email, domain, username, password, phone, DB name, and more.
  </Card>

  <Card title="Stealer Logs" icon="file-code">
    Search credential records, pivot into victim manifests, inspect files, and download archives.
  </Card>

  <Card title="Scanners" icon="radar">
    Monitor newly indexed stealer or breach data and deliver alerts to email, Discord, or custom webhooks.
  </Card>

  <Card title="OSINT Lookups" icon="magnifying-glass">
    Run point lookups for Discord, Steam, Xbox, Roblox, Google, Minecraft, email presence, and IP intelligence.
  </Card>
</CardGroup>

## API Architecture

OathNet exposes three customer-facing API families:

```text theme={null}
https://oathnet.org/api/service/*
https://oathnet.org/api/service/v2/*
https://oathnet.org/api/scanners/*
```

### Base URL

All API requests are made to:

```bash theme={null}
https://oathnet.org/api
```

### Authentication

Every request requires an API key passed in the `x-api-key` header:

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" https://oathnet.org/api/service/v2/breach/search?q=test@example.com
```

### Response Patterns

Successful responses are not all shaped the same way anymore:

* many search and point-lookup endpoints return `success`, `message`, and `data`
* many v2 utility and job endpoints return raw JSON payloads
* download endpoints return raw text or binary streams

Errors are generally normalized into a standard error envelope.

## Service Categories

| Category                    | Surface         | Description                                                                              |
| --------------------------- | --------------- | ---------------------------------------------------------------------------------------- |
| **Search Sessions & OSINT** | `/service/*`    | Search sessions, original search routes, and point lookups                               |
| **Current Search & Jobs**   | `/service/v2/*` | Breach, stealer, victims, autocomplete, AI filter, file search, exports, and bulk search |
| **Scanners**                | `/scanners/*`   | Automated monitoring, delivery tests, webhook security, and run history                  |

## Interactive Playground

The OpenAPI reference includes an interactive playground where you can test requests directly in your browser.

<Card title="Explore API Endpoints" icon="play" href="/api-reference/overview">
  Start with the guides, then use OpenAPI for exact request details
</Card>

## Use Cases

<AccordionGroup>
  <Accordion title="Credential Monitoring" icon="shield-check">
    Search current breach or stealer data for domains, emails, usernames, or passwords, then move to scanners when you need recurring monitoring.
  </Accordion>

  <Accordion title="Incident Response" icon="siren">
    Pivot from a stealer credential hit into the victim manifest, inspect captured files, and download the archive when deeper review is needed.
  </Accordion>

  <Accordion title="OSINT Investigation" icon="user-secret">
    Enrich identities and accounts with Discord, Roblox, Steam, Xbox, Google, email, and IP lookups.
  </Accordion>

  <Accordion title="Automation & Monitoring" icon="radar">
    Use exports, bulk search, file search, and scanner webhooks to automate enrichment and alerting pipelines.
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Get Your API Key" icon="key" href="https://oathnet.org/dashboard?tab=account">
    Generate an API key from the dashboard
  </Card>

  <Card title="Quickstart Guide" icon="rocket" href="/introduction/quickstart">
    Make your first API call in under 5 minutes
  </Card>
</CardGroup>