Skip to main content
POST
Phonebook

Authorizations

Authorization
string
header
required

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

Query Parameters

format
enum<string>
default:json

json (default) or txt. Same search, same price, different output.

Available options:
json,
txt

Body

application/json
type
enum<string>
required

What you want back: email addresses, domains (subdomains) or URLs. Case-insensitive.

Available options:
email,
domain,
url
query
string
required

Its shape depends on type: @example.com for email, example.com for domain, https://example.com for url (http or https, a real domain name, no credentials). Sent lowercased.

Maximum string length: 200
Example:

"@example.com"

Response

Search served (billed). JSON by default; with ?format=txt, a text/plain attachment named phonebook-{type}-{query}.txt, one selector per line, with X-Results-Total and X-Results-Truncated.

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
string
required
Allowed value: "phonebook"
query
string
required

The query as searched (trimmed, lowercased).

type
enum<string>
required
Available options:
email,
domain,
url
results
object[]
required