Skip to main content

​
Getting Started

This quickstart guide will help you make your first QR code generation request in just a few minutes.

​
Step 1: Test the API

The simplest way to get started is to make a basic request without authentication: 
curl "https://qrgen.maybesurya.live/api/qrgen?data=https://maybesurya.dev" -o qr.png
This will:
  1. Generate a QR code encoding the URL https://maybesurya.dev
  2. Save it as qr.png in your current directory
Without an API key, you’re limited to 10 requests per minute. This is perfect for testing!

​
Step 2: Get Your API Key (Optional)

To increase your rate limit to 100 requests per minute, you’ll need an API key:
  1. Visit the QrX Dashboard
  2. Sign in or create an account
  3. Copy your API key from the dashboard
Keep your API key secure! Don’t commit it to public repositories or share it publicly.

​
Step 3: Make Authenticated Requests

Once you have your API key, include it in your requests:

​
Using Query Parameter

curl "https://qrgen.maybesurya.live/api/qrgen?data=Hello%20World&apiKey=sk_YOUR_API_KEY" -o qr.png

curl "https://qrgen.maybesurya.live/api/qrgen?data=Hello%20World" \
  -H "x-api-key: sk_YOUR_API_KEY" \
  -o qr.png
Using the header method is more secure as API keys won’t appear in server logs or browser history.

​
Step 4: Use in Your Application

Choose your preferred language and integrate QrX into your application:

JavaScript

Use Fetch API in browser or Node.js

Python

Use requests library

Node.js

Use Axios or native fetch

cURL

Command-line examples

​
Common Use Cases

​
Generate QR for URLs

curl "https://qrgen.maybesurya.live/api/qrgen?data=https://example.com&apiKey=YOUR_KEY" -o url-qr.png

​
Generate QR for Text

curl "https://qrgen.maybesurya.live/api/qrgen?data=Your%20custom%20text&apiKey=YOUR_KEY" -o text-qr.png

​
Generate QR for Email

curl "https://qrgen.maybesurya.live/api/qrgen?data=mailto:[email protected]&apiKey=YOUR_KEY" -o email-qr.png

​
Generate QR for Phone Number

curl "https://qrgen.maybesurya.live/api/qrgen?data=tel:+1234567890&apiKey=YOUR_KEY" -o phone-qr.png

​
Next Steps

Explore Features

Learn about all QrX capabilities

API Reference

Detailed endpoint documentation

​
Need Help?

View Code Examples

Browse complete examples in multiple programming languages