Click for QRickit HomeClick on me to go back.I can help you make and use QR codes.

About QR CodesQR Code CreatorQR Code TrackingQR Code MarketingQR Code WidgetQR Code APIQReative Ideas at the QRickit BlogContact QRickit

QRickit QR Code API

Dynamically generate and display QRickit QR Codes on your web pages

The QRickit QR Code API (web service) allows you to dynamically generate and display QR Codes on your web pages. The API is free for personal and commercial use (though we reserve the right to restrict excessively high volume API requests). Please contact QRickit beforehand if you expect to regularly have over 5,000 API requests per day.

If you use this free service, QRickit would be happy if you link to http://QRickit.com and recommend QRickit to your users, friends and colleagues. QRickit wants to know if you are using it and your feedback. Please click here to tell QRickit. You can also follow, share and comment at the QRickit blog, Facebook, MySpace, and Twitter. You can also make a donation below to help QRickit continue to provide this free web service.

This free service is provided "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. QRickit and its developers, staff, owners, executives, and partners are not responsible for any loss or damage incurred through the use of this free service. The functionality and/or uninterrupted availability of this free service is not guaranteed. QRickit reserves the right to reject API requests, especially in regards to abuse or malicious use.

How to Use the QRickit API

Basic format of GET request: http://qrickit.com/api/qr?d=yourdata

Instructions: Use HTML <img> tag like example below wherever you want the QRickit QR Code(s) to appear in your web page.

<img src="http://qrickit.com/api/qr?d=http://anyurl&addtext=Hello+World&txtcolor=442EFF&fgdcolor=76103C
&bgdcolor=C0F912&qrsize=150&t=p&e=m">

The above HTML example produces the following image (png file type):

Data: only "d" (highlighted in red) is required. This is the data to be embedded into the QR Code.

Example: d=http://anyurl (when scanned, mobile users can go to any URL you specify)
Example: d=anytext (when scanned, mobile users can read your text message)
Example: d=TEL:5551231234 (when scanned, mobile users can add your TEL# to their contacts and dial number)
Example: d=MAILTO:me@qrickit.com (when scanned, mobile users can add your EMAIL address to their contacts and send email)
Example: d=SMSTO:5551231234:anytext (when scanned, mobile users can add your SMS# to their contacts and send SMS message)
Example: d=<?php echo urlencode($yourdata);?> (example using PHP to specify "d")

*It is best to urlencode data. (online urlencoder)
*Remember to use "?" before first parameter.
*It is best to keep the data short. If possible use a URL shortener like goo.gl, especially if your URL is over 100 characters long.
*For tips on using the right URL data click here.

Below are optional parameters for customization of footer text, colors, size, file type, etc.

Footer Text: addtext=Any text about 15 to 60 characters maximum depending on the size of your QR Code. Text can be urlencoded to avoid problems with special characters. Double-byte characters, such as Japanese, or other than 8-bit characters are not compatible. (online urlencoder)
Example:
addtext=Hello+World
Example: addtext=<?php echo urlencode($yourtext);?>

Footer Text Color: txtcolor=The color of your footer text expressed in HTML Hex# (i.e. FFFFFF for white, 000000 for black, etc.). If nothing is specified, the default is black (000000).
Example:
txtcolor=FF0000
(click icon to find the HTML Hex# for your color)

QR Code Color: fgdcolor=The color of your QR Code expressed in HTML Hex# (i.e. FFFFFF for white, 000000 for black, etc.). If nothing is specified, the default is black (000000).
Example:
fgdcolor=000000
(click icon to find the HTML Hex# for your color)

Background Color: bgdcolor=The color of the background expressed in HTML Hex# (i.e. FFFFFF for white, 000000 for black, etc.). If nothing is specified, the default is white (FFFFFF).
Example:
bgdcolor=FFFFFF
(click icon to find the HTML Hex# for your color)

Image Size: qrsize=The image size expressed in pixels for one side only. Since it is square you don't have to specify the other side. Only numbers from 70 to 1480 inclusive are valid. If nothing is specified, the default is 150 (i.e. an image with a width of 150 pixels and a height of 150 pixels).
Example:
qrsize=150

Image File Type: t=The type of image file to generate. The choices are PNG, JPEG or GIF file types represented as p, j and g respectively. If nothing is specified, the default is a PNG file type.
Example:
t=p (for PNG file type)
Example: t=j (for JPEG file type)
Example: t=g (for GIF file type)

Error Correction: e=The level of error correction capability. The choices are Level L (Low) 7%, Level M (Medium) 15%, Level Q (Quartile) 25%, and Level H (High) 30% represented as l, m, q, and h respectively. If nothing is specified, the default error correction level is M (Medium).
Example:
e=l (Low)
Example: e=m (Medium)
Example:
e=q (Quartile)
Example:
e=h (High)

*Remember to use "&" before each optional parameter.
*If you customize the colors, test to see that your color combinations are compatible with QR Code readers. There should be enough contrast between the background and QR Code colors.


If you find QRickit useful, please make a donation so QRickit can continue to provide this free public web service.

Make a Donation via PayPal

OR enter any donation amount US$


BigCommerce: The easiest way to sell online!

Follow QRickit on TwitterFollow QRickit on FacebookSee photos and videos, get news and tips at the QRickit BlogBe my friend on MySpace

QRickit Home

Copyright © 2008-2014 JICS MEDIA

QR Code ® is a registered trademark of DENSO WAVE INC. in JAPAN and other countries.

Qrickit.com and QRickit.mobi are free online resources provided by JICS MEDIA to promote the understanding and use of QR Codes around the world.