V2 Bulk Search
Create Bulk Search Job
Create an asynchronous bulk-search job across many terms.
POST
https://oathnet.org/api
/
service
/
v2
/
bulk-search
Create Bulk Search Job
curl --request POST \
--url https://oathnet.org/api/service/v2/bulk-search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"terms": [
"<string>"
],
"dbnames": [
"<string>"
],
"query_config": {
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": [
"linkedin.com",
"twitter.com"
],
"wildcard": true,
"extra_params": {
"sort": "-indexed_at"
}
},
"limit": 123,
"fields": [
"<string>"
]
}
'import requests
url = "https://oathnet.org/api/service/v2/bulk-search"
payload = {
"terms": ["<string>"],
"dbnames": ["<string>"],
"query_config": {
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": ["linkedin.com", "twitter.com"],
"wildcard": True,
"extra_params": { "sort": "-indexed_at" }
},
"limit": 123,
"fields": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
terms: ['<string>'],
dbnames: ['<string>'],
query_config: {
q: 'alice@example.com',
email: 'alice@example.com',
'dbname[]': ['linkedin.com', 'twitter.com'],
wildcard: true,
extra_params: {sort: '-indexed_at'}
},
limit: 123,
fields: ['<string>']
})
};
fetch('https://oathnet.org/api/service/v2/bulk-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/bulk-search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'terms' => [
'<string>'
],
'dbnames' => [
'<string>'
],
'query_config' => [
'q' => 'alice@example.com',
'email' => 'alice@example.com',
'dbname[]' => [
'linkedin.com',
'twitter.com'
],
'wildcard' => true,
'extra_params' => [
'sort' => '-indexed_at'
]
],
'limit' => 123,
'fields' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://oathnet.org/api/service/v2/bulk-search"
payload := strings.NewReader("{\n \"terms\": [\n \"<string>\"\n ],\n \"dbnames\": [\n \"<string>\"\n ],\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"limit\": 123,\n \"fields\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://oathnet.org/api/service/v2/bulk-search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"terms\": [\n \"<string>\"\n ],\n \"dbnames\": [\n \"<string>\"\n ],\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"limit\": 123,\n \"fields\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://oathnet.org/api/service/v2/bulk-search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"terms\": [\n \"<string>\"\n ],\n \"dbnames\": [\n \"<string>\"\n ],\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"limit\": 123,\n \"fields\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"job_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"progress": {
"records_done": 123,
"records_total": 123,
"bytes_done": 123,
"percent": 123,
"updated_at": "2023-11-07T05:31:56Z"
},
"result": {
"format": "<string>",
"file_name": "<string>",
"file_path": "<string>",
"file_size": 123,
"records": 123,
"ready_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"last_error": "<string>",
"request": {
"type": "<string>",
"limit": 123,
"fields": [
"<string>"
],
"request_count": 123
},
"next_poll_after_ms": 123,
"metadata": {}
}
}Authorizations
API key for authentication (lowercase header name)
Body
application/json
Available options:
stealer, docs, victims, breach Available options:
csv, json, jsonl, txt, html Reusable JSON form of a search request for exports and bulk-search jobs.
It accepts the same public filter keys as the corresponding V2 search endpoint, plus filter
and filter_id. Prefer canonical JSON keys such as domain, email_domain, dbname,
and username; bracketed variants such as domain[] are also accepted by the API.
Show child attributes
Show child attributes
Example:
{
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": ["linkedin.com", "twitter.com"],
"wildcard": true,
"extra_params": { "sort": "-indexed_at" }
}
⌘I
Create Bulk Search Job
curl --request POST \
--url https://oathnet.org/api/service/v2/bulk-search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"terms": [
"<string>"
],
"dbnames": [
"<string>"
],
"query_config": {
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": [
"linkedin.com",
"twitter.com"
],
"wildcard": true,
"extra_params": {
"sort": "-indexed_at"
}
},
"limit": 123,
"fields": [
"<string>"
]
}
'import requests
url = "https://oathnet.org/api/service/v2/bulk-search"
payload = {
"terms": ["<string>"],
"dbnames": ["<string>"],
"query_config": {
"q": "alice@example.com",
"email": "alice@example.com",
"dbname[]": ["linkedin.com", "twitter.com"],
"wildcard": True,
"extra_params": { "sort": "-indexed_at" }
},
"limit": 123,
"fields": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
terms: ['<string>'],
dbnames: ['<string>'],
query_config: {
q: 'alice@example.com',
email: 'alice@example.com',
'dbname[]': ['linkedin.com', 'twitter.com'],
wildcard: true,
extra_params: {sort: '-indexed_at'}
},
limit: 123,
fields: ['<string>']
})
};
fetch('https://oathnet.org/api/service/v2/bulk-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/bulk-search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'terms' => [
'<string>'
],
'dbnames' => [
'<string>'
],
'query_config' => [
'q' => 'alice@example.com',
'email' => 'alice@example.com',
'dbname[]' => [
'linkedin.com',
'twitter.com'
],
'wildcard' => true,
'extra_params' => [
'sort' => '-indexed_at'
]
],
'limit' => 123,
'fields' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://oathnet.org/api/service/v2/bulk-search"
payload := strings.NewReader("{\n \"terms\": [\n \"<string>\"\n ],\n \"dbnames\": [\n \"<string>\"\n ],\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"limit\": 123,\n \"fields\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://oathnet.org/api/service/v2/bulk-search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"terms\": [\n \"<string>\"\n ],\n \"dbnames\": [\n \"<string>\"\n ],\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"limit\": 123,\n \"fields\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://oathnet.org/api/service/v2/bulk-search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"terms\": [\n \"<string>\"\n ],\n \"dbnames\": [\n \"<string>\"\n ],\n \"query_config\": {\n \"q\": \"alice@example.com\",\n \"email\": \"alice@example.com\",\n \"dbname[]\": [\n \"linkedin.com\",\n \"twitter.com\"\n ],\n \"wildcard\": true,\n \"extra_params\": {\n \"sort\": \"-indexed_at\"\n }\n },\n \"limit\": 123,\n \"fields\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"job_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"progress": {
"records_done": 123,
"records_total": 123,
"bytes_done": 123,
"percent": 123,
"updated_at": "2023-11-07T05:31:56Z"
},
"result": {
"format": "<string>",
"file_name": "<string>",
"file_path": "<string>",
"file_size": 123,
"records": 123,
"ready_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"last_error": "<string>",
"request": {
"type": "<string>",
"limit": 123,
"fields": [
"<string>"
],
"request_count": 123
},
"next_poll_after_ms": 123,
"metadata": {}
}
}