Create and manage QR codes with ease using our API. Generate static QR codes for fixed URLs or manage dynamic QR codes with full create, manage, and delete functionality, allowing you to update destinations and track usage.
Sign up for an account to get your API key, available in your dashboard.
Generate static QR codes with a simple GET request. These codes are fixed and redirect to a pre-defined URL, and the default output format is SVG which means the image can be resized without becoming pixellated or blurry.
| Parameter | Description | Required | Default |
|---|---|---|---|
| API_KEY | Your API key for authentication (Be careful not to embed this value directly into HTML, say, to avoid your API Key being used without your consent.) |
Yes | N/A |
| qrData | Data to encode (e.g., a URL) | Yes | N/A |
| outputType | Output format (e.g., svg, png) | No | svg |
| fgCol | Foreground color (hex) | No | #FFFFFF |
| bgCol | Background color (hex) | No | #000000 |
| size | Size in pixels | No | 300 |
| padding | Padding (pixels for PNG, elements for SVG) | No | 5 |
| shape | Element shape (square, round) | No | square |
https://www.DynamicQRCodes.co.uk
/api/v1/api.php?
API_KEY=myApiKey
&qrData=www.DynamicQRCodes.co.uk
https://www.DynamicQRCodes.co.uk
/api/v1/api.php?
API_KEY=myApiKey
&qrData=www.DynamicQRCodes.co.uk
&shape=round
https://www.DynamicQRCodes.co.uk
/api/v1/api.php?
API_KEY=myApiKey
&qrData=www.DynamicQRCodes.co.uk
&fgCol=4c6fe5&bgCol=eeeeee
Manage dynamic QR codes with full CRUD functionality. Update destinations, parameters, or tags without changing the QR code itself. Supports multiple QR code types, including HTTP redirects, vCards, and more.
Include your API key in the 'Authorization' header:
Authorization: Bearer YOUR_API_KEY
Dynamic QR codes can be of different types, specified by the
entity_type
field. Each type has specific fields in the
entity_data
object. Use the Supported QR Code Types
endpoint to see available types and their parameters.
Currently Supported Types:
| Type | Code | Description |
|---|---|---|
| HTTP Redirect | http |
Redirects to a URL with optional parameters. |
| vCard | vcard |
Contact card with personal and social media details. |
| Wi-Fi | wifi |
Wi-Fi network connection details (coming soon). |
Method: GET
URL:
/api/v1/qrcode.php
Example:
Response:
Method: POST
URL:
/api/v1/qrcode.php
Body:
Required:
entity_type
,
entity_data
(with type-specific required fields)
Optional:
title
(auto-generated for vCard as
given_name
+
family_name
, required for other types),
tags
Type-Specific Parameters:
entity_type: "http")
| Field | Description | Required |
|---|---|---|
destination_url |
The URL to redirect to (e.g., "https://example.com")
|
Yes |
parameters |
Key-value pairs for URL parameters (e.g., {"utm_source":
"qrcode"})
|
No |
entity_type: "vcard")
| Field | Description | Required |
|---|---|---|
given_name |
First name (e.g., "John")
|
Yes |
family_name |
Last name (e.g., "Doe")
|
No |
email_work |
Work email (e.g., "[email protected]")
|
No |
email_personal |
Personal email (e.g., "[email protected]")
|
No |
phone_work |
Work phone number (e.g., "1234567890")
|
No |
phone_home |
Home phone number (e.g., "0987654321")
|
No |
website_personal |
Personal website URL (e.g., "http://johndoe.com")
|
No |
street |
Street name (e.g., "Main St")
|
No |
street_number |
Street number (e.g., "123")
|
No |
postal_code |
Postal code (e.g., "62704")
|
No |
city |
City (e.g., "Springfield")
|
No |
state |
State or province (e.g., "IL")
|
No |
country |
Country (e.g., "USA")
|
No |
org |
Organization name (e.g., "Acme Corp")
|
No |
title_job |
Job title (e.g., "Software Engineer")
|
No |
note |
Summary or notes (e.g., "A brief summary about
yourself")
|
No |
social_links |
Object mapping social_platform_row_id to URL
(e.g., {"1": "https://facebook.com/johndoe"})See Social Media Platforms for available social_platform_row_id values.
|
No |
entity_type: "wifi")
(Coming Soon)| Field | Description | Required |
|---|---|---|
ssid |
Wi-Fi network name (e.g., "MyWiFi")
|
Yes |
password |
Wi-Fi password (e.g., "MyPass123")
|
No |
encryption |
Encryption type (e.g., "WPA", "WEP")
|
No |
hidden |
Whether the network is hidden (e.g., true)
|
No |
Examples:
Create an HTTP Redirect QR Code (requires
title
):
Create a vCard QR Code (
title
auto-generated as
given_name
+
family_name
):
Response (title will be "John Doe"):
Method: GET
URL:
/api/v1/qrcode.php/{qrid}
Example:
Response:
Method: PUT
URL:
/api/v1/qrcode.php/{qrid}
Body:
Required:
entity_type
,
entity_data
(with type-specific required fields)
Optional:
title
(auto-generated for vCard as
given_name
+
family_name
, required for other types),
tags
Example:
Response (title will be "John Smith"):
Method: PATCH
URL:
/api/v1/qrcode.php/{qrid}
Body:
Required: At least one field in
entity_data
,
tags
, or
title
Optional:
title
,
entity_data
(type-specific fields),
tags
Example:
Response:
Method: DELETE
URL:
/api/v1/qrcode.php/{qrid}
Example:
Response:
Method: GET
URL:
/api/v1/scan_history.php?qrid={qrid}&start_date={start_date}&end_date={end_date}
Parameters:
| Parameter | Description | Required | Format/Example |
|---|---|---|---|
| qrid | The QR code ID | Yes | HWTDGU |
| start_date | Start date for the scan history | Yes | YYYY-MM-DD (e.g., 2025-04-01) |
| end_date | End date for the scan history | Yes | YYYY-MM-DD (e.g., 2025-04-28) |
Example:
Response: A CSV file ('scan_history.csv') is downloaded with the following columns: 'Scan ID', 'QR Code ID', 'Scan Date', 'IP Address', 'User Agent'.
Sample CSV Content:
Retrieve a list of supported QR code types and their required/optional fields.
Include your API key in the 'Authorization' header:
Authorization: Bearer YOUR_API_KEY
2023 Fairways Consultants Ltd - All Rights Reserved.
QR Code is a registered trademark of DENSO WAVE INCORPORATED
Social Media Platforms
Retrieve a list of supported social media platforms for vCard QR codes. Use the
row_idin thesocial_linksfield of a vCard QR code.Endpoint
Authentication
Include your API key in the 'Authorization' header:
Authorization: Bearer YOUR_API_KEYExample
Authorization: Bearer YOUR_API_KEY
Response
{"row_id": 1, "platform_name": "facebook", "display_name": "Facebook"},
{"row_id": 8, "platform_name": "twitter", "display_name": "X / Twitter"}
]