v1

latestOpenAPI 3.1.0License and Price2026-07-1722542.4 KB

Internal live search

Initiates the search; will return status and search Id on success. Limit means max amount of records per bucket to return. Default 10.

  • Selector: Must be an email address, domain, social security number (US based), or credit card number.
  • Limit: In some cases, the API might return more results than specified in limit. If an upper hard limit is required, it must be enforced on the client side.
  • Bucket: Optional filter for searching only in the target bucket. See Appendix 1 for list.
  • In case a user makes a new search and the previous one shall be discarded; its search ID shall be specified in the “terminate” parameter to save system resources. Searches may consume Gigabytes of data, therefore any searches that are no longer required shall be terminated. Searches can also be manually terminated via the /live/search/terminate function.
  • Dates: From/to dates may be used as filter. Note that item’s dates are set to when the original data was published if available, or otherwise when it was indexed. This means that newly indexed items are often backdated.
get/live/search/internal

Query parameters

selectorstring required

Selector to search for

bucketstring
skipinvalidboolean

Specify to skip invalid entries (recommended). Default false.

limitinteger

Result limit

analyzeboolean

Default false.

datefromstring
Example:2024-01-01 00:00:00

Date from of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)

datetostring
Example:2024-01-31 23:59:59

Date to of the result in YYYY-mm-dd HH:ii:ss format. (Not RFC3339)

terminatestring[]

Optional: ID of previous search to terminate to save system resources.

Response

Success search

statusinteger required

Result status

idstring required

Example response

{
  "id": "61202067-543e-4e6a-8c23-11f9b8f008cf"
}