Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.13 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.13 KB

SurfGuardAPI_Banner

SURFGUARDAPI


Yes, of course we all are athletics. We surf the internet everyday!


SURFGUARDAPI is the brain behind SurfGuard, a plugin for browsers which helps you surf the internet waves safely and securely. It thoroughly analyzes the site you are on and tells you whether it is safe to surf or not. The analysis is done by this custom made SurfGuard API which uses ML model having over 92.79% accuracy on training data and 92.67% accuracy on testing data. The service is live here and can handle upto maximum 8 concurrent requests.

View API's uptime report

View notebook here


⚡ How to use API?


  • Send a GET request to
https://surfguardsays.onrender.com/getStatus?url=<url_you_wish_to_analyze>
  • Response is sent within 10-15 seconds but may take up to 25 seconds in few scenarios (due to dependencies).

🤝 How to Contibute?


  • Take a look at the Existing issues or create your own issues!
  • Wait for the issue to be assigned to you.
  • Fork the repository.
  • Clone your forked copy of the project.

git clone --depth 1 https://github.com/<your_user_name>/SurfGuardAPI.git

💻 Installation


  1. Download and setup python on your device
  2. Install dependencies
pip install -r requirements.txt
  1. Run start command
gunicorn main:app --workers 8 --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:80

❤️ Feedback


If you have any feedback or suggestions please reach out to the project admin sanidhyak or you can create an issue and mention there which new features can be added to make SURFGUARDAPI better.