A REST API wrapper for the GitHub Profile Viewer tool. Simulate profile views on GitHub through API endpoints.

• 🚀 FastAPI-based REST API
• 🔐 API Key Authentication via X-API-Key header
• 🧵 Multi-threaded view execution
• 🛡️ Anti-detection features with headless Chrome
• 📄 Swagger UI documentation at /docs

• Python 3.8+
• Google Chrome browser installed

git clone https://github.com/dewhush/Github-Profile-View-API.git cd Github-Profile-View-API

python -m venv .venv .venv\Scripts\activate # Windows # source .venv/bin/activate # Linux/Mac

pip install -r requirements.txt

copy .env.example .env

Edit .env and set your API key:

APP_NAME=Github-Profile-View-API APP_ENV=development API_KEY=your-secure-api-key-here

run_api.bat

uvicorn api:app --host 0.0.0.0 --port 8000 --reload

API will be available at: http://localhost:8000

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc

Health check endpoint.

Response:

{ "status": "healthy", "timestamp": "2024-01-17T00:00:00.000000" }

Get API status information.

Response:

{ "app_name": "Github-Profile-View-API", "environment": "development", "version": "1.0.0", "status": "running", "timestamp": "2024-01-17T00:00:00.000000" }

Execute profile views on a GitHub profile.

Headers:

Request Body:

{ "username": "dewhush", "view_count": 10, "max_workers": 5 }

Response:

{ "username": "dewhush", "total_count": 10, "success_count": 10, "failed_count": 0, "status": "completed", "message": "Completed 10/10 views successfully" }

curl -X POST http://localhost:8000/v1/view \ -H "Content-Type: application/json" \ -H "X-API-Key: your-api-key" \ -d '{"username": "dewhush", "view_count": 5}'

import requests response = requests.post( "http://localhost:8000/v1/view", headers={ "Content-Type": "application/json", "X-API-Key": "your-api-key" }, json={ "username": "dewhush", "view_count": 5, "max_workers": 3 } ) print(response.json())

This tool is for educational purposes only. Using automated scripts to artificially inflate metrics may violate GitHub's Terms of Service. Use at your own risk.

MIT License

Created by dewhush