Endpoint
Making a Request
HTTP Method
GET
/api/qrgenParameters
The text or URL you want to encode. This can be anything - a website link,
some text, an email address, whatever you need. Examples: -
https://example.com - Hello World - mailto:[email protected] -
tel:+1234567890Your API key if you want higher rate limits (100 requests/min instead of 10).
Format:
sk_... Pro tip: Use the x-api-key header instead - it’s
more secure.Headers
Your API key. This is the recommended way to authenticate. Example:
x-api-key: sk_1234567890abcdefWhat You’ll Get Back
Success Response
HTTP Status:200 OK
Content-Type: image/png
You’ll get a PNG image back - just save it and you’re done!
Example Usage
When Things Go Wrong
Missing Data Parameter
HTTP Status:400 Bad Request
Rate Limit Hit
HTTP Status:429 Too Many Requests
Invalid API Key
HTTP Status:401 Unauthorized
Server Error
HTTP Status:500 Internal Server Error
Real-World Examples
Website URL
Email Link
Phone Number
Text Message
WiFi Network
Plain Text
Don’t forget to URL-encode special characters! Most HTTP libraries do this
automatically, but if you’re crafting URLs by hand, you’ll need to handle it.
Quick Templates
Need to get started fast? Here are some copy-paste templates:URL QR Code
URL QR Code
bash https://qrgen.maybesurya.live/api/qrgen?data=YOUR_URL Email QR Code
Email QR Code
bash https://qrgen.maybesurya.live/api/qrgen?data=mailto:EMAIL_ADDRESS Phone QR Code
Phone QR Code
bash https://qrgen.maybesurya.live/api/qrgen?data=tel:PHONE_NUMBER Text QR Code
Text QR Code
bash https://qrgen.maybesurya.live/api/qrgen?data=YOUR_TEXT Rate Limits
Here’s what you get:| Access Type | Rate Limit | Need Authentication? |
|---|---|---|
| Free (no key) | 10 requests/minute | Nope |
| With API key | 100 requests/minute | Yes |
Want Higher Limits?
Grab an API key from the dashboard - it takes 30 seconds
Tips & Tricks
Do This: - URL-encode your data parameter - Use HTTPS (always!) - Handle
errors gracefully - Cache QR codes when you can - Use API keys in production
Avoid This: - Hardcoding API keys in client code - Generating QR codes
on every page load - Ignoring rate limit errors - Putting sensitive data in
QR codes unencrypted