{"id":30315670,"url":"https://github.com/ranger-nf/api-hunt","last_synced_at":"2025-10-18T02:53:42.367Z","repository":{"id":310226186,"uuid":"1039119366","full_name":"Ranger-NF/API-Hunt","owner":"Ranger-NF","description":"Treasure Hunt but with FastAPI","archived":false,"fork":false,"pushed_at":"2025-08-16T16:38:59.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-16T17:25:25.993Z","etag":null,"topics":["fastapi","mini-","mini-project"],"latest_commit_sha":null,"homepage":"https://api-hunt.justfahad.me/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ranger-NF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-16T14:20:00.000Z","updated_at":"2025-08-16T17:17:15.000Z","dependencies_parsed_at":"2025-08-16T17:38:58.684Z","dependency_job_id":null,"html_url":"https://github.com/Ranger-NF/API-Hunt","commit_stats":null,"previous_names":["ranger-nf/api-hunt"],"tags_count":null,"template":false,"template_full_name":"TH-Activities/saturday-hack-night-template","purl":"pkg:github/Ranger-NF/API-Hunt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ranger-NF%2FAPI-Hunt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ranger-NF%2FAPI-Hunt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ranger-NF%2FAPI-Hunt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ranger-NF%2FAPI-Hunt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ranger-NF","download_url":"https://codeload.github.com/Ranger-NF/API-Hunt/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ranger-NF%2FAPI-Hunt/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270899520,"owners_count":24664715,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastapi","mini-","mini-project"],"created_at":"2025-08-17T19:48:11.205Z","updated_at":"2025-10-18T02:53:37.331Z","avatar_url":"https://github.com/Ranger-NF.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n\n\u003cimg width=\"1920\" height=\"1080\" alt=\"nasahub\" src=\"https://github.com/user-attachments/assets/e8544200-f902-41ee-a2f2-7375cad5043d\" /\u003e\n\n# 🏆 API Hunt - Interactive Riddle Challenge\n**API Hunt** is an engaging treasure hunt game that challenges developers to solve riddles and navigate through API endpoints. Race against time, solve cryptic clues, and climb the leaderboard in this unique puzzle game!\n\n## 🎯 Features\n\n- **🧩 Multi-stage riddle challenges** - Solve cryptic clues to find the next endpoint\n- **⏱️ Real-time leaderboard** - Compete with other players based on completion time\n- **🔒 Sequential progression** - Must complete stages in order, no skipping allowed\n- **📊 Player statistics** - Track your progress and game statistics\n- **🚀 RESTful API design** - Clean, well-structured endpoints\n- **⚡ Fast and lightweight** - Built with FastAPI for optimal performance\n\n\n## product walkthrough\n\n[![Watch the video](docs/logo.jpeg)](https://github.com/user-attachments/assets/4232d6ea-1c19-4133-bd2e-5ff30cb7a7ba)\n\n## 🎮 How to Play\n\n\n### 1. Start Your Adventure\n```bash\nPOST /start\n{\n  \"player_name\": \"YourPlayerName\"\n}\n```\n\n### 2. Follow the Clues\nEach successful stage gives you a new riddle. Solve it to find the next endpoint!\n\n**Example Flow:**\n- **Stage 1**: `POST /answer1` with your answer\n- **Stage 2**: `POST /answer2` with your answer\n...\n\n### 3. Submit Your Answers\n```bash\nPOST /{endpoint}\n{\n  \"player_name\": \"YourPlayerName\"\n}\n```\n\n### 4. Win and Celebrate! 🎉\nComplete all stages to win and see your completion time!\n\n## Libraries used\n- **[FastAPI](https://fastapi.tiangolo.com/)** - Modern, fast web framework\n- **[Pydantic](https://pydantic-docs.helpmanual.io/)** - Data validation and settings\n- **[Uvicorn](https://www.uvicorn.org/)** - ASGI web server\n\n## How to configure\n\n### Prerequisites\n- Python 3.7+\n- pip package manager\n\n### Installation \u0026 Setup\n1. **Clone the repository**\n   ```bash\n   git clone https://github.com/Ranger-NF/API-Hunt.git\n   cd API-Hunt\n   ```\n\n2. **Install dependencies**\n   ```bash\n   pip install fastapi uvicorn\n   ```\n\n## How to Run\n1. **Run the game server**\n   ```bash\n   uvicorn main:app --reload\n   ```\n\n2. **Access the game**\n   - API Documentation: http://localhost:8000/docs\n   - Game Endpoints: http://localhost:8000/\n\n\n## 📋 API Endpoints\n\n| Endpoint | Method | Description |\n|----------|--------|-------------|\n| `/start` | POST | Begin the game with your player name |\n| `/age` | POST | First riddle stage |\n| `/fire` | POST | Second riddle stage |\n| `/secrets` | POST | Final challenge |\n| `/leaderboard` | GET | View top players by completion time |\n| `/players` | GET | List all players and their status |\n| `/player/{name}/status` | GET | Get specific player details |\n| `/stats` | GET | Overall game statistics |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Franger-nf%2Fapi-hunt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Franger-nf%2Fapi-hunt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Franger-nf%2Fapi-hunt/lists"}