Skip to main content
POST
/
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>"
  ]
}
'
{
  "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>",
      "service": "<string>",
      "format": "<string>",
      "limit": 123,
      "fields": [
        "<string>"
      ],
      "request_count": 123
    },
    "next_poll_after_ms": 123,
    "metadata": {}
  }
}
Create a batched bulk-search job across many terms.
Create returns the standard envelope, but list and status responses are raw JSON job snapshots.

Authorizations

​
x-api-key
string
header
required

API key for authentication (lowercase header name)

Body

application/json
​
terms
string[]
​
service
enum<string>
Available options:
stealer,
docs,
victims,
breach
​
format
enum<string>
Available options:
csv,
json,
jsonl
​
dbnames
string[]
​
query_config
object

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

Example:
{
  "q": "alice@example.com",
  "email": "alice@example.com",
  "dbname[]": ["linkedin.com", "twitter.com"],
  "wildcard": true,
  "extra_params": { "sort": "-indexed_at" }
}
​
limit
integer
​
fields
string[]

Response

202 - application/json

Envelope response with the created job snapshot

​
success
boolean
​
message
string
​
data
object