{"id":20034209,"url":"https://github.com/zingzy/qrcode-api","last_synced_at":"2025-07-23T13:35:48.630Z","repository":{"id":211275108,"uuid":"728531350","full_name":"Zingzy/qrcode-api","owner":"Zingzy","description":"Advanced, Open-source qrcode generator api in python","archived":false,"fork":false,"pushed_at":"2024-01-27T13:03:01.000Z","size":2039,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T20:51:24.162Z","etag":null,"topics":["api","flask","flask-api","python","python3","qr","qr-code","qrcode","qrcode-api","qrcode-generator","web","web-development","web-tools"],"latest_commit_sha":null,"homepage":"https://qr.spoo.me","language":"CSS","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/Zingzy.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":"2023-12-07T06:19:01.000Z","updated_at":"2024-12-28T19:39:52.000Z","dependencies_parsed_at":"2023-12-13T09:29:39.783Z","dependency_job_id":"3b5186b0-6952-43d6-baa8-8589223272b3","html_url":"https://github.com/Zingzy/qrcode-api","commit_stats":null,"previous_names":["zingzy/qrcode-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Zingzy/qrcode-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zingzy%2Fqrcode-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zingzy%2Fqrcode-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zingzy%2Fqrcode-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zingzy%2Fqrcode-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zingzy","download_url":"https://codeload.github.com/Zingzy/qrcode-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zingzy%2Fqrcode-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266689363,"owners_count":23969142,"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-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":["api","flask","flask-api","python","python3","qr","qr-code","qrcode","qrcode-api","qrcode-generator","web","web-development","web-tools"],"created_at":"2024-11-13T09:48:55.858Z","updated_at":"2025-07-23T13:35:48.589Z","avatar_url":"https://github.com/Zingzy.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QR Code Generator API 🚀\n\nThis API is a simple Flask application that generates QR codes. It provides two endpoints for generating QR codes with different styles: `simple` and `radial`.\n\n---\n\u003cdetails\u003e\n\n\u003csummary\u003e\u003cstrong\u003eTable of Contents\u003c/strong\u003e\u003c/summary\u003e\n\n- [Getting Started](#getting-started-%EF%B8%8F)\n  - [Prerequisites](#prerequisites-)\n  - [Running the API](#running-the-api-)\n- [Endpoints](#endpoints-)\n  - [Simple QR Code](#simple-qr-code-)\n  - [Radial QR Code](#radial-qr-code-)\n- [Additional Endpoints](#additional-endpoints-)\n  - [Health Check](#health-check-)\n  - [Index](#index-)\n\n\u003c/details\u003e\n\n---\n\n## Getting Started 🛠️\n\nTo get started with the API, follow the instructions below:\n\n### Prerequisites 📋\n\nMake sure you have the following dependencies installed:\n\n* Python 3\n  \n* Flask\n  \n* Flask-Caching\n  \n* Flask-CORS\n  \n* qrcode\n  \n* pillow\n  \n\nYou can install these dependencies using the following command:\n\n    pip install -r requirements.txt\n\n### Running the API 🏃\n\nTo run the API, execute the following command:\n\n1. Clone the repository:\n\n    git clone https://github.com/Zingzy/qrcode-generator-api.git\n\n2. Change directory to the repository:\n\n    cd your-repo\n\n3. Run the Flask API:\n\n    python app.py\n\nThe API will be accessible at http://localhost:8080.\n\n---\n\n# Endpoints 🚦\n\n1. ### Simple QR Code 📎\n  \n\n**Endpoint:** `/simple`\n\n**Method:** `GET` or `POST`\n\n**Parameters:**\n\n* `url` (required): The URL or text to encode into the QR code.\n  \n* `fill` (optional): The fill color of the QR code (default: black).\n  \n* `back` (optional): The background color of the QR code (default: white).\n  \n\n**Example:**\n\n    curl -X GET \"http://localhost:8080/simple?url=https://www.google.com\u0026fill=red\u0026back=yellow --output simple_qr.png\"\n\n2. ### Radial QR Code 🎨\n  \n\n**Endpoint:** `/radial`\n\n**Method:** `GET` or `POST`\n\n**Parameters:**\n\n* `url` (required): The URL or text to encode into the QR code.\n  \n* `back` (optional): The background color of the QR code (default: white).\n  \n* `gradient1` (optional): The first color of the radial gradient in RGB format only (default: (106,26,76))\n  \n* `gradient2` (optional): The second color of the radial gradient in RGB format only (default: (64,53,60))\n  \n\n**Example:**\n\n    curl -X POST \"http://localhost:8080/radial?url=https://example.com\u0026gradient1=(255,0,0)\u0026gradient2=(0,0,255)\u0026back=(255,255,255)\" --output radial_qr.png\n\n---\n\n## Additional Endpoints 🌐\n\n1. ### Health Check 🩺\n  \n\n**Endpoint:** `/health`\n\n**Method:** `GET` or `POST`\n\n**Response:**\n\n    {\n        \"status\": \"OK\"\n    }\n\n2. ### Index 📃\n  \n\n**Endpoint:** `/`\n\n**Method:** `GET`\n\n**Response:** : The response is an HTML page wherer you can generate qr codes.\n\n---\n\n⭕ **Note:** This README assumes that the API is running on the default host (0.0.0.0) and port (8080). Update the base URL accordingly if you choose to run the API on a different host or port.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzingzy%2Fqrcode-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzingzy%2Fqrcode-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzingzy%2Fqrcode-api/lists"}