POST
Username search
Paid in credits: 1, or 4 with "extended": true. Nothing is charged when no source finds anything. How credits work →
The search asks its sources several at a time and answers within about 100 seconds. Set your client’s timeout to at least 120 seconds.

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
username
string
required

The username, 4 to 40 characters: letters, digits, underscores, dots and dashes. A leading @ is dropped.

Pattern: ^@?[A-Za-z0-9][A-Za-z0-9_.-]{3,39}$
Example:

"johndoe"

extended
boolean
default:false

Also ask the extended sources — deeper data, +3 credits.

Response

The sources that found something. charged tells whether credits were taken.

module
enum<string>
required
Available options:
username,
email
query
string
required

The username or email address searched, after normalisation.

extended
boolean
required

Whether the extended sources were asked.

count
integer
required

Number of items in results.

results
object[]
required

Only the sources that found something.

sources
object
required

What happened across every source asked.

cost
integer
required

Credits the search costs: 1, or 4 with the extended sources.

charged
boolean
required

Whether the credits were taken. false when nothing was found, within a daily allowance (your daily quota, at least 10).

credits
object
required
redacted
integer

Only present when results were left out because they contain a removed selector.