FAQ

Account & Access

Where do I get my API key?

Do all endpoints use the same API key auth?

Yes. Public customer-facing endpoints use the x-api-key header.

Are some endpoints plan-gated?

Yes. File search, exports, bulk search, archive downloads, AI filter creation, and scanner quotas depend on your plan.

Which search endpoints should I use?

Prefer /service/v2/* for new search integrations. Use /service/* for search sessions and OSINT point lookups.

What is the difference between stealer search and victims search?

Stealer search returns credential-style records. Victims search returns compromised-device summaries keyed by log_id.

How do I inspect files from a victim?

Search for a victim, fetch the victim manifest, then request a specific file or the archive download.

What response format does the API use?

Successful responses use a few different shapes:

{
  "success": true,
  "message": "Description",
  "data": { "...": "..." }
}

Search endpoints and most point lookups return the envelope above.Some v2 endpoints return raw JSON instead, including:

Download endpoints return raw text or binary streams.

Can I use the API from a browser?

Technically yes, but it is not recommended. API keys should stay on a trusted server.

How does query detection work?

The q parameter automatically detects common types such as email, domain, IP, Discord ID, and username where supported by the endpoint.

For additional questions, contact support@oathnet.org or join the Discord.