API Documentation

QR Code API

Integrate QR code generation into your applications with our powerful REST API. Generate, customize, and manage QR codes programmatically.

API Authentication

All API requests require authentication using your API key. Include it in the Authorization header.

Endpoints

POST

/api/v1/qr/generate

Generate a QR code with custom content and styling options. Supports multiple formats and advanced customization.

Request Parameters

content*

string

The content to encode in the QR code

format

string

Output format: 'png' or 'svg' (default: 'png')

size

integer

QR code size in pixels (default: 300)

errorCorrection

string

Error correction level: 'L', 'M', 'Q', 'H' (default: 'M')

foregroundColor

string

Foreground color in hex format (default: '#000000')

backgroundColor

string

Background color in hex format (default: '#ffffff')

margin

integer

Margin size in modules (default: 4)

Code Examples

curl -X POST https://api.nowhile.com/v1/qr/generate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "https://nowhile.com",
    "format": "png",
    "size": 300,
    "errorCorrection": "M",
    "foregroundColor": "#000000",
    "backgroundColor": "#ffffff",
    "margin": 4
  }'

Response Examples

{
  "success": true,
  "data": {
    "id": "qr_1234567890",
    "content": "https://nowhile.com",
    "format": "png",
    "size": 300,
    "url": "https://cdn.nowhile.com/qr/qr_1234567890.png",
    "downloadUrl": "https://api.nowhile.com/v1/qr/download/qr_1234567890",
    "metadata": {
      "errorCorrection": "M",
      "modules": 25,
      "version": 2,
      "createdAt": "2024-01-15T10:30:00Z"
    }
  },
  "usage": {
    "remaining": 9999,
    "resetAt": "2024-02-01T00:00:00Z"
  }
}

Rate Limits & Pricing

API usage limits and pricing tiers for different use cases

Free

100/hour

Burst: 10/minute

Starter

$9/month

1,000/hour

Burst: 50/minute

Pro

$29/month

10,000/hour

Burst: 200/minute

Enterprise

Unlimited

Burst: Custom

SDKs & Libraries

Official and community-maintained libraries for popular programming languages

JavaScript/Node.js

Official

Version: v2.1.0

Downloads: 10K+

Python

Official

Version: v1.5.2

Downloads: 8K+

PHP

Official

Version: v1.3.1

Downloads: 5K+

Ruby

Community

Version: v0.9.0

Downloads: 2K+

Go

Community

Version: v1.1.0

Downloads: 3K+

Java

Beta

Version: v0.5.0

Downloads: 1K+

Need Help Getting Started?

Our developer support team is here to help you integrate our API successfully.