API Documentation

Complete guide to integrating QRCore into your applications

🚀 Get Started in Minutes

Generate your first QR code with just one API call. No complex setup required.

curl -X GET "https://api.qrcore.com/v1/generate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -G -d "data=https://example.com" \
  -d "format=png" \
  -d "size=300"

Overview

The QRCore API provides a simple, powerful way to generate and manage QR codes programmatically. Our RESTful API supports all major QR code types, advanced customization options, and comprehensive analytics.

Base URL

https://api.qrcore.com/v1

Response Format

All API responses are returned in JSON format, except for QR code image endpoints which return binary image data.

Rate Limits

Rate limits vary by plan:

Starter: 100 requests/month
Pro: 1,000 requests/month
Business: 10,000 requests/month
Enterprise: Unlimited

Authentication

QRCore uses API keys for authentication. Include your API key in the Authorization header with the Bearer scheme.

Authorization: Bearer YOUR_API_KEY

You can find your API key in your dashboard under API Settings.

Generate QR Code

GET /v1/generate Requires Auth

Generate a QR code with the specified content and customization options.

Parameters

Parameter	Type	Required	Description
`data`	string	Required	The content to encode in the QR code
`type`	string	Optional	QR code type: url, text, email, phone, sms, wifi, vcard
`format`	string	Optional	Output format: png, svg, pdf (default: png)
`size`	integer	Optional	Size in pixels: 100-1000 (default: 300)
`color`	string	Optional	Foreground color (hex without #)
`background`	string	Optional	Background color (hex without #)
`error_correction`	string	Optional	Error correction level: L, M, Q, H (default: M)

Example Request

curl -X GET "https://api.qrcore.com/v1/generate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -G \
  -d "data=https://qrcore.com" \
  -d "type=url" \
  -d "format=png" \
  -d "size=400" \
  -d "color=2563eb" \
  -d "background=ffffff"

Response

Returns binary image data with appropriate Content-Type header.

Success Response (200 OK):
Content-Type: image/png
[Binary PNG image data]

Bulk Generation

POST /v1/bulk/generate Requires Auth

Generate multiple QR codes in a single request. Perfect for large-scale operations.

Request Body

{
  "qr_codes": [
    {
      "id": "qr_1",
      "data": "https://example.com/page1",
      "type": "url",
      "size": 300
    },
    {
      "id": "qr_2", 
      "data": "Contact us at support@example.com",
      "type": "text",
      "color": "2563eb"
    }
  ],
  "format": "png",
  "download_as_zip": true
}

Response

Success Response (200 OK):
Returns ZIP file containing all generated QR codes

Analytics

GET /v1/analytics/{qr_id} Requires Auth

Get detailed analytics for a specific QR code.

Response

{
  "qr_id": "qr_12345",
  "total_scans": 1247,
  "unique_scans": 892,
  "scan_locations": [
    {"country": "US", "scans": 543},
    {"country": "UK", "scans": 234}
  ],
  "device_types": {
    "mobile": 78.5,
    "desktop": 21.5
  },
  "scan_timeline": [
    {"date": "2024-08-20", "scans": 45},
    {"date": "2024-08-21", "scans": 67}
  ]
}

JavaScript SDK

Install the official JavaScript SDK for easier integration:

npm install @qrcore/sdk

Usage Example

import QRCore from '@qrcore/sdk';

const qrcore = new QRCore('YOUR_API_KEY');

// Generate a QR code
const qrCode = await qrcore.generate({
  data: 'https://example.com',
  type: 'url',
  size: 400,
  color: '2563eb'
});

console.log(qrCode.url); // URL to the generated QR code

Python SDK

Install the official Python SDK:

pip install qrcore-python

Usage Example

from qrcore import QRCore

qrcore = QRCore(api_key='YOUR_API_KEY')

# Generate a QR code
qr_code = qrcore.generate(
    data='https://example.com',
    type='url',
    size=400,
    color='2563eb'
)

# Save to file
with open('qrcode.png', 'wb') as f:
    f.write(qr_code.content)