Sign in

v1

latestOpenAPI 3.1.02026-07-1481311.5 KB
Search

Search

Search lines by email/password/domain.

post/search

Request body

searchBy'email' | 'password' | 'domain' required

Search type.

Search Priority:

  • searchBy: email - email, then password.
  • searchBy: password - password, then email.
  • searchBy: domain - domain, then email, then password.
order'asc' | 'desc'

[Premium subscription required]

If you specify DESC order, then most likely you will have a couple of results. Everything is fine and it should be. To get more results - you need to disable fuses by specifying all in direction for your query field. Or if the request field is strict, then specify fromLastValueOfKey equal to true.

fromLastValueOfKeyboolean

[Premium subscription required]

When using this option and "strict direction" the starting position starts from the last value of the key.

For example, we have email:pass1, email:pass2, email:pass3. Then when setting query = email, direction = strict, fromLastValueOfKey = true the first result obtained will be email:pass3.

groupBy'login@domain' | 'domain' | 'password'

[Premium subscription required]

This option allows you to remove "duplicates". Only the first found line corresponding to the grouping will be returned and will move on to the next value.

Can be used in the following cases:

  • searchBy: email - login@domain.
  • searchBy: password - password.
  • searchBy: domain - domain, login@domain.
format'login@domain:password' | 'login@domain' | 'login' | 'domain' | 'password'

The format of the returned results. Allows you to quickly leave the most necessary without post-processing. When used correctly together with groupBy, the execution time of a database search query can be accelerated by eliminating JOIN operations on the server.

pageTokenstring

The page token that was returned in the previous request. The token will be considered invalid if any of the request parameters change.

Example request

{
  "searchBy": "email"
}

Response

Successful response

successboolean
availableQueriesinteger
resultCountinteger
maxCountinteger nullable

Available only when each query element related to direction is equal to strict

resultsstring[]