ABOUT

API

Many businesses in 2021 alone received fines amounting to hundreds of millions of dollars because they had suffered data breaches. Now, with the General Data Protection Regulation (GDPR) in place, fines could be even higher.

Our API can help you to not fall victim to hacker attacks. Everyone can use the API - it can be used to incorporate our search engine into any information system.

All users of the API should only use the service to improve the security of their service or product offerings, secure their API credentials, ensure that any information obtained through the BreachDirectory API or any other services is secured from unauthorized access, and follow all of the applicable laws pertaining to their jurisdiction.

If a record exists in our database, we will return a JSON “200 OK” response, which will look like so (one part of the response is dedicated to the record in the data breach, the other is dedicated to the information about the data breach):

[
    {
        "title": "Test Data Breach",
        "domain": "test.com",
        "email": "[email protected]",
        "username": "Username",
        "ip": "127.0.0.1"
    }
    {
        "id": "ID",
        "title": "test.com",
        "domain": "test.com",
        "breachdate_en": "0000",
        "breachdate_ru": "0000",
        "breachdate_lt": "0000",
        "category_en": "Category",
        "category_ru": "Category in Russian",
        "category_lt": "Category in Lithuanian",
        "description_en": "Description",
        "description_ru": "Description in Russian",
        "description_lt": "Description in Lithuanian",
        "compromised_data_en": "Compromised Data",
        "compromised_data_ru": "Compromised Data in Russian",
        "compromised_data_lt": "Compromised Data in Lithuanian",
        "verified": "0 / 1 [Yes / No]",
        "analyzed": "0 / 1 [Yes / No]",
        "analysis_url_en": "The URL of the Data Breach Analysis (If Available)",
        "analysis_url_ru": "Data Breach Analysis URL in Russian",
        "analysis_url_lt": "Data Breach Analysis URL in Lithuanian",
        "image": "Image"
    }
]
                

HOW?

USAGE

After gaining access to the API, you can use it like so:

  • - $Method - Search method (At this time, there are the following methods available - users can search by providing a domain (“domain”), email (“email”), username (“username”) and IP address (“ip”).
  • - $Key - API Key acquired by purchasing access to the API.
  • - $Query - Search Query.

ERROR MESSAGES

ERRORS

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.