QR Code API
The QR Code API turns any string (a URL, contact card, Wi-Fi configuration or plain text) into a PNG QR code.
- Endpoint:
POST /api/v1/qrcode(reference) - Permission:
qrcode.generate - Price: 1 credit per successful image; failed requests are free.
- Output: PNG, 64–2048 pixels square.
Options
| Option | Type | Default | Notes |
|---|---|---|---|
data |
string | (required) | Up to 2,048 bytes of UTF-8 text. |
format |
png |
png |
Only PNG is supported. Other values return 415 unsupported_format. |
size |
integer | 512 | 64–2048 pixels. |
error_correction |
low medium quartile high |
medium |
Recovers about 7%, 15%, 25% and 30% of damaged codewords. Use high for print. |
foreground |
hex colour | #000000 |
Keep strong contrast with the background. |
background |
hex colour | #FFFFFF |
|
margin |
boolean | true |
The standard 4-module quiet zone. Disable only if you add your own. |
Unknown fields are rejected with 422 validation_error.
Privacy
We encode the string you send; we never visit or fetch URLs. Request data is not stored or logged.
Implementation notes
Images are produced with the open-source go-qrcode library (MIT). It is mature and stable but no longer actively developed; SVG output and styled codes will ship only once implemented and tested on a library that supports them natively.
Continue with the quickstart.