Documentation
Welcome to the RECQR documentation. Learn how to instantly scan, decode, and generate QR codes at the edge using our platform and APIs.
Why RECQR?
Most QR code platforms are slow, littered with ads, and require a backend server just to decode an image. RECQR flips this paradigm.
- 100% Client-Side Scanning: We use WASM and modern browser APIs to decode QR codes directly on your device. Your camera feed never touches our servers.
- Rich Payloads: Automatically identifies WiFi, vCards, Calendar Events, Geo-locations, and Maps them to beautiful, actionable UI cards.
- Edge API: Our generator API is hosted on Cloudflare Workers, meaning the generation happens on an edge node just milliseconds away from your users.
Quick Start
Want to host RECQR yourself? It's a statically exported Next.js 14 application that can be deployed to GitHub Pages, Vercel, or Netlify instantly.
Terminal
API Reference
Our Cloudflare Workers API allows you to programmatically generate QR codes on the edge. No authentication is required for basic usage.
Generate QR Code
GET
/v1/qr/generate| Parameter | Type | Description |
|---|---|---|
| text | string | Required. The content to encode. |
| margin | number | Border margin. Default: 2 |
| format | string | Response type ('svg' | 'json'). Default: svg |
Example Request