API Documentation
Developer Resources

Integrate CustomQR.pro into your applications with our powerful RESTful API. Generate QR codes programmatically, access analytics, and automate workflows.

Getting Started

Get up and running with our API in minutes

API Base URL

https://api.customqr.pro/v1

All API requests must be made to this base URL. You'll need an API key from your Professional account dashboard.

Authentication

Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

💡Get Your API Key

API access is available for Professional plan subscribers. Sign up for $4.99/month and get unlimited API calls.

View Pricing Plans

API Endpoints

Complete reference for all available endpoints

POST

Generate QR Code

/qr-codes

Create a new QR code with custom design options.

Request Body

{
  "type": "url",
  "data": "https://example.com",
  "config": {
    "color": {
      "dark": "#000000",
      "light": "#ffffff"
    },
    "width": 800,
    "errorCorrectionLevel": "M"
  }
}

Response

{
  "success": true,
  "data": {
    "id": "qr_abc123",
    "qrCodeUrl": "https://api.customqr.pro/qr-codes/qr_abc123.png",
    "downloadUrl": "https://api.customqr.pro/qr-codes/qr_abc123/download",
    "createdAt": "2025-10-29T10:00:00Z"
  }
}
GET

List QR Codes

/qr-codes

Retrieve a list of all your QR codes with pagination support.

Query Parameters:
?page=1&limit=20&type=url
GET

Get QR Code Analytics

/qr-codes/{id}/analytics

Get detailed scan statistics for a specific QR code including scan count, geographic data, and device information.

POST

Batch Generate QR Codes

/qr-codes/batch

Generate multiple QR codes at once from a CSV file or JSON array.

{
  "items": [
    {
      "data": "https://example.com/1",
      "type": "url"
    },
    {
      "data": "https://example.com/2",
      "type": "url"
    }
  ],
  "config": {
    "width": 800
  }
}

Code Examples

Quick start examples in popular languages

JavaScript (Fetch)

const response = await fetch(
  'https://api.customqr.pro/v1/qr-codes',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      type: 'url',
      data: 'https://example.com'
    })
  }
);
const qrCode = await response.json();

Python (Requests)

import requests

response = requests.post(
    'https://api.customqr.pro/v1/qr-codes',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'type': 'url',
        'data': 'https://example.com'
    }
)
qr_code = response.json()

Rate Limits

API usage limits and quotas

Professional Plan

  • 1000 requests per hour
  • Unlimited QR codes
  • Full API access

Enterprise

  • Unlimited requests
  • Priority support
  • Custom SLA

Ready to Integrate?

Start using our API today. Get your API key from your Professional dashboard.