Skip to Content
API Reference/v1/search/count

Pre-Search Count

Description

This endpoint is used to extract the maximum results size of a given query, as well as its cost. It is useful when used before the search in order to prevent overspending search tokens, since you will obtain the necessary information to execute a paged query. Note that this endpoint does not cost any search tokens to use.

It is available at the following URL.

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

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.

HTTP Methods

  • POST: Used to execute the count for a given search query and obtain the results.

Example Request

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

Example Response

HTTP/1.1 200 Content-Type: application/json { "status": 200, "count": 30797, "cost": 16, "searches_left": 1500 }

With this, you will obtain the necessary information to know whether you can afford and want to execute a given query or prefer a paged version to get partial data.


Status Codes


Status CodeDescription
200The count was correctly executed and results were returned
400The request was not correct e.g. query parameter was not provided
403The user does not have access to that data at that time e.g. attempted a banned query
503The backend services are temporarily down at that time
Last updated on