{"id":21997571,"url":"https://github.com/ali-raza764/chess_puzzles_api","last_synced_at":"2026-02-13T02:39:56.730Z","repository":{"id":246733126,"uuid":"818978210","full_name":"Ali-Raza764/chess_puzzles_api","owner":"Ali-Raza764","description":"An api built on top of lichess puzzles database using python flask and pandas.","archived":false,"fork":false,"pushed_at":"2024-09-05T06:10:30.000Z","size":860,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-06T11:09:04.690Z","etag":null,"topics":["api","chess","chess-puzzle","csv","flask","lichess","pandas","puzzles","puzzles-api","python"],"latest_commit_sha":null,"homepage":"https://chess-puzzles-api.vercel.app","language":"HTML","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/Ali-Raza764.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}},"created_at":"2024-06-23T12:28:50.000Z","updated_at":"2024-09-05T06:10:33.000Z","dependencies_parsed_at":"2024-07-06T09:03:06.962Z","dependency_job_id":null,"html_url":"https://github.com/Ali-Raza764/chess_puzzles_api","commit_stats":null,"previous_names":["ali-raza764/chess_puzzles_api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ali-Raza764%2Fchess_puzzles_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ali-Raza764%2Fchess_puzzles_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ali-Raza764%2Fchess_puzzles_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ali-Raza764%2Fchess_puzzles_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ali-Raza764","download_url":"https://codeload.github.com/Ali-Raza764/chess_puzzles_api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227223688,"owners_count":17750386,"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","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":["api","chess","chess-puzzle","csv","flask","lichess","pandas","puzzles","puzzles-api","python"],"created_at":"2024-11-29T22:17:12.160Z","updated_at":"2026-02-13T02:39:51.706Z","avatar_url":"https://github.com/Ali-Raza764.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Puzzle API\r\n\r\nThis is a Flask-based API for retrieving puzzle data. The API supports filtering and pagination, and it includes caching for better performance.\r\n\r\n## Endpoints\r\n\r\n### GET /puzzles\r\n\r\nRetrieve a list of puzzles with optional filters and pagination.\r\n\r\n#### Query Parameters:\r\n\r\n- **start** (integer, default: 0) - The starting index for pagination.\r\n- **limit** (integer, default: 10) - The number of puzzles to return.\r\n- **min_rating** (integer, default: 0) - The minimum rating to filter puzzles.\r\n- **max_rating** (integer, default: 3000) - The maximum rating to filter puzzles.\r\n- **themes** (string) - A comma-separated list of themes to filter puzzles.\r\n\r\n#### Example Request:\r\n```plaintext\r\nhttps://chess-puzzles-api.vercel.app/puzzles?start=0\u0026limit=10\u0026min_rating=1000\u0026max_rating=2000\u0026themes=adventure,logic\r\n```\r\n\r\n### GET /puzzle\r\n\r\nRetrieve a puzzle by its ID.\r\n\r\n#### Query Parameters:\r\n\r\n- **puzzle_id** (string) - The ID of the puzzle to retrieve.\r\n\r\n#### Example Request:\r\n```plaintext\r\nhttps://chess-puzzles-api.vercel.app/puzzle?puzzle_id=12345\r\n```\r\n\r\n## Getting Started\r\n\r\n### Prerequisites\r\n\r\n- Python 3.x\r\n- Flask\r\n- Flask-Caching\r\n- pandas\r\n\r\n### Installation\r\n\r\n1. Clone the repository:\r\n   ```sh\r\n   https://github.com/Ali-Raza764/chess_puzzles_api\r\n   cd YOUR_REPOSITORY_NAME\r\n   ```\r\n\r\n2. Create a virtual environment and activate it:\r\n   ```sh\r\n   python -m venv venv\r\n   source venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\r\n   ```\r\n\r\n3. Install the dependencies:\r\n   ```sh\r\n   pip install -r requirements.txt\r\n   ```\r\n\r\n4. Ensure you have a `puzzles.csv` file in the root directory of your project.\r\n\r\n### Running the App\r\n\r\n1. Run the Flask app:\r\n   ```sh\r\n   flask run\r\n   ```\r\n\r\n2. Open your browser and go to `http://127.0.0.1:5000` to view the API documentation.\r\n\r\n## Deployment\r\n\r\nFor deployment, you can use services like Heroku, AWS, or any other cloud provider. Ensure you have the necessary environment variables set up and a production-ready server configuration.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fali-raza764%2Fchess_puzzles_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fali-raza764%2Fchess_puzzles_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fali-raza764%2Fchess_puzzles_api/lists"}