FreeQR APIs Docs

Our custom qr code API offers a professional solution for brands that need to have custom qr code templates with data tracking system, dynamic qr codes or qr codes in bulk and have qr codes integrated in their CRM.

Our API and is available on 'Mashape' for any other questions you can always 'contact us' our API can be used world wide, if you need your QR codes available in China, please contact us. We can also do customized QR code for mobile payments.

qrId:
example 1
example 2
example 3
example 4
example 5

Documentation

Check this YouTube video how to use it

Create QR Code

1.

First login and get the API key to authorise in Track Data --> Account setting --> API key

2.

Add this API key in every req (GET/POST) as Authorization: Bearer API key

3. Generate Static custom QR code
URL/api/qr/static
MethodsPOST
AuthorizationBearer API KEY
ResponseBinary Image File (PNG, SVG)
Request parameter
qrCategorystringurlqrCategory define different type of qr like url, Vcard, facebook, etc. Check below qrCategory table.
textStringhttps://qrcode-tiger.comYour desired redirect URL will be embedded in QR
sizenumber500Size of the qr
logourlnullAdd any logo url to enable the logo at the center of QR
colorDarkstring#5e0bf0Color of the qr patterns
backgroundColorString#ffffffBackground color of the QR. (Note: Always choose bright color for a fully scanable QR)
gradientBooleanfalseSet “true” to enable gradient color
grdTypeNumber0 (Left-to-Right)Check below table for grdType
color01String#5e0bf0Gradient color 1 of qr patterns
color02String#f30505Gradient color 2 of qr patterns
eye_colorBooleanfalseSet “true” to change the eye color
eye_color01String#5e0bf0Color of outer eye
eye_color02String#f30505Color of inner eye
eye_outerStringeyeOuter0Different design of outer eye, check below table for all design patterns
eye_innerStringeyeInner0Different design of inner eye, check below table for all design patterns
qrDataStringpattern0Different design of qr data patterns, check below table for all design patterns
qrFormatStringpngDownload binary image file type “png” or “svg”
transparentBkgBooleanfalseIf enabled, QR code will have a transparent background
frameNumbernullIf enabled, QR will have a frame. Check below table for frame designs
frameColorStringnullFrame color change the color of frame text
frameTextStringSCAN MEFrame text shown over QR frame
Example
URL/api/qr/static
MethodsPOST
Parameter
{
  "size": 500,
  "colorDark": "rgb(5,64,128)",
  "logo": "scan_me.png",
  "eye_outer": "eyeOuter2",
  "eye_inner": "eyeInner1",
  "qrData": "pattern0",
  "backgroundColor": "rgb(255,255,255)",
  "transparentBkg": false,
  "qrCategory": "url",
  "text": "https://qrcode-tiger.com"
}
Response
example 5
{
  "data": "base 64 QR image data",
  "url": "1601477992984.png"
}
4. Get a list of all QR campaigns of different QR categories
URL/api/campaign/
MethodsGET
AuthorizationBearer API KEY
ResponseJSON object of QR list
GET /campaign/?page=1&limit=5&sort=1
Query parameters
ParameterDefaultDescription
page1no. of page
limit5no. of campaign per page
sort1Sort by Date(1) or Name(2)
categoryurlcategory define different type of qr like url, Vcard, facebook, etc. Check below qrCategory table.
Example
URL/api/campaign/?page=1&limit=5&sort=1&category=url
MethodsGET
Parameter
{
  "size": 500,
  "colorDark": "rgb(5,64,128)",
  "logo": "scan_me.png",
  "eye_outer": "eyeOuter2",
  "eye_inner": "eyeInner1",
  "qrData": "pattern0",
  "backgroundColor": "rgb(255,255,255)",
  "transparentBkg": false,
  "qrCategory": "url",
  "text": "https://qrcode-tiger.com"
}
Response
{
  "query": {
    "limit": 1,
    "page": 1,
    "total": 146
  },
  "data": [
    {
      "scans": 0,
      "_id": "5f6f373a33320a0ca52581b0",
      "qrId": "HNXP",
      "qrType": "qr2",
      "qrCategory": "url",
      "shortUrl": "https://qrcode-tiger.com/HNXP",
      "redirectUrl": "https://www.qrcode-tiger.com/",
      "murlData": [],
      "qrName": "Campaign HNXP",
      "qrImage": "HNXP.png",
      "createdAt": "2020-09-26T12:42:34.070Z",
      "updatedAt": "2020-09-26T12:42:34.070Z",
      "user": null,
      "id": "5f6f373a33320a0ca52581b0"
    }
  ]
}
5. Generate a Dynamic custom Visual QR code
URL/api/campaign/
MethodsPOST
AuthorizationBearer API KEY
ResponseBinary Image File (PNG, SVG)
Query parameters
ParameterTypeDefaultDescription
qrUrlStringhttps://qrcode-tiger.comYour desired redirect URL will be embedded in QR
qrTypeStringqr2qrType define the behaviour of qr like single redirect url or multi redirect url (“qr2” or “murl”)
qrCategoryStringurlqrCategory define different type of qr like url, Vcard, facebook, etc. Check below qrCategory table.
qr:JSON ObjectDesign your qr code like color, data patterns, eyes, etc within this object
sizeNumber500Size of the qr
logoString (url)nullAdd any logo url to enable the logo at the center of QR
colorDarkString#5e0bf0Color of the qr patterns
backgroundColorString#ffffffBackground color of the QR. (Note: Always choose bright color for a fully scanable QR)
gradientBooleanfalseSet “true” to enable gradient color
grdTypeNumber0 (Left-to-Right)Check below table for grdType
color01String#5e0bf0Gradient color 1 of qr patterns
color02String#f30505Gradient color 2 of qr patterns
eye_colorBooleanfalseSet “true” to change the eye color
eye_color01String#5e0bf0Color of outer eye
eye_color02String#f30505Color of inner eye
eye_outerStringeyeOuter0Different design of outer eye, check below table for all design patterns
eye_innerStringeyeInner0Different design of inner eye, check below table for all design patterns
qrDataStringpattern0Different design of qr data patterns, check below table for all design patterns
qrFormatStringpngDownload binary image file type “png” or “svg”
transparentBkgBooleanfalseIf enabled, QR code will have a transparent background
frameNumbernullIf enabled, QR will have a frame. Check below table for frame designs
frameColorStringnullFrame color change the color of frame text
frameTextStringSCAN MEFrame text shown over QR frame
Example
URL/api/campaign
MethodsPOST
Request Body
{
  "qr": {
    "size": 500,
    "colorDark": "rgb(5,64,128)",
    "logo": "1545827032075.png",
    "eye_outer": "eyeOuter2",
    "eye_inner": "eyeInner1",
    "qrData": "pattern0",
    "backgroundColor": "rgb(255,255,255)",
    "transparentBkg": false,
    "qrCategory": "url",
    "text": "https://www.qrcode-tiger.com.com/"
  },
  "murlData": [],
  "qrUrl": "https://www.qrcode-tiger.com.com",
  "qrType": "qr2",
  "qrCategory": "url",
  "qrId": "MP72"
}
Request Body
example 5
grdType (Default 0)
ParameterTypeValueDescription
Left - RightStringlinearGradient flow left to right
Top - BottomStringupDownGradient flow Top to Bottom
NW - SEStringdiagonal1Gradient flow Diagonally Downward
SW - NEStringdiagonal2Gradient flow Diagonally Upward
RadialStringradialGradient flow Radially
eye_outer (Default 0)
ParameterTypeValueDescription
eye_outerStringeyeOuter0
eyeOuter1
eyeOuter2
eyeOuter3
eyeOuter4
eyeOuter5
eyeOuter6
eyeOuter7
eyeOuter8
eyeOuter9
eye_inner
ParameterTypeValueDescription
eye_innerStringeyeInner0
eyeInner1
eyeInner2
eyeInner3
eyeInner4
eyeInner5
eyeInner6
eyeInner7
eyeInner8
eyeInner9
QrData
ParameterTypeValueDescription
qrDataStringpattern0
pattern1
pattern2
pattern3
pattern4
pattern5
pattern6
pattern7
pattern8
pattern9
pattern10
pattern11
Frame (Default : null)
ParameterTypeValueDescription
frameNumber1
2
3
5. Track your QR Data, No. Of scans, Country, City, Device type
URL/data/qrid?period=month&tz=Asia/Singapore
MethodsGET
AuthorizationBearer API KEY
ResponseJSON object of track data
Request parameter
ParameterTypeDescription
qrIdparamsUnique id of the qr
periodquery
“day” (Data of current day)
“week” (Data of current week)
“month” (Data of current month)
“months” (Data of the current year)
“year” (Yearly data)
tzqueryDefault Asia/Singapore
Response
{
  "data": {
    "campaign": {
      "scanLoop": false,
      "bulk": false,
      "scans": 5,
      "scanCounter": 0,
      "_id": "5f297b7b88c80a7e70afbbc5",
      "qrId": "BXFO",
      "qrType": "qr2",
      "qrCategory": "url",
      "shortUrl": "https://qrcode-tiger.com/BXFO",
      "redirectUrl": "http://hello.com.vn",
      "murlData": [],
      "qrName": "Campaign BXFO",
      "qrImage": "BXFO.png",
      "owner": "5a84402c08004f37a2b87831",
      "scanData": [],
      "createdAt": "2020-08-04T15:15:07.057Z",
      "updatedAt": "2020-08-29T00:39:47.416Z",
      "__v": 0,
      "user": null,
      "id": "5f297b7b88c80a7e70afbbc5"
    },
    "city": [
      {
        "_id": {
          "city": "New York"
        },
        "count": 3
      },
      {
        "_id": {
          "city": "Ho Chi Minh City"
        },
        "count": 2
      }
    ],
    "data": [
      {
        "_id": {
          "device": "iOS",
          "loc": "VN",
          "city": "Ho Chi Minh City"
        },
        "count": 1
      },
      {
        "_id": {
          "device": null,
          "loc": "NY",
          "city": "New York"
        },
        "count": 3
      },
      {
        "_id": {
          "device": null,
          "loc": "VN",
          "city": "Ho Chi Minh City"
        },
        "count": 1
      }
    ],
    "country": [
      {
        "_id": {
          "loc": "VN"
        },
        "count": 2
      },
      {
        "_id": {
          "loc": "NY"
        },
        "count": 3
      }
    ],
    "device": [
      {
        "_id": {
          "device": "Android"
        },
        "count": 4
      },
      {
        "_id": {
          "device": "iOS"
        },
        "count": 1
      }
    ],
    "scans": 5,
    "unique": {
      "label": [
        {
          "month": "Aug",
          "year": 2020
        }
      ],
      "scans": [
        2
      ]
    },
    "graph": {
      "label": [
        {
          "month": "Aug",
          "year": 2020
        }
      ],
      "scans": [
        5
      ]
    }
  }
}
6. Upload your logo
URL/accounts/uploads/
MethodsPOST
Content-Typemultipart/form-data
Form-FieldFile
ResponseImage file url {“qrUrl”: 1526460566643.png}
English
This QR Code Generator is a registered trademark of FREEQR PTE. LTD..
'QR Code' is a trademark of DENSO WAVE INCORPORATED. © 2025 www.free-qr-code-generator.com