API Documentation

ZipQR provides simple, high-performance REST APIs to integrate URL shortening and custom styled QR generation.

POST /

URL Shortener & QR

Shorten long URLs using custom service engines. Generates an associated QR code automatically.

Request Form Parameters

url (Required)

string (URL)

The long target URL to shorten. Must include protocol (http:// or https://).

service (Optional, Default: "random")

string

Selected engine domain: random, tinyurl, is.gd, v.gd, clck.ru, da.gd, cleanuri.

Response (JSON)

{
  "short_url": "https://da.gd/vWpSf",
  "original_url": "https://github.com/tanbaycu",
  "qr_code": "iVBORw0KGgoAAAANSUhEUg...",
  "processing_time": "0.41s"
}

cURL Example

curl -X POST http://127.0.0.1:5000/ \
-d "url=https://github.com/tanbaycu" \
-d "service=da.gd"

POST /generate-qr

QR Custom Styles & Logos

Generate custom QR Codes with selectable pixel pattern styles and brand center logos.

Request JSON Parameters

content (Required)

string

Data payload to encode in the QR Code.

color (Optional, Default: "#000000")

string (HEX Color)

HEX representation of foreground color.

size (Optional, Default: 250)

integer

Resolution dimension in pixels. Minimum 150, maximum 500.

drawer (Optional, Default: "square")

string

Pixel layout pattern: square, rounded, circle, gapped.

logo_type (Optional, Default: "none")

string

Type of center icon: none, zipqr, facebook, instagram, github, upload.

logo_data (Required if logo_type is "upload")

string (Base64)

Base64-encoded image string of custom logo. Include mime header (e.g. data:image/png;base64,...).

Response (JSON)

{
  "qr_code": "iVBORw0KGgoAAAANSUhEUg...",
  "content": "ZipQR",
  "color": "#ff6b6b",
  "size": 300,
  "drawer": "rounded",
  "logo_type": "zipqr"
}

cURL Example

curl -X POST http://127.0.0.1:5000/generate-qr \
-H "Content-Type: application/json" \
-d '{"content":"ZipQR","color":"#ff6b6b","drawer":"rounded","logo_type":"zipqr"}'