Create Bitcoin QR codes on a large scale by integrating our secure and easy to use Bitcoin QR code generator API into your websites or (d)apps.
Also stay up to date with the fast paced crypto environment by embedding our price widget. Our price widget is designed to follow the cryptocurrency market rates in real time 24/7 in a variety of different fiat currencies.
What is an API (application programming interface)?
API is an acronym for application programming interface, and over the years the modern API has become extraordinary useful and valuable. An API is a generic connection interface to a website or (d)app. Use the quick links below to jump to one of our useful and powerful Bitcoin APIs.
Below you will find detailed documentation on our crypto QR code API. We also have created an API link generating wizard to make things super fast and simple. Contact us if you have any questions or would like to file a bug report.
Also a friendly reminder that you can customize your QR codes with our API. Just use the color, border or background parameter when making a QR code. All of the details can be found below or you can jump to our api quick start instructions guide.
QR code API link generating wizard
Presets the amount of crypto to send or receive when scanned.
Enter fiat into the amount field when selected. The fiat amount is converted to crypto each time the QR code is requested at current market rates.
We've made things easy by including example GET request URL for our QR code API below. All you have to do is change the values to reflect your own required QR code needs. Refer to the parameter names (case sensitive) and their possible values using the charts below.
For more advanced webmasters you may want to dynamically generate wallet addresses in place of the GET requests crypto wallet address value using your favorite programming language.
Add the corresponding cryptocurrency logo to your QR code (default is on). (coming soon)
Parameter: style (required)
Style types and their parameter values (case sensitive)
Parameter: address (required)
The address parameter is the public crypto wallet address (case sensitive) that you would like to convert into a QR code format. Make sure the format of the crypto address you add to the GET request matches the style parameter.
If the address format and crypto type do not match a default non QR code image will be returned. Also note if you see the following image returned when making an API request check for missing required parameters or parameter errors.
Default API error response image (PNG).
Parameter: amount (optional)
The amount parameter is used to automatically set the amount of cryptocurrency you wish to send or receive and is used in conjunction with the URI address setting. This feature is handy if you are requesting payments for goods or services.
When a user scans one of our QR codes it will prefill the cryptocurrency address field as well as the amount field. Most popular (d)apps today recognize crypto URIs which helps to streamline the sending or receiving process.
In the following example we would like to include the set amount of 0.0005 BTC with address 1M5m1DuGw4Wyq1Nf8sfoKRM6uA4oREzpCX in a QR code format.
The prefix parameter by default is always on so it not necessary to set the prefix setting in the GET request if you actually want URIs added to your crypto wallet addresses. If you would like to remove the URIs from your QR codes just set the prefix parameter to off.
Note: Some out of date cryptocurrency wallets and (d)apps will not be able to read the imbedded wallet address within the QR code while the prefix setting is set to on. So if you're having trouble getting an (d)app to recognize a wallet address try turning the prefix setting to off.
Bitcoin has the highest amount of wallet support for crypto URIs which are required when setting an amount for your QR codes.
URI settings with their corresponding style type values (case sensitive)
QR code result
bitcoin:(Crypto public wallet address)
ethereum:(Crypto public wallet address)
bitcoincash:(Crypto public wallet address)
litecoin:(Crypto public wallet address)
bitcoinsv:(Crypto public wallet address)
monero:(Crypto public wallet address)
dogecoin:(Crypto public wallet address)
cardano:(Crypto public wallet address)
All style types
(Crypto public wallet address)
Parameter: color (optional)
The color parameter will change the default black and white QR code to any one of the following shown below. If the color is not set the default will be black or parameter 1.
QR code colors and their parameter values
Parameter: border (optional)
The border parameter gives you the option of adding a border to your crypto QR code. Below are the current border designs available. The default is no border when the parameter is not set.
QR code borders and their parameter values
Orange to yellow fade
Dark grey textured
Blue red yellow textured fade
Simply replace the border parameter with the corresponding border style type number shown in the table above to customize your QR codes. Plus use this in conjunction with the QR color parameter for even more of a variety of styles.
The following URL is an example API request which includes a red textured border and a red QR code.
Now you can easily embed the QR code in your HTML documents by using the img tag. Example HTML snippet shown below.
<img src="https://www.bitcoinqrcodemaker.com/api/?style=bitcoin&color=1&prefix=on&address=1M5m1DuGw4Wyq1Nf8sfoKRM6uA4oREzpCX" height="150" width="150" alt="Bitcoin QR Code">
300 by 300 pixels is the base image size. You can make the image smaller by simply changing the dimensions of the HTML img tag while still maintaining the image resolution. Just make sure both height and width are the same dimensions.
Sample image output from HTML code shown above using an API request.
What is a website widget?
A website widget is a standalone feature designed to be easily added to a website or application. Widgets are relatively simple to setup by copying and pasting provided code into the desired area of an app.
Widgets are handy because you don't need to know how to change or even fully understand code or code frameworks to add dynamic features to any site. Use the quick links below to jump to one of our Bitcoin widgets.