API Documentation

All API endpoints bellow accept GET + POST requests.

/v1/png/

Export QR code as PNG image

Parameters:

  • msg - Your message that will encoded to QR (Required)
  • version - QR code version (1-40)
  • size - size of the image (1-50)
  • padding - padding size (0-50)
  • color - QR code color (R,G,B)
  • background - QR code background color (R,G,B)
  • style - styling the dots (rounded, square, circle, gap, vertical, horizontal)
  • mask - color masking (solid, radical, square, horizontal, vertical)
Masking color options:
  1. If you want to use vertical mask, you need to specify top_color and bottom_color parameter.
  2. If you want to use horizontal mask, you need to specify left_color and right_color parameter.

All color values are in R,G,B format.
🍭 Click to show examples
http://qrapi.xyz/v1/png/?msg=qrapi.xyz&style=rounded&size=7&version=2
http://qrapi.xyz/v1/png/?msg=qrapi.xyz&style=square&size=7&version=2&color=244,67,105&background=62,59,146
http://qrapi.xyz/v1/png/?msg=qrapi.xyz&style=square&size=7&version=2&left_color=244,67,105&right_color=62,59,146&mask=horizontal

/v1/svg/

Export QR code as SVG image

Parameters:

  • msg - Your message that will encoded to QR
  • version - QR code version (1-40)
  • size - size of the image (1-50)
  • padding - padding size (0-50)
🍩 Click to show examples
http://qrapi.xyz/v1/svg/?msg=qrapi.xyz&size=15&version=2&padding=3

/v1/ascii/

Export QR code as ASCII art

Parameters:

  • msg - Your message that will encoded to QR
  • version - QR code version (1-40)
  • padding - padding size (0-50)
🍕 Click to show examples
http://qrapi.xyz/v1/ascii/?msg=qrapi.xyz&version=2