API reference

Search

Searches the networks you choose and answers with every profile found. One credit is spent.

POSThttps://dev.predictasearch.com/api/search

Headers

x-api-keystringrequired

Your API key.

Content-Typestringrequired

application/json

Body

Any other field is refused with a 422.

querystringrequired

What to search for. It must match the format of query_type, below.

query_typeenum<string>required

One of email, phone, name, username.

networksstring[]required

Network names, such as ["google", "chess"], or ["all"] for every network that supports query_type. The list is at GET /api/networks. Networks reserved to the Pro plan are skipped on other plans.

Query formats

`query_type`	Accepted	Example
`email`	A syntactically valid email address	`[email protected]`
`phone`	International format: `+` then 7 to 16 digits. Spaces, hyphens and parentheses are removed	`+33612345678`
`name`	At least two words of letters (any alphabet), `-`, `'` and `.`	`Jean-Pierre Dupont`
`username`	One word with at least one letter, not an email. A leading `@` is removed	`johndoe`

Response

200 with a JSON array. It can hold two kinds of items:

Profileobject

A profile or a record found by a source. platform names the source; the other fields depend on it: a social account (username, link, pfp_image…), a data breach (breach_name, date, data_classes…), a WHOIS record.

Rejected networkobject

A network you named that was not searched, with platform and the reason in error: unknown, not available through the API, or not supporting this query_type. Only present when you name networks yourself.

A source that failed or found nothing adds no item. An empty list means no source found anything.

Errors are listed in Errors. A request answered with an error never uses a credit.