Skip to content

breach-report/breachreport-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Breach Report API Documentation




Overview

Breach Report monitors the internet for information about data breaches. As of August 2020, the compiled database provides records for 14B+ compromised user accounts. Your applications can access this information via Breach Report API.

The main purpose of this repository is to let you know about Breach Report API and to collect your feedback.

Getting started

Before using Breach Report API, make sure you've registered at Breach Report portal so you can get and use the unique API key.

When you use Breach Report API, include the key in the request header.

Contact

We look forward to hearing from you.

If you need help integrating your application with Breach Report API or need additional information, feel free to contact us on:

Or email us at support@breachreport.com.

If you want to report a security issue, include the word "security" in the subject field. We take all security issues very seriously!

We hope that you enjoy using Breach Report API and that the integration goes smoothly!

Testing Breach Report API

Breach Report API can be tested using various automation tools.

The following parameters can be specified via the test environment.

PARAMETER VALUE COMMENTS
BASE_URL https://breachreport.com
API_KEY your-secret-key See Getting the API key for the details.

Contact the technical support for the additional API aids (request schemas, etc).

How to Use Breach Report API

For detailed information on how to use the API, see the following pages:

Contributing to the Project

You can contribute to the project by creating a Breach Report account and getting a paid subscription or by reporting technical issues to the technical support at support@breachreport.com.

Subscription Plans

Breach Report provides several Business and Enterprise subscription plans.

For information about the current subscription opportunities, see Billing and Payments on the Breach Report portal.

The subscription plans may have limitations for the number of domains to track and number of available API calls. To remove the current limitations, you may need to upgrade your existing BR account.

For further information, contact the product support at support@breachreport.com.