Render
Keyless

Render a QR code without an API key

No key and no account. A smaller surface than GET /api/qr: SVG and PNG only, at most 512 pixels, at most 512 bytes of content, and only color, bgcolor, margin and ecc for design. Any other parameter is refused by name.

The allowance is counted in units of work against two buckets — the caller and the source address — so one caller behind a shared address cannot spend everyone else's. Send an opaque, stable id per installation in X-QRSalt-Client to be counted separately under that address's ceiling.

Images are served with Cache-Control: public, max-age=300 and X-Robots-Tag: noindex.

get/api/qr/free

Request

  • Base URL: https://app.qrsalt.com
  • URL: https://app.qrsalt.com/api/qr/free
  • Auth: none required

Query parameters

datastring

The exact string to encode. text is accepted as the same thing. Required; at most 512 bytes.

textstring

An alias of data.

format'svg' | 'png'

Default svg.

sizeinteger

Pixel width, 64 to 512.

margininteger

Quiet zone in modules, not pixels.

ecc'L' | 'M' | 'Q' | 'H'

Error-correction level.

colorstring

Foreground, as a hex colour: 1F2937, #1F2937 or the three-digit forms.

bgcolorstring

Background, as a hex colour.

Headers

X-QRSalt-Clientstring

An opaque, stable id per installation, so callers behind one shared address are counted separately under that address's ceiling. Fairness, never identity: nothing is granted on the strength of it. Read only when it matches [A-Za-z0-9._-]{1,64}.

Response

The image.

Changes

No recorded changes to this operation across all 1 revision of this API.