Developer QR Code API Guide

API Key

The API key for your account can be created on the account page. The API key can be included in requests either as a URL parameter, for example: https://genqrcode.com/api/public/generate?apikey=YOUR_API_KEY, or within the `GenQRCode-apikey` header. For the rest of this guide, we will assume the usage of the header, as this is the safer option, but both methods can be used interchangeably. The API key should be considered a secret, and you should not share it with anyone.

Rate limiting

Rate limiting is enforced to ensure fair usage of the API. The Free tier includes 180 tokens per hour. Normal QR codes cost 1 token each, with a maximum hourly limit of 180 tokens, equating to 1 QR Code every 20 seconds. Additionally, the fast call endpoints will cost 1/50th of a token, which equates to 2.5 QR Codes per second. These fast endpoints are recommended when no customization of the QR Code is required. If the token limit is exceeded, a status code of 429 will be returned, indicating that the request has been rate-limited.

The usage of multiple accounts to circumvent these limits is forbidden. If higher limits are needed, please contact us for the pricing.

Libraries

Java Library

Static QR Code API

Example text QR Code

URL	https://api.genqrcode.com/public/generate
Request method	POST
Headers	GenQRCode-apikey: API_KEY
Body	{ "type": 0, "text": "https://genqrcode.com" }
Response

Example Wi-Fi QR Code

URL	https://api.genqrcode.com/public/generate
Request method	POST
Headers	GenQRCode-apikey: API_KEY
Body	{ "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" }
Response

Example Color QR Code

URL	https://api.genqrcode.com/public/generate
Request method	POST
Headers	GenQRCode-apikey: API_KEY
Body	{ "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" }
Response

Example color pattern QR Code

URL	https://api.genqrcode.com/public/generate
Request method	POST
Headers	GenQRCode-apikey: API_KEY
Body	{ "type": 0, "text": "https://genqrcode.com", "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d", "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6" }
Response

Frame, Shape and Logo parameters

Here are all the customizable frame, shape and logo params described on how to use them.

Parameter	Type	Default value	Description
style	Int	0	Style of the QR Code squares. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
inner_eye_style	Int	0	Style of the QR Code inner eyes. 0 1 2 3 4 5 6 7
outer_eye_style	Int	0	Style of the QR Code outer eyes. 0 1 2 3 4 5 6
frame_style	Int	0	Style of the frame around the QR Code. 0 1 2 3 4 5 6 7 8 9 10 11 12 13
frame_text	String	SCAN ME	The text inside the frame. A frame with text must be configured before this becomes visible.
logo	String		The logo to use inside the QR Code. youtube wifi google-maps facebook spotify threads zoom instagram linkedin genqrcode google-drive airbnb skype snapchat twitter x-twitter reddit
logo_remove_background	Boolean	false	Whether the background behind the logo should be removed.

Example logo and shape QR Code

URL	https://api.genqrcode.com/public/generate
Request method	POST
Headers	GenQRCode-apikey: API_KEY
Body	{ "type": 0, "text": "https://x.com/genqrcode", "style": 22, "inner_eye_style": 1, "outer_eye_style": 4, "frame": 10, "frame_text": "My X Page", "logo": "x-twitter", "logo_remove_background":true }
Response

Fast QR Code API

The Fast QR Code API cost only 1/50 tokens of the normal API. The QR Codes are optimised for speed and download size. While it support all of the QR Code Types, it only supports a few customization parameters.

Example fast text QR Code

URL	https://api.genqrcode.com/public/fastgenerate
Request method	POST
Headers	GenQRCode-apikey: API_KEY
Body	{ "imageformat": "png", "type": 0, "text": "https://genqrcode.com" }
Response

Fast Batch QR Code API

{
  "QR Code 1": {
    "text": "https://genqrcode.com",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 2": {
    "text": "https://genqrcode.com/dynamicview",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 3": {
    "text": "https://genqrcode.com/pricing",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  }
}