API Documentation

Use fast APIs to create stylish QR codes with a logo that matches your brand – or trade style for speed and generate basic QR codes even faster.

 

Our APIs are available publicly available on RapidAPI marketplace, if you have further requirements contact us.

Create Stylish APIs

API Collection

/qrcode POST Create QR codes using JSON object as body
GET Create QR codes using query parameters - requires url-encoding
/qrcode/upload-image POST Upload image using multipart body containing image and form field

Usage Tips

 

APIs are designed for performance and provisioned regionally on fast hardware.

 

Follow these guidelines to further optimized speed and QR code quality:

For the best quality generate QR codes as svg images

Use svg images as logo rather then png or jpeg

Use size and unit parameters to specify dimensions

Make sure QR codes have sufficient contrast

Do not change the generated QR code or overlay them

Test QR codes with different devices

Generate QR Code API

Url /qrcode
Method GET and POST
Request Header
x-rapidapi-key [your key]
x-rapidapi-host custom-qr-code-with-logo-fast2.p.rapidapi.com
Response
Image formatted svg, png, or jpeg. Private plans support pdf as well
Header
x-size-px Size of the generated QR code image expressed in pixels
x-request-id Unique id to be used when requesting support

API Parameters

 

Learn to use these API parameters in our tutorials.

Parameter Type Default Description
data *
String
Data to encode, for example, URL, email address or just plain text
format String svg
QR code image format either svg, png, or jpeg. Private plans also support pdf
size 1
Number 144
Size is expressed by the unit parameter. Calls return header parameter x-size-px which contains the size in px
unit String px
Size unit expressed in px (default), inch, mm, or cm
download Boolean false Automatically download the QR code image in the browser, useful for GET requests
style Object {}
Custom style QR codes on color, shape, logo, and more. Find more information here

* Mandatory Parameter (max 500 characters)

 

1 Reference Dimensions

Default Minimum Maximum
144 px 77 px 288 px
1.5 inch 0.8 inch 3 inch
3.81 cm 2 cm 7.62 cm
38.1 mm 20 mm 76.2 mm

API Style Parameter

 

See how easy it is to style QR codes following these examples

Rotate your mobile device to fully view this documentation

Parameter Type Default Description
logo String
Name of a previously uploaded logo. Learn how to upload and apply logos here
removeLogoBackground Boolean false Remove the background behind the logo
color String #000000 QR Code body color as a HEX value. This parameter contains the first gradient color when applying a color gradient
backgroundColor String #ffffff Background color as a HEX value
gradient String
Gradient horizontal, vertical, radial, or angular. Requires parameters color as the first color and gradientColor as the final color
gradientColor String The final gradient color, as a HEX value, when applying a color gradient style
moduleShape String
squareslines-horizontal
lines-verticalcircles
dotsdiamonds
post-itsrope
edge-squareedge-rounded
edge-circlearrow-square
arrow-diamonddigital
wedge-smoothwedge
joint-smoothjoint
stars
eyeFrameShape String
squarerounded
roundbutton
coasterleaf
droptriangle
post-itscircles
chainear
eyeBallShape String
squarerounded
roundbutton
coasterleaf
droptriangle
coilcircles
chaintires
eyeFrameColorTopLeft String Top-left eye-frame color as a HEX value
eyeBallColorTopLeft String Top-left eye-ball color as a HEX value
eyeFrameColorTopRight String Top-right eye-frame color as a HEX value
eyeBallColorTopRight String Top-right eye-ball color as a HEX value
eyeFrameColorBottomLeft String Bottom-left eye-frame color as a HEX value
eyeBallColorBottomLeft String Bottom-left eye-ball color as a HEX value

Upload logo API

 

This API is implemented following W3 recommendation for using multipart/form-data

Url /qrcode/upload-logo
Method POST
Request Header
x-rapidapi-key [your key]
x-rapidapi-host custom-qr-code-with-logo-fast2.p.rapidapi.com
Content-Type multipart/form-data
Body
Form-field name file with [your-filename] and Content-Type set to the MIME-type
Response
{ "logo": "your-filename" }
Header Value
x-request-id Unique id used as a reference for support

POST Request

 

Create stylish QR codes with a logo and upload svg, png, or jpeg images.

 

Set header parameter Content-Type to multipart/form-data and add a form-field named file with the image name.

 

After the call parameter logo holds the logo id and must be included in the QR code style object.

 

Learn in more detail how to add a logo to QR codes in this tutorial.

 

The header parameter x-request-id contains a unique id and is used as a reference for support.