V2 Breach

Search Breach Records

Current breach search surface for new integrations. Supports flat filters plus structured filter and filter_id flows. The same route also accepts POST when you want to send filter or filter_id in the JSON request body instead of the query string.

Dashboard basic filters:

Identity and account: email, username, full_name, first_name, last_name, phone, ip.
Location and source: country, city, dbname.

API flat filters:

Core fields: email, email_domain, domain, username, password, password_hash, ip, phone, first_name, last_name, full_name, city, country, state, postal_code, dbname, discord_id, iban, ssn, gender.
Date of birth range: date_birth_from, date_birth_to.
Alias families: name, address, discord, social, financial, and gaming.

Advanced alias fields:

name: full_name, first_name, last_name, middle_name, display_name, guardian_name, child_firstname, child_lastname.
password: password, password_hash.
phone: phone_national, phone_national2, phone_number, phone_number2, phone_number3, mobile_phone, guardian_phone, phone, phones, cellphone, mobilephone, login_phone, bill_phone, company_phone, workphone, telefone_1, telefone_2, username_phone.
ip: ip, ip_registration.
address: address_street, address_street2, address2.
discord: discordid, discord, discord_user, discord_displayname, discord_id, discord_tag.
social: fb_id, facebook, facebook_id, instagram, twitter, x, tiktok, snapchat, telegram, signal, reddit, youtube, twitch, spotify, soundcloud, pinterest, threads, onlyfans, kick, patreon, github, gitlab, lastfm, applemusic, linkedin, linkedin_id, vk_id, member_url, plus the Discord fields listed above.
financial: iban, bic, ssn, license, license2, passport, passport_id, passport_no, passport_number, national_id, identity_number, id_number, tax_id, cpf, cnpj, snils, inn, rfc, nric, personalausweis, pan_id, pan_no, pan_number, drivers_license, bank_name, paypal, cashapp, bitcoin, eth, ltc, monero, solana, xrp, wallet, crypto_wallet, wallet_address.
gaming: steam, steam_id, xbl, live, psn, psn_id, roblox, roblox_username, robloxusername, bnet, epic, namemc, fivem, player_id.

The advanced field picker can also use indexed breach fields discovered by the field autocomplete API. Database autocomplete feeds the dbname filter.

GET

https://oathnet.org/api

service

breach

Search Breach Records

curl --request GET \
  --url https://oathnet.org/api/service/v2/breach/search \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://oathnet.org/api/service/v2/breach/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://oathnet.org/api/service/v2/breach/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://oathnet.org/api/service/v2/breach/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://oathnet.org/api/service/v2/breach/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "data": {
    "items": [
      {
        "id": "<string>",
        "email": "<string>",
        "email_domain": "<string>",
        "username": "<string>",
        "password": "<string>",
        "password_hash": "<string>",
        "salt": "<string>",
        "full_name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>",
        "display_name": "<string>",
        "phone_number": "<string>",
        "phone_national": "<string>",
        "address_street": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "date_birth": "<string>",
        "age": 123,
        "created_at": "<string>",
        "last_login": "<string>",
        "indexed_at": "2023-11-07T05:31:56Z",
        "ip": "<string>",
        "discordid": "<string>",
        "instagram": "<string>",
        "linkedin": "<string>",
        "iban": "<string>",
        "ssn": "<string>",
        "dbname": "<string>",
        "gender": "<string>",
        "language": "<string>",
        "bio": "<string>",
        "location": "<string>",
        "extra": {}
      }
    ],
    "meta": {
      "count": 123,
      "total": 123,
      "took_ms": 123,
      "has_more": true,
      "total_pages": 123,
      "max_score": 123,
      "filter_id": "0123456789abcdef01234567"
    },
    "dbname_info": {},
    "next_cursor": "<string>",
    "_meta": {}
  }
}

Authorizations

x-api-key

string

header

required

API key for authentication (lowercase header name)

Query Parameters

string

cursor

string

page_size

integer

sort

string

from

string<date-time>

date_field

enum<string>

Available options:

indexed_at,

pwned_at

wildcard

boolean

logic

enum<string>

Available options:

and,

or

filter

string

JSON-encoded structured filter tree.

Use leaf nodes with field, operator, and value, or compound nodes with and / or. If you would rather send the filter as a real JSON object, use POST on the same /search route. See /guides/structured-filters for the full grammar, operators, limits, and examples.

filter_id

string

24-character transient filter context ID returned by POST /service/v2/ai/filter or a previous search response.

24-character transient filter context ID.

Pattern: ^[0-9a-fA-F]{24}$

Example:

"0123456789abcdef01234567"

email[]

string[]

email_domain[]

string[]

domain[]

string[]

username[]

string[]

password[]

string[]

password_hash[]

string[]

ip[]

string[]

phone[]

string[]

first_name[]

string[]

last_name[]

string[]

full_name[]

string[]

city[]

string[]

country[]

string[]

state[]

string[]

postal_code[]

string[]

dbname[]

string[]

discord_id[]

string[]

iban[]

string[]

ssn[]

string[]

date_birth_from

string

date_birth_to

string

name[]

string[]

Alias for full-name style breach fields.

gender[]

string[]

address[]

string[]

Alias for address-like breach fields.

discord[]

string[]

Alias for Discord identifiers found in breach rows.

Generic social identifier field family.

financial[]

string[]

Generic payment or financial identifier field family.

gaming[]

string[]

Generic gaming-platform identifier field family.

fields[]

string[]

Response field whitelist.

search_id

string

Search session ID from POST /service/search/init.

Response

200 - application/json

Breach search response

success

boolean

message

string

data

object

Show child attributes

Search Breach Records

curl --request GET \
  --url https://oathnet.org/api/service/v2/breach/search \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://oathnet.org/api/service/v2/breach/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://oathnet.org/api/service/v2/breach/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://oathnet.org/api/service/v2/breach/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://oathnet.org/api/service/v2/breach/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "data": {
    "items": [
      {
        "id": "<string>",
        "email": "<string>",
        "email_domain": "<string>",
        "username": "<string>",
        "password": "<string>",
        "password_hash": "<string>",
        "salt": "<string>",
        "full_name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>",
        "display_name": "<string>",
        "phone_number": "<string>",
        "phone_national": "<string>",
        "address_street": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "date_birth": "<string>",
        "age": 123,
        "created_at": "<string>",
        "last_login": "<string>",
        "indexed_at": "2023-11-07T05:31:56Z",
        "ip": "<string>",
        "discordid": "<string>",
        "instagram": "<string>",
        "linkedin": "<string>",
        "iban": "<string>",
        "ssn": "<string>",
        "dbname": "<string>",
        "gender": "<string>",
        "language": "<string>",
        "bio": "<string>",
        "location": "<string>",
        "extra": {}
      }
    ],
    "meta": {
      "count": 123,
      "total": 123,
      "took_ms": 123,
      "has_more": true,
      "total_pages": 123,
      "max_score": 123,
      "filter_id": "0123456789abcdef01234567"
    },
    "dbname_info": {},
    "next_cursor": "<string>",
    "_meta": {}
  }
}

Overview

Endpoints

Search Breach Records

Authorizations

Query Parameters

Response