GET Parameters

In order to use the API you need to call an endpoint URL with your private access token.

http://webhose.io/piiFilter?token=XXXXX-XXXXX&format=json&q=[QUERY]

HTTP GET Parameters

Parameter
Description
Example

q

A string query containing the filters that define which leaked documents will be returned.

Find any leaked documents containing email: xxx123@gmail.com

email.value:xxx123@gmail.com

token

Your private access token. You get a unique access token when you sign up.

ts

The "ts" (timestamp) parameter tells the system to return results that were crawled after this timestamp (Unix Timestamp in milliseconds).

&ts=1459835503426

format

The output format of the results set can either be:


  • json
  • xml

The default is json

&format=xml

latest

This will return the latest PII Leaks records crawled matching your query.
It's NOT recommended to use this feature as it may result in your missing important leaks

&latest=true


What's Next

Filters Reference

PII Leaks Filter Reference

GET Parameters


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.