Search

Description

This endpoint is used to execute a new credentials leak search based on a chosen query. There are three modes of operation, based on desired search token usage, via body parameters. Refer to Searching for a deeper dive.

It is available at the following URL.

https://api.intelsentry.io/v1/search

Input Params

• query: Mandatory JSON body parameter used to indicate the asset that will be searched in the credentials leak database. May be a domain, username, IP, URL, or email. Note that, in order to comply with ethical guidelines, sensitive TLDs such as .gov, .mil, and .int are banned.
• full_search: Optional JSON body parameter used to indicate that the search must consume as many search tokens as needed to get the full results. The only accepted value is true, otherwise it is not needed.
• pages: Optional JSON body parameter used to indicate the amount of search tokens that must be used to extract the results. Must be a number higher than 1.

Note that full_search and pages cannot be supplied in the same request.

HTTP Methods

• POST: Used to execute the new search.

Example Request

POST https://api.intelsentry.io/v1/search
Authorization: Bearer <token>
Content-Type: application/json
 
{
    "query": "example.com"
}

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <token>" -d '{"query":"example.com"}' https://api.intelsentry.io/v1/search

curl.exe -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <token>" -d "{\"query\":\"test.com\"}" https://api.intelsentry.io/v1/search

$headers = @{}
$headers.Add("Authorization","Bearer <token>")
$headers.Add("Content-Type","application/json")
$body = @{}
$body.Add("query", "example.com")
$bodyJson = $body | ConvertTo-Json
Invoke-WebRequest -Headers $headers -Method POST -Method POST -Body $bodyJson https://api.intelsentry.io/v1/search | select -ExpandProperty Content

import requests
 
headers = {"Authorization": "Bearer <token>", "Content-Type": "application/json"}
query = {"query": "example.com"}
response = requests.post("https://api.intelsentry.io/v1/search", headers=headers, json=query)
print(response.text)

Example Response

HTTP/1.1 200
Content-Type: application/json
 
{
    "results": [
    "https://account.example.com/ResetPassword.aspx:redacted:redacted",
    "https://login.example.com/:redacted@gmail.com:redacted",
    "https://login.example.com/Login.aspx:redacted@gmail.com:redacted"
    ],
    "status": 200,
    "results_count": 3,
    "max_results_count": 3,
    "cost": 1,
    "tokens_left": 1499
}

Note that, if no results are found, the value for results will be null, and the deducted costs will be 0. Moreover, max_results_count represents the total results count if the query would be fully executed.

Status Codes