GoQR.me API Documentation

Introduction

Welcome to the GoQR.me API documentation. This API allows you to generate QR codes dynamically for various purposes, including URLs, text, and more.

API Endpoint

The base URL for all API requests is:

https://api.qrserver.com/v1/create-qr-code/

Parameters

data (required)

The data to be encoded in the QR code. This can be a URL, text, or any other type of data.

size (optional)

The size of the QR code image in pixels. Format: [width]x[height]

Default: 200x200

charset-source (optional)

The character set of the input data.

Default: UTF-8

charset-target (optional)

The character set of the output QR code.

Default: UTF-8

ecc (optional)

Error correction level. Options: L, M, Q, H

Default: L

color (optional)

The color of the QR code. Format: [hex color]

Default: 000000 (black)

bgcolor (optional)

The background color of the QR code. Format: [hex color]

Default: FFFFFF (white)

Usage

To generate a QR code, make a GET request to the API endpoint with your desired parameters.

Example Request:

https://api.qrserver.com/v1/create-qr-code/?size=150x150&data=Hello%20World!

Example Response:

The API will return a PNG image of the generated QR code.

Example QR Code

Limitations

Please note the following limitations:

  • Maximum QR code size: 1000x1000 pixels
  • Maximum data length: 2953 bytes
  • Rate limit: 100 requests per hour per IP address

Error Handling

If an error occurs, the API will return an HTTP error code along with a brief error message. Common error codes include:

Support

For additional support or questions about the GoQR.me API, please visit our website or contact our support team.