# QR Code API (bulk, image/logo support) (`practicaltools/qr-code-api`) Actor $0.004 API to generate QR codes with various customization options including colors and custom logo / image. - **URL**: https://apify.com/practicaltools/qr-code-api.md - **Developed by:** [Practical Tools](https://apify.com/practicaltools) (community) - **Categories:** Automation, Integrations, Social media - **Stats:** 9 total users, 2 monthly users, 100.0% runs succeeded, 1 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing $4.99 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event ## What's an Apify Actor? Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. - **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use). - **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`. - **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`. - **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`. - **Any other language** — the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## QR Code Generator Actor An Apify Actor that generates customizable QR codes with support for bulk generation, custom styling, and logo overlays. ### Features - ✅ Generate QR codes for URLs, text, WiFi credentials, or any string content - ✅ **Bulk generation** - Generate multiple QR codes in a single run - ✅ **Custom colors** - Customize dark and light module colors - ✅ **Multiple formats** - Output as PNG (base64 data URL) or SVG - ✅ **Logo overlay** - Add your brand logo to the center of QR codes - ✅ **Error correction** - Automatic high error correction when using logos - ✅ **Flexible sizing** - Customize QR code and logo dimensions ### Input The Actor accepts the following input parameters: | Parameter | Type | Required | Description | Default | | ---------------------- | ------- | -------- | ------------------------------------------------------------------------ | ------------------ | | `content` | array | ✅ | List of strings to encode as QR codes (URLs, text, etc.) | `["https://example.com/"]` | | `format` | string | ❌ | Output format: `png` or `svg` | `png` | | `size` | integer | ❌ | Width and height of the QR code in pixels (50-2000) | `300` | | `colorDark` | string | ❌ | Color of dark modules (hex format) | `#000000` | | `colorLight` | string | ❌ | Color of light modules (hex format) | `#ffffff` | | `errorCorrectionLevel` | string | ❌ | Error correction level: `L` (7%), `M` (15%), `Q` (25%), or `H` (30%) | `M` (auto `H` with logo) | | `logoUrl` | string | ❌ | URL of a logo image to overlay on the QR code | - | | `logoWidth` | integer | ❌ | Logo width in pixels (defaults to 15% of QR code size) | - | | `logoHeight` | integer | ❌ | Logo height in pixels (defaults to 15% of QR code size) | - | #### Input Example ```json { "content": [ "https://example.com/", "https://apify.com/", "mailto:hello@example.com" ], "format": "png", "size": 400, "colorDark": "#1a237e", "colorLight": "#e8eaf6", "errorCorrectionLevel": "H", "logoUrl": "https://example.com/logo.png", "logoWidth": 60, "logoHeight": 60 } ``` ### Output The Actor saves results to the default dataset. Each item in the output contains: | Field | Type | Description | | ------------------ | ------ | --------------------------------------------------------------- | | `originalContent` | string | The original input content that was encoded | | `qrCodeDataUrl` | string | Base64-encoded PNG data URL (when `format` is `png`) | | `qrCodeSvg` | string | SVG markup string (when `format` is `svg`) | #### Output Example ```json [ { "originalContent": "https://example.com/", "qrCodeDataUrl": "data:image/png;base64,iVBORw0KGgoAAAANS..." }, { "originalContent": "https://apify.com/", "qrCodeDataUrl": "data:image/png;base64,iVBORw0KGgoAAAANS..." } ] ``` ### Usage Tips #### Logo Overlay When using a logo overlay: - The error correction level is automatically set to `H` (High - 30%) for better scannability - Logos are automatically sized to 15% of the QR code dimensions (customizable via `logoWidth`/`logoHeight`) - A white background is added around the logo for better contrast - Supported logo formats: PNG, JPG, SVG #### Error Correction Levels - **L (Low)** - ~7% error resistance - Best for clean, controlled environments - **M (Medium)** - ~15% error resistance - Good general-purpose level - **Q (Quartile)** - ~25% error resistance - Better for outdoor use - **H (High)** - ~30% error resistance - Required for logos, best for damaged/dirty conditions #### Bulk Generation To generate multiple QR codes in one run, simply add multiple strings to the `content` array: ```json { "content": [ "https://example.com/product1", "https://example.com/product2", "https://example.com/product3" ] } ``` Each QR code will be saved as a separate item in the dataset with its `originalContent` for easy identification. This reads input from `storage/key_value_stores/default/INPUT.json` and saves output to `storage/datasets/default/`. ### Resources - [Apify Platform](https://apify.com) - [Apify SDK Documentation](https://docs.apify.com/sdk/js) # Actor input Schema ## `content` (type: `array`): A list of content strings to generate QR codes for. Click 'Add' to add more items. ## `format` (type: `string`): The desired output format for the QR code. ## `size` (type: `integer`): The width of the QR code in pixels. ## `colorDark` (type: `string`): The color of the dark modules in the QR code (hex format). ## `colorLight` (type: `string`): The color of the light modules in the QR code (hex format). ## `errorCorrectionLevel` (type: `string`): The error correction level to use. ## `logoUrl` (type: `string`): URL of a logo to overlay on the QR code. The logo will be centered. Best results with square logos. ## `logoWidth` (type: `integer`): The width of the logo in pixels. Defaults to a percentage of the QR code size if not provided. ## `logoHeight` (type: `integer`): The height of the logo in pixels. Defaults to a percentage of the QR code size if not provided. ## Actor input object example ```json { "content": [ "https://example.com/" ], "format": "png", "size": 300, "colorDark": "#000000", "colorLight": "#ffffff", "errorCorrectionLevel": "M" } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("practicaltools/qr-code-api").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("practicaltools/qr-code-api").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}") for item in client.dataset(run.default_dataset_id).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call practicaltools/qr-code-api --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "type": "http", "url": "https://mcp.apify.com/?tools=fetch-actor-details,practicaltools/qr-code-api" } } } ``` The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer ` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations). ## OpenAPI specification Download the OpenAPI definition: https://api.apify.com/v2/actors/sSuyCJwnWG9SzjFtf/builds/FqgYO6jWH40y1Fv5x/openapi.json