Skip to content

XposedOrNot: Open-source API for real-time alerts on domain data breaches. Protects your online identity with user-friendly monitoring and immediate notifications. Ideal for personal and professional use.

License

XposedOrNot/XposedOrNot-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

XposedOrNot API

๐ŸŽ‰ Your free API for real-time data breach monitoring and analytics.
Black Pylint CodeQL

XposedOrNot API Playground ยท XposedOrNot.com


XposedOrNot demo

What is XposedOrNot API?

XposedOrNot is like your personal guard against data breaches. It's a platform that warns you when your email account might be at risk because of a public data breach. Knowing about these breaches can help you reduce the chances of your data getting exposed. Plus, it's totally open-source so you can see exactly how it works.

The XposedOrNot API is the heart of this system. It's what makes the checks for data breaches and sends you the alerts.

And guess what? It's FREE.

It gives you all the details about any data breaches that it finds, plus some useful stats about an email.

The API was built and is maintained by Devanand Premkumar. Twitter Mastodon

Show Your Support!

๐ŸŒŸ Give us a star if you like what we're doing!

๐Ÿด Fork it and make it your own!

๐Ÿค And hey, why not contribute? We love seeing what you can add to the mix!

How to Use XposedOrNot API (documentation)

If you want to get more details, you can check out our full documentation and API playground.

Why use XposedOrNot API?

XposedOrNot API is the power behind XposedOrNot, and it's the first open-source tool that monitors and alerts you about data breaches.

This API is your go-to for all information related to data breaches that XposedOrNot has collected and keeps up-to-date. Here are some things you can do with it:

  • Look up whether an email address has been caught in a data breach and get some stats about it
  • See if an email address has been exposed in public pastes
  • Do a combined search to check both data breach and pastes exposure for an email address
  • Check for exposed passwords without having to reveal who you are

If you'd rather skip the API and check data breach info directly, you can do that on our website at : https://XposedOrNot.com.

How secure is XposedOrNot API?

Is XposedOrNot API safe to use? Absolutely.

You see, the whole issue of data breaches has come from places that aren't secure. So, we've made sure everything is open-source, including the API and all related files on Github. We trust in the power of open source tools to make our digital world safer.

Everything we run, from the app to the website, is built on open source - from the operating system (Linux) to the API script (Python), and even the web files (HTML). We believe in improving services through collaboration, and open source makes that possible.

We've designed the XposedOrNot API with safety at its core because we're dealing with sensitive data breach information. Tools like Black, Pylint, and SonarQube Community Edition support the security of our code and design elements.

If you spot any problems or have suggestions for improvements, please raise an issue on GitHub.

And if you want to contribute, we welcome your pull requests. We'll gladly consider any changes or fixes you suggest.

Quick Start for Local Development

Using Docker-Compose

  1. Clone the Repository:

    git clone https://github.com/XposedOrNot/XposedOrNot-API
  2. Update the necessary environment variables in the docker-compose.yml file if needed, then run:

    docker-compose up

    This command will build API and Datastore Docker images. Note that the project source directory is mapped in the Docker container, so any changes in the source code won't require rebuilding the Docker image.

Local Installation

  1. Clone the Repository:

    git clone https://github.com/XposedOrNot/XposedOrNot-API
  2. Install Required Packages

    sudo apt-get install -y google-cloud-sdk google-cloud-sdk-app-engine-python python3-pip google-cloud-sdk-app-engine-python build-essential libffi-dev python-dev 
  3. Install Python Libraries

    pip3 install -r requirements.txt
  4. Setup Google Cloud Datastore

    Before running XposedOrNot-API, choose one of the following options:

  1. Run the application

    python3 main.py

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details

Security Vulnerability Reporting

Please do not report security vulnerabilities through public GitHub issues. Instead, refer to our Responsible Disclosure Guidelines for reporting these issues in a secure manner.

Acknowledgments

  • Big shout-out to Python and all the people looking after the modules we've used. You guys rock!

  • And a round of applause for everyone who's reviewed our code. Your eyes make all the difference.

Support! โญ

๐ŸŒŸ Star it ๐ŸดFork it ๐Ÿค Contribute to it!

About

XposedOrNot: Open-source API for real-time alerts on domain data breaches. Protects your online identity with user-friendly monitoring and immediate notifications. Ideal for personal and professional use.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks