POST with a JSON object body:
Professional and Enterprise include all five modules. An unknown slug returns
404 unknown_module.
Rules that apply to every body
- The body must be a JSON object of 16 KB or less (
400 invalid_json,413 body_too_large).Content-Type: application/jsonis recommended but not required. - Unknown fields are rejected with
422 invalid_input, so a typo such assystemIdis reported instead of ignored. - Values are strings.
max_resultsalso accepts a JSON number.nullcounts as absent. - Leading and trailing spaces are trimmed. Text fields are limited to 200 characters.
- Invalid input returns
422 invalid_inputwith one message per field inerror.fields, and is never billed. GETis not supported: a search value in a URL would end up in logs.
Intelligence Search
Free-text search by email, username, domain or keyword.string
required
Email, username, domain or text. 200 characters max.
number | string
Whole number from 1 to 1000.
string
Media type filter, passed as is. 200 characters max.
string
relevance, date_asc or date_desc (case-insensitive).string
Start date,
YYYY-MM-DD. Must be a real calendar date.string
End date,
YYYY-MM-DD, on or after date_from.Phonebook
Every known selector for a domain.type decides both what you get back and the shape query must have.
string
required
email, domain or url (case-insensitive).string
required
Depends on
type. Sent lowercased.
The domain must be a real domain name: IP addresses,
localhost and non-ASCII names are refused.
Identity Portal
string
required
Email address, domain or other selector. 200 characters max.
System ID
Downloads the raw file behind a result.string
required
UUID (
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx), usually results[].system_id from Intelligence Search or Identity Portal. Case-insensitive.Storage ID
Downloads a raw file by storage ID.string
required
128 or 129 hexadecimal characters. Spaces and line breaks are removed, so a wrapped copy-paste works (1,000 characters max as sent).
string
required
One of the exact values below.
Both file modules are covered in Raw files and text output.
Responses
Every successful JSON response hasmodule, billed and usage.
- Records
- Selectors
- File
200: total: 0 and results: [] for lists, file: null for files. See Billing and quotas for when it is billed.