REST API
Use our REST API to generate QR codes on platforms we don't offer support for, or to build custom integrations.
Note that rate limits may apply for these endpoints. Abuse of these endpoints may result in traffic being blocked, and in extreme cases license keys being revoked
QR Codes
Generate QR codes and have the image returned to you in the format you specify.
Generate QR code
GET
https://qrcodegenerator.api.littleappy.co/qrcode/basic
Creates and returns a QR code in the specified file format.
Query Parameters
Name | Type | Description |
---|---|---|
Content* | String | The URL encoded content to be embedded within the generated QR code, such as a URL or text. This is what is displayed/used by QR code readers. |
License | String | License key, required to avoid watermark and use paid license features. |
PixelsPerModule | Double | Default value: 20 Number of pixels per module. For example, 20 pixels per module will result in an image approximately 400x400px. |
PrimaryColor | String | Default value: #000 The colour of the code pattern. Must be a valid HEX code. |
SecondaryColor | String | Default value: #FFF The colour of the code background. Must be a valid HEX code. |
EnableMargin | Bool | Default value: true Adds a margin around the outside of the QR code. Otherwise known as the quiet zone. |
ErrorCorrectionLevel | String | Default value: M Accepted values: Q, H, L, M Uses the Reed-Solomon Code to correct the QR code content if the code is partially unreadable (eg. through damage or dust). The higher the level, the more data is stored making the image larger. |
Size | String | Default value: 150 Size of QR code, specified in pixels |
Heading | String | Optional heading string that shows below the QR code. Truncation will occur if the string length is longer than the QR code, but this depends on the size of your QR code specified in |
Subtitle | String | Optional subtitle string that shows below the QR code. Truncation will occur if the string length is longer than the QR code, but this depends on the size of your QR code specified in |
FileType | String | Default value: Svg Accepted values: Svg, Jpg, Png, Gif, Ascii File format that the QR code is returned in. Note that some formats require a paid license, or may not support all functionality listed above. |
Generate QR code
POST
https://qrcodegenerator.api.littleappy.co/qrcode/basic
Creates and returns a QR code in the specified file format.
Request Body
Name | Type | Description |
---|---|---|
License | String | License key, required to avoid watermark and use paid license features. |
PixelsPerModule | Double | Default value: 20 Number of pixels per module. For example, 20 pixels per module will result in an image approximately 400x400px. |
PrimaryColor | String | Default value: #000 The colour of the code pattern. Must be a valid HEX code. |
SecondaryColor | String | Default value: #FFF The colour of the code background. Must be a valid HEX code. |
EnableMargin | Bool | Default value: true Adds a margin around the outside of the QR code. Otherwise known as the quiet zone. |
ErrorCorrectionLevel | String | Default value: M Accepted values: Q, H, L, M Uses the Reed-Solomon Code to correct the QR code content if the code is partially unreadable (eg. through damage or dust). The higher the level, the more data is stored making the image larger. |
Size | String | Default value: 150 Size of QR code, specified in pixels |
Heading | String | Optional heading string that shows below the QR code. Truncation will occur if the string length is longer than the QR code, but this depends on the size of your QR code specified in |
Subtitle | String | Optional subtitle string that shows below the QR code. Truncation will occur if the string length is longer than the QR code, but this depends on the size of your QR code specified in |
FileType | String | Default value: Svg Accepted values: Svg, Jpg, Png, Gif, Ascii File format that the QR code is returned in. Note that some formats require a paid license, or may not support all functionality listed above. |
Content | String | The URL encoded content to be embedded within the generated QR code, such as a URL or text. This is what is displayed/used by QR code readers. |
QR Code Icons
Specify an image to be placed in the center of your generated QR codes. This is useful for marketing and brand recognition, but may hamper the readability of your QR codes if the image is too large.
Upload icon to include in QR code
POST
https://qrcodegenerator.api.littleappy.co/qrcode/icon
Premium feature only - requires license key to use
Upload a PNG or JPG image to embed in the middle of your generated QR codes.
Request Body
Name | Type | Description |
---|---|---|
licenseKey* | String | The license key provided to you when you purchased your subscription |
emailAddress* | String | The email address you used when purchasing your license key |
iconUrl* | String | URL to the image. Must be publicly hosted on the Internet somewhere for us to download the image, such as Dropbox, your website or another storage provider |
Upload icon to include in QR code
DELETE
https://qrcodegenerator.api.littleappy.co/qrcode/icon
Premium feature only - requires license key to use
Delete a PNG or JPG image that's being embedded in the middle of your generated QR codes.
Request Body
Name | Type | Description |
---|---|---|
licenseKey* | String | The license key provided to you when you purchased your subscription |
emailAddress* | String | The email address you used when purchasing your license key |
Last updated