POST
Phonebook
type is what you want back: email lists email addresses, domain lists domains and subdomains, url lists URLs.
Listing the email addresses of a domain: write the domain with a leading @ — "query": "@example.com" with "type": "email". Without the @, the archive finds nothing, so the API adds it when it is missing.

Authorizations

Authorization
string
header
required

Your API key, from https://orelys.io/account/api. It starts with orl_ (keys made before the rename start with fly_ and keep working). X-API-Key: <key> works too. A key in the URL is refused.

Body

application/json
query
string
required

The domain, email address or URL to look up. With type: "email", write the domain with a leading @ (@example.com); the API adds it if you leave it out.

Required string length: 1 - 200
Example:

"@example.com"

type
enum<string>
required

What kind of selectors to list. Case does not matter.

Available options:
domain,
email,
url
Example:

"email"

Response

The selectors found.

mode
enum<string>
required
Available options:
intelligent,
phonebook,
identity-portal,
uuid,
storage,
stealer-export
request
object
required

The search as sent to the archive, after normalisation: dates as DD/MM/YYYY, choices in lower case, numbers as strings.

count
integer
required

Number of items in results.

results
object[]
required
charged
boolean
required

Whether this search took 1 request from the daily quota. When the archive answers "no results", nothing is charged, within a daily allowance (your daily quota, at least 10); a search that completes with an empty list is charged, as in the dashboard.

quota
object
required

Today's quota. It resets every day at 02:00 Paris time.

redacted
integer

Only present when records were removed because they contain a removed selector.

source
object

Other fields the archive sent next to the list (a total, for example), passed through unchanged.