Skip to main content
POST
Intelligence Search

Authorizations

Authorization
string
header
required

Authorization: Bearer fly_live_…. Takes precedence when both headers are sent.

Query Parameters

format
enum<string>
default:json

Only json (the default) is accepted. txt returns 400 unsupported_format.

Available options:
json

Body

application/json
query
string
required

Email, username, domain or text to search for. Trimmed; 200 characters max.

Maximum string length: 200
Example:

"example.com"

max_results

Whole number from 1 to 1000, as a JSON number or a string of digits. Omit for the default.

Example:

100

media_type
string | null

Optional media type filter, passed as is. 200 characters max.

Maximum string length: 200
sort_order
enum<string> | null

Case-insensitive.

Available options:
relevance,
date_asc,
date_desc,
null
date_from
string<date> | null

Start date, YYYY-MM-DD. Must be a real calendar date.

Example:

"2024-01-01"

date_to
string<date> | null

End date, YYYY-MM-DD. On or after date_from.

Example:

"2024-12-31"

Response

Search served (billed), including a successful empty result.

total
integer
required

Results found.

returned
integer
required

Results in results (5,000 max).

truncated
boolean
required

true if total is greater than returned.

billed
boolean
required
usage
object
required

Quota of the account, after the call.

module
enum<string>
required
Available options:
intelligence-search,
identity-portal
query
string
required

The query as searched (trimmed).

results
object[]
required