QR Fast API Documentation

Create and manage dynamic QR codes programmatically

Quick Start

Get started with the QR Fast API in minutes.

1. Get Your API Key

Create an API key from your dashboard:

2. Create Your First QR Code

Use this example to create a QR code:

curl -X POST https://qrfa.st/api/v1/qrcode \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "targetUrl": "https://example.com"
  }'

3. Response

You'll get back a response like this:

{
  "success": true,
  "shortId": "abc123defg",
  "qrCodeUrl": "https://qrfa.st/abc123defg",
  "editUrl": "https://qrfa.st/qrcode/edit/abc123defg",
  "targetUrl": "https://example.com",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

🧪 Interactive Testing

Swagger UI with live API testing. Test endpoints directly in your browser with your API keys.

Try API Live

🔑 Manage API Keys

Create, view, and manage your API keys. Required for all API requests.

Manage Keys

📋 API Reference

Complete endpoint documentation with all parameters, examples, and responses.

View Reference

🔐 Authentication

Learn about API keys, permissions, security best practices, and troubleshooting.

Security Guide

🤖 LLM Quick Reference

One-click copy of the complete API specification optimized for sharing with AI assistants like ChatGPT or Claude.

API Endpoints Overview

POST/api/v1/qrcodeCreate QR code

GET/api/v1/qrcode/:idGet QR code details

PUT/api/v1/qrcode/:idUpdate QR code

DEL/api/v1/qrcode/:idDelete QR code

GET/api/v1/qrcodeList all QR codes

Code Examples

JavaScript

fetch('/api/v1/qrcode', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + apiKey,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    targetUrl: 'https://example.com',
    qrCodeOptions: {
      dotsOptions: {
        type: 'rounded',
        color: '#FF6B6B'
      }
    }
  })
})
.then(response => response.json())
.then(data => {
  console.log('QR Code URL:', data.qrCodeUrl);
});

Python

import requests

response = requests.post(
  'https://qrfa.st/api/v1/qrcode',
  headers={
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json'
  },
  json={
    'targetUrl': 'https://example.com',
    'qrCodeOptions': {
      'dotsOptions': {
        'type': 'rounded',
        'color': '#FF6B6B'
      }
    }
  }
)

data = response.json()
print(f"QR Code URL: {data['qrCodeUrl']}")