DearQR API - Documentation

🚀 Getting started

Integrating QR code generator in your application has become easy with the use of DearQR's QR code API.

  • Last Updated: 10 April, 2025

DearQR is not just an another QR Code Generator API. You can completely customise the way your QR code looks. You can change the design pattern & it's colour, marker design & colour, eye design & colour etc.

You can not only customise the QR code design but also add beautiful logos inside your QR code.

You can also download the generated QR code as,

  1. PNG (base64 or image link - hosted on DearQR's server)
  2. SVG

The best part is that all of this can be done via API - integrate inside any application. No language barrier.

You can integrate a QR code generator into your app within minutes without worrying about the compatibility. All you need to do is to create an account with DearQR, create an API key and get started.

Sample QR code designs:

Image 1
Image 2
Image 3
Image 4
Image 4
Image 4

Get API Key

Follow the below steps to integrate DearQR API into your product / application.

  1. First step in integrating DearQR API is to create an account with DearQR to get an API key which is essential for all API requests.
  2. Head to DearQR register page and create an account.
  3. Verify the email and you will be redirected to the dashboard.
  4. In the dashboard, choose API Key menu item from the sidebar on the left.
  5. Click on the Copy button near the API Key and use the API key for authentication.

Choose your plan

For now, we have two simple plans for you.

  1. Free Plan.
  2. Pro Plan.

Create QR Code (Monochrome & Colorful)

Use the below API endpoint to create QR codes. Follow the sample input given below.

POST https://api.dearqr.com/v1/create

🔐 Authorization:

Type Token
Bearer Token EIZyhtgdUP8jgiH0IXuZk1N9oLSycg75VltLP3z1xIShXBDLZ6Guso3OtK87 - Get your API Key here

🧪 Sample Request

Type Token
application/json 
{
    "data":"https://www.dearqr.com",
    "size": "16",
    "format": "BASE64",
    "logo": "https://www.dearqr.com/assets/qr-images/yt_icon_rgb.png",
    "config":{
        "pattern":"shake",
        "pattern_color":"#00b2ff",
        "gradient":"1",
        "gradient_color":"#000000",
        "marker_top_right_center":"",
        "marker_top_right_outline":"",
        "marker_bottom_left_outline":"", 
        "marker_bottom_left_center":"",
        "marker_in":"rounded",
        "marker_in_color":"#f9595f",
        "marker_out":"flower_in",
        "marker_out_color":"", 
        "remove_logo_background":""
      }
}

⚙️ Parameters:

Parameter Default Description
data The data/content that you want to convert into QR code.
size 16 Size of the QR code (Mininum 16 to Maximum 32).
format base64 QR code output options. (ex. BASE64, SVG)
logo Publicly accessible URL of the logo that needs to be added at the center of QR code.
config config is a JSON object that contains different paramters like pattern, color etc that defines how a QR code should look.
pattern default
default
circle
dot
star
diamond
sparkle
danger
cross
plus
x
heart
shake
blob
special-circle-orizz
special-circle-vert
special-circle
special-diamond
ribbon
oriental
ellipse
pattern_color #000000 QR code body color or pattern color. Only Hex color codes with six digits accepted. Example: #fe68f0, #d65e26
marker_in default
default
flurry
sdoz
drop_in
drop
dropeye
circle
rounded
sun
star
diamond
danger
cross
plus
x
heart
vortex
sparkle_dot
9-dots
9-dots-fat
flower
elastic
diagonal
ropes
ropes-vert
bruised
marker_in_color #000000 Only Hex color codes with six digits accepted. Example: #fe68f0, #d65e26
marker_top_right_center #000000 Only Hex color codes with six digits accepted. Example: #fe68f0, #d65e26.
marker_bottom_left_center #000000 Only Hex color codes with six digits accepted. Example: #fe68f0, #d65e26.
marker_out default
default
flurry
sdoz
drop_in
dropeye
dropeyeleft
dropeyeleaf
dropeyeright
squarecircle
circle
rounded
flower
flower_in
leaf
3-corners
vortex
dots
bruised
canvas
marker_out_color #000000 Only Hex color codes with six digits accepted. Example: #fe68f0, #d65e26
marker_top_right_outline #000000 Only Hex color codes with six digits accepted. Example: #fe68f0, #d65e26
marker_bottom_left_outline #000000 Only Hex color codes with six digits accepted. Example: #fe68f0, #d65e26
gradient false Boolen value (true/false). Is color gradient for QR code body required?
gradient_color #000000 Gradient color code. Applicable only when gradient is true. If no, then this value is ignored. Only Hex color codes with six digits accepted. Example: #fe68f0, #d65e26
remove_logo_background false Boolen value (true/false). Removes QR code behind the logo at the center. Applicable only on adding logo.

📬 Sample Response

              
{
  "status": "success",
  "qrCode": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d.............."
}

Create QR Code (Monochrome)

Use the below API endpoint to create QR codes. Follow the sample input given below.

POST https://api.dearqr.com/v1/create

🔐 Authorization:

Type Token
Bearer Token EIZyhtgdUP8jgiH0IXuZk1N9oLSycg75VltLP3z1xIShXBDLZ6Guso3OtK87 - Get your API Key here

🧪 Sample Request

Type Token
application/json 
{
    "data": "https://www.dearqr.com",
    "size": "16",
    "format": "BASE64",
    "logo": "https://www.dearqr.com/assets/qr-images/yt_icon_rgb.png"
}

⚙️ Parameters:

Parameter Default Description
data The data/content that you want to convert into QR code.
size 16 (Mininum 16 to Maximum 32)
format base64 QR code output options. (ex. BASE64, SVG)
logo Publicly accessible URL of the logo that needs to be added at the center of QR code.

📬 Sample Response

              
{
  "status": "success",
  "qrCode": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d.............."
}

Changelog

Latest updates - Added features, improvements & bug fixes.

Version 1.0 (15th April, 2025)

  • Updated Basic plan is free to use and will be grandfathered when converted to paid plan.
  • Updated Initial release. Forever free plan & basic plan.