Create Stunning QR Codes
with Pixel-Perfect Control

✨ Key Features

🎯 Use Cases

🚀 Quick Start

Generate your first branded QR code in seconds. Copy the example below:

curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/generate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "https://mywebsite.com",
    "moduleShape": "circle",
    "primaryColor": "#6366f1"
  }'

🔐 Authentication

This API is accessed through RapidAPI. All authentication is handled automatically by RapidAPI when you subscribe to the API.

X-RapidAPI-Key: YOUR_RAPIDAPI_KEY
X-RapidAPI-Host: qr-branding-api.p.rapidapi.com

Generate Custom QR

The primary endpoint. Send a JSON configuration object to generate a fully customized QR code image. Returns a Base64-encoded image.

Complete Example Request

{
  // Required
  "content": "https://mybrand.com",
  
  // Output Settings
  "outputWidth": 1024,
  "fileFormat": "png",
  
  // Style
  "moduleShape": "circle",
  "primaryColor": "#6366f1",
  "secondaryColor": "#ec4899",
  "gradientType": "radial",
  "backgroundColor": "#ffffff",
  
  // Eye Customization
  "eye1": { 
    "outerShape": "circle", 
    "outerColor": "#6366f1" 
  },
  
  // Frame
  "frame": {
    "enabled": true,
    "color": "#6366f1",
    "width": 8,
    "cornerRadius": 20
  },
  
  // Logo
  "logoUrl": "https://example.com/logo.png",
  "logoShape": "circle",
  
  // Text
  "ctaText": "SCAN ME"
}

Response (Base64 Mode)

When responseType: "base64" (default), you receive a JSON response:

{
  "success": true,
  "qrBase64": "iVBORw0KGgoAAAANSUhEUgAA...",
  "format": "png",
  "contentType": "image/png",
  "sizeBytes": 24680
}

Response Fields

Response (Binary Mode)

When responseType: "binary", you receive the file directly:

// Binary file data returned directly
// Content-Disposition: attachment; filename="qrcode.png"
// Content-Type: image/png (or image/svg+xml, application/pdf, etc.)

Example: Download PDF

curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/generate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "https://mywebsite.com",
    "fileFormat": "pdf",
    "responseType": "binary",
    "moduleShape": "circle",
    "primaryColor": "#6366f1"
  }' --output qrcode.pdf

Example: Get SVG as Base64

curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/generate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "https://mywebsite.com",
    "fileFormat": "svg",
    "responseType": "base64",
    "primaryColor": "#f72585"
  }'

📤 Multipart Logo Upload

Instead of using logoUrl or logoBase64, you can upload your logo directly as a binary file using multipart/form-data. This is ideal when your logo isn't publicly accessible.

Multipart Request Structure

cURL Example

curl -X POST "https://qr-branding-api.p.rapidapi.com/api/qr/generate" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: qr-branding-api.p.rapidapi.com" \
  -F 'config={"content":"https://mysite.com","moduleShape":"circle","primaryColor":"#f72585"}' \
  -F "logoFile=@/path/to/logo.png"

📦 Basic Parameters

📐 Output & Resolution

Control the final image size, format, and response type for different use cases.

Response Types Explained

Format Comparison

🎨 Colors & Gradients

⬡ Module Shapes

Transform the individual data modules of your QR code into unique shapes.

👁️ Eye Customization

The three finder patterns (corners) can be styled globally or individually. Individual eye settings override global defaults.

Global Eye Defaults

Individual Eye Overrides

Eye Object Structure

{
  "outerShape": "circle",      // Optional: "square" | "circle" | "roundedSquare"
  "innerShape": "circle",      // Optional: "square" | "circle" | "roundedSquare"
  "outerColor": "#ff0000",     // Optional: Hex color for outer frame
  "innerColor": "#0000ff"      // Optional: Hex color for inner pupil
}

🖼️ Background Options

Customize the QR code background with solid colors, transparency, or images.

🔲 Frame Options

Wrap the QR code in a decorative border frame. The frame automatically adjusts padding to prevent corner overlap.

🏷️ Logo Integration

Embed a logo in the center of your QR code. The logo is automatically sized to ~22% of the QR area.

✍️ Text Overlays

Center Text Strip

Add a text band that cuts through the center of the QR code.

Footer CTA (Call to Action)

Add promotional text below the QR code.

📚 Get Templates

Retrieve a curated library of pre-designed QR configurations. Use these as starting points or apply them directly.

Available Templates

Response

{
  "success": true,
  "count": 12,
  "templates": [
    {
      "id": "tech-neon",
      "name": "Cyber Neon",
      "category": "Technology",
      "config": { ... }
    },
    ...
  ]
}

📶 Generate WiFi String

Generate a WiFi connection string that users can scan to auto-connect to a network.

Request Parameters

{
  "ssid": "MyNetwork",
  "password": "secret123",
  "encryption": "WPA",
  "hidden": false
}

{
  "text": "WIFI:S:MyNetwork;T:WPA;P:secret123;H:false;;"
}

👤 Generate vCard String

Generate a vCard contact string that adds contact info directly to the scanner's address book.

Request Parameters

{
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+1234567890",
  "email": "john@example.com",
  "org": "Acme Inc",
  "url": "https://example.com"
}

{
  "text": "BEGIN:VCARD\nVERSION:3.0\nN:Doe;John\nFN:John Doe\nORG:Acme Inc\nTEL:+1234567890\nEMAIL:john@example.com\nURL:https://example.com\nEND:VCARD"
}

📍 Generate Geo String

Generate a geographic location string that opens the location in the user's maps app.

Request Parameters

{
  "lat": 40.7128,
  "lng": -74.0060
}

{
  "text": "geo:40.7128,-74.006"
}