Retrieve a QR code

Retrieve a QR code for a link.

Query Parameters

url

string

required

The URL to generate a QR code for.

logo

string

The logo to include in the QR code. Can only be used with a paid plan on Dub.co.

size

number

default: 600

The size of the QR code in pixels. Defaults to 600 if not provided.

level

enum<string>

default: L

The level of error correction to use for the QR code. Defaults to L if not provided.

Available options:

L,

M,

Q,

H

fgColor

string

default: #000000

The foreground color of the QR code in hex format. Defaults to #000000 if not provided.

bgColor

string

default: #FFFFFF

The background color of the QR code in hex format. Defaults to #ffffff if not provided.

hideLogo

boolean

default: false

Whether to hide the logo in the QR code. Can only be used with a paid plan on Dub.co.

margin

number

default: 2

The size of the margin around the QR code. Defaults to 2 if not provided.

includeMargin

boolean

default: truedeprecated

DEPRECATED: Margin is included by default. Use the margin prop to customize the margin size.

Response

200 - image/png

The response is of type string.