Getting started
Quickstart
Create your first dynamic QR, watch a scan arrive in real time, and print it — all in under a minute.
Get an API key
Sign up for a free QRMax account. Free plan includes 1,000 API calls per day — no credit card required. After signing in, go to Dashboard → Settings → API Keys and click Create key.
Export it as an env var
Store the key in your shell profile or .env file.
export QRMAX_API_KEY="qrmx_live_sk_..."Create your first dynamic QR
One curl call and you're done.
curl https://api.qrmax.io/api/v1/qr-codes \
-X POST \
-H "Authorization: Bearer $QRMAX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "url",
"target": "https://example.com/welcome",
"dynamic": true
}'You'll get back a response like:
{
"id": "qr_01HNPAXK8X7F...",
"shortUrl": "https://qrx.io/a3b9c2",
"imageUrl": "https://cdn.qrmax.io/qr/qr_01HNPAXK.png",
"target": "https://example.com/welcome",
"dynamic": true
}Scan it
Open the imageUrl on any screen, scan with your phone, and you'll be redirected. Head back to your dashboard — the scan is already there.
Update the destination (anytime)
The printed code never changes, but you can re-target it on demand:
curl https://api.qrmax.io/api/v1/qr-codes/qr_01HNPAXK8X7F \
-X PATCH \
-H "Authorization: Bearer $QRMAX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target": "https://example.com/summer-sale"}'You're done!
You now have a dynamic QR code with analytics, re-targetable destination, and a global CDN-cached short URL. See the full API reference for every endpoint.