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
Navigate to Dashboard > Account and generate a new API key.
3
Save Your Key
Copy your API key and store it securely. You won’t be able to see it again.
Try the API Playground
The fastest way to explore the API is using the interactive playground. Each endpoint page has a built-in playground where you can:- Enter your API key in the Authorization section
- Set parameters for the request
- Click Send to see live responses
Try Breach Search Playground
Test the breach search API with live requests
Your First API Call
Let’s search the breach database for a test email:Response
Understanding the Response
| Field | Description |
|---|---|
success | true if the request succeeded, false otherwise |
message | Human-readable status message |
data.results | Array of matching records |
data.results_found | Total number of matching records |
data.results_shown | Number of results in this response |
data.nextCursorMark | Pagination cursor for next page (null if no more) |
lookups_left | Your remaining daily lookup quota |
search_session | Session info for grouping related queries |
Using Search Sessions
For better quota management, initialize a search session before making multiple queries:Common Query Types
OathNet automatically detects your query type:| Query | Detected Type | Example |
|---|---|---|
email | [email protected] | |
| Domain | domain | example.com |
| Username | username | john_doe |
| IP Address | ip | 192.168.1.1 |
| Discord ID | discord_id | 123456789012345678 |
| Steam ID | steam_id | 76561198012345678 |
Next Steps
Authentication
Learn about API key security and best practices
Search Sessions
Optimize quota usage with search sessions
Pagination
Handle large result sets with cursor pagination
API Reference
Explore all available endpoints
Congratulations! You’ve made your first OathNet API call. Explore the API Reference to discover all available endpoints.