If a record exists in our database, we will return a JSON “200 OK” response, which will look like so:
[ { "title": "Test Data Breach", "domain": "test.com", "email": "[email protected]", "username": "Username", "ip": "127.0.0.1" } ]
HOW?
After gaining access to the API, you can use it like so:
https://BreachDirectory.com/api_usage?
method=$Method&key=$Key&query=$Query
If you have bought access to the bulk API plan, you will also be able to provide the API with a text (.txt or .csv) file of accounts to search for. In that case, an additional parameter - “bulk_url” - is needed. In that case, the API should be used like so:
https://BreachDirectory.com/api_file?
method=$Method&key=$Key&bulk_url=$URL
Those people that have access to the bulk version of the API can also provide user accounts via the UI accessible here.
* There is no need to specify the query when using the API in bulk - specifying a file is enough.
ERROR MESSAGES
If the search fails, the system will return error messages. Some of them are:
- A search method is required.
When a search method is not specified.
- An API key is required.
When an API key is not specified.
- You have exceeded the limit of queries allowed for your API key.
When the limit of queries allocated to the API has been exceeded.
- Invalid or expired API key.
When the API key in use is invalid or expired.
- A search query is required.
When a search query is not specified.
- false or an empty array ([])
When the search did not return any results.