Create one QR code from raw text or a URL. For Wi-Fi, contacts, events, payments
and other structured content, use the dedicated typed endpoints so RapidAPI can
validate and document every field.
The default response is JSON with a data_uri you can drop straight into an <img>.
Set options.format to png, svg, jpeg, webp or pdf to get the image bytes
instead. Add style for shapes, gradients, a logo, a frame or a caption; styled codes
are decoded before they are returned and the response says verified: true|false
with warnings that tell you what to change.
Free tier:data and all options except format: pdf.
style and PDF are on PRO and above (a free-tier request that uses them returns
403 plan_excludes_feature and is not billed).
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
Create a Wi-Fi QR code that iOS and Android can use to join a network. Send the
network fields directly; security is WPA, WEP or nopass. Add options
for the output and style on a paid plan.
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
Create a standards-compatible contact card. name is required; include any available
organization, phone, email, website, address, note and birthday fields.
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
One colour, or three (top-left, top-right, bottom-left)
eye_ball_colorstring | string[]
gradientobject
3 child fields
typelinear · radial
default "linear"
colorsstring[]REQUIRED
anglenumber
Linear only; 0 = left→right, 90 = top→bottom
default 0min 0max 360
gradient_on_eyesboolean
default false
logoobject
6 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
sizenumber
Fraction of the symbol width
default 0.2min 0.05max 0.35
paddingnumber
Cleared margin around the logo, as a fraction of the symbol width
default 0.05min 0max 0.2
shapesquare · circle
default "square"
cleanboolean
Knock out the modules behind the logo
default true
backgroundobject
A photo or artwork behind the code (QRCode Monkey's 'transparent QR'). The image
is scaled to cover the symbol; only dark modules are drawn on top, so pick
`dark` with enough contrast — `verify` will tell you.
3 child fields
urlstring
Public http(s) URL of a PNG/JPEG/WebP/GIF; max 2 MB
max length 2048
base64string
Inline image, base64 (optionally a data: URI); max 2 MB decoded
max length 2900000
opacitynumber
Fade the image towards `light` (white by default) for contrast
Create one 1D or 2D barcode from data and type. EAN/UPC/ISBN/ISSN take digits and
a missing check digit is computed for you. Default output is JSON with a data_uri;
set format to png, svg, jpeg, webp or pdf for the bytes.
The module_*, quiet_zone, font_size, text_distance and dpi fields are
millimetre settings for 1D print layouts; leave them out for a sensible default.
scale, size and border apply to the 2D types (Data Matrix, PDF417, Aztec).
Send one image as image_url (public http(s)) orimage_base64 (a data: URI is
fine) and get back every QR code and barcode in it: symbology, decoded text, pixel
position, orientation, and parsed fields for known content (Wi-Fi, vCard, geo,
EPC/SEPA, payment links). Reads QR, Micro QR, Data Matrix, PDF417, Aztec and the
common 1D families. Up to 5 MB and 24 megapixels.
Check a raw QR payload against its published specification before you print or present
it. standard is one of gs1-digital-link, epc-sepa, swiss-qr-bill, pix-br-code,
upi, emvco-mpm. The response returns valid, the parsed fields, and errors /
warnings that name the offending field and cite the spec clause. This is
deterministic validation, not scheme certification.
Complete raw payload exactly as encoded. EPC/SEPA and Swiss QR-bill are line-delimited: separate lines with a line feed inside the JSON string. Literal `\n` sequences are decoded and reported as an `escaped_newlines` warning.
Validate a payment payload (same standard values as the validator) and, if it is
valid, render it as a QR code with the error-correction level and quiet zone the scheme
mandates. Invalid payloads return the validation errors instead of an image. Output
follows format (json data URI by default, or png/svg/jpeg/webp/pdf).
The payload standard to validate before rendering.
payloadstringREQUIRED
Complete raw payload exactly as encoded. EPC/SEPA and Swiss QR-bill are line-delimited: separate lines with a line feed inside the JSON string. Literal `\n` sequences are decoded and reported as an `escaped_newlines` warning.
max length 10000
formatjson · png · svg · jpeg · webp · pdf
Output format. `json` returns a data URI plus metadata and is the default; png/svg/jpeg/webp/pdf return the image bytes.
default "json"
sizeinteger
Exact width in pixels; defaults to 8 px per module.
min 32max 2048
darkstring
Module colour: hex, rgb() or a CSS name.
default "#000000"
lightstring
Background colour; `transparent` or null for none.
Known-good and known-bad payloads for every supported standard, each linked to the
official source it was taken from. Use them to try the validator, seed tests, or see
what a correct payload looks like. Filter with standard.