Render

Render a static QR code

Draws a QR code as SVG, PNG, JPG, WebP or PDF. Static: the content is inside the pattern and nothing is stored.

Send either data (the exact string to encode) or a type with that type's own fields — never both. The key is checked, and counted against its rate limit, before any parameter is read.

frame, label and framecolor are refused by name: the API returns the code alone.

get/api/qr

Request

  • Base URL: https://app.qrsalt.com
  • URL: https://app.qrsalt.com/api/qr
  • Auth: HTTP bearer

Query parameters

datastring

The exact string to put in the code, at most 2000 bytes. Send this or a type, never both.

textstring

An alias of data, and the content field of type=text.

qstring

An alias of data.

type'url' | 'link' | 'website' | 'text' | 'wifi' | 'email' | 'phone' | 'tel' | 'sms' | 'vcard' | 'contact' | 'gs1' | 'product' | 'review' | 'location' | 'map' | 'geo' | 'event' | 'calendar' | 'ical' | 'vevent' | 'payment' | 'pay'

The content type to build from its own fields. The lower-case names are the documented ones; the aliases beside them are accepted too.

urlstring

type=url. Also an optional field of type=event.

ssidstring

type=wifi, required.

passwordstring

type=wifi.

encryptionstring

type=wifi.

hiddenstring

type=wifi. A checkbox: 1, true, on or yes is true.

emailstring

type=email, required. Also an optional field of type=vcard.

subjectstring

type=email.

bodystring

type=email.

ccstring

type=email.

bccstring

type=email.

phonestring

type=phone and type=sms, required. Also an optional field of type=vcard.

extensionstring

type=phone.

messagestring

type=sms.

firstNamestring

type=vcard, required.

lastNamestring

type=vcard.

organizationstring

type=vcard.

titlestring

type=vcard (job title) and type=event (the event's title, required).

websitestring

type=vcard.

workPhonestring

type=vcard.

streetstring

type=vcard.

citystring

type=vcard.

regionstring

type=vcard.

postalCodestring

type=vcard.

countrystring

type=vcard.

notestring

type=vcard and type=payment.

domainstring

type=gs1: the domain the Digital Link is built on.

gtinstring

type=gs1, required.

batchstring

type=gs1.

serialstring

type=gs1.

expirystring

type=gs1.

platformstring

type=review, required.

valuestring

type=review, required.

querystring

type=location.

latitudestring

type=location.

longitudestring

type=location.

mapsLinkstring

type=location.

startstring

type=event, required.

endstring

type=event.

timeZonestring

type=event.

allDaystring

type=event. A checkbox: 1, true, on or yes is true.

locationstring

type=event.

descriptionstring

type=event.

providerstring

type=payment, required.

handlestring

type=payment.

payeestring

type=payment.

amountstring

type=payment.

currencystring

type=payment.

format'svg' | 'png' | 'jpg' | 'webp' | 'pdf'

jpeg is accepted as jpg.

sizeinteger

Pixel width for SVG, PNG, JPG and WebP.

mmnumber

Printed width for the PDF, in millimetres.

colorstring

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

bgcolorstring

Background, as a hex colour.

eyecolorstring

The finder patterns, as a hex colour.

style'square' | 'rounded' | 'dots' | 'classy'

Module shape. Sets a matching eye style unless eyes says otherwise.

eyes'square' | 'rounded' | 'circle'

Both halves of the finder patterns. Clears eyeframe and eyeball.

eyeframe'square' | 'rounded' | 'circle' | 'leaf' | 'leaf-flip' | 'drop'

The ring of each finder pattern.

eyeball'square' | 'rounded' | 'circle' | 'leaf' | 'leaf-flip' | 'drop'

The centre of each finder pattern.

eyeturn0 | 180

Clockwise turn of both halves of every finder pattern. Only the angles the renderer draws; anything else is refused rather than rounded.

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

Error-correction level.

margininteger

Quiet zone in modules, not pixels.

Response

The image.

Changes

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