Skip to main content
GET
Render a QR code

Path Parameters

format
enum<string>
required

Output image file extension.

Available options:
svg,
jpg,
png,
webp

Query Parameters

data
string
required

Canonical standard Base64 encoding of 1–512 bytes of UTF-8 text.

Required string length: 4 - 684
size
integer
default:256

Square raster size in pixels. Defaults to 256 for JPEG, PNG, and WebP and is ignored for SVG.

Required range: 64 <= x <= 2048
quiet_zone
boolean
default:true

Keep clear space around the QR modules for reliable scanning. Defaults to true.

foreground
string
default:#000000ff

QR module color as a six-digit RGB or eight-digit RGBA hex value.

Pattern: ^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$
background
string
default:#00000000

QR background color as a six-digit RGB or eight-digit RGBA hex value. Transparency is composited onto white for JPEG output.

Pattern: ^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$

Response

Deterministic QR code image.

The response is of type string.