40+ QR Code Types
URLs, vCards, payments & more
Real-time Analytics
Scans, devices & locations
Batch Processing
Enterprise-scale operations
See it in Action
Explore how the API generates different styles of QR codes with simple API calls.
Simple QR Code Generation
Create standard QR codes for internal use, employee IDs, event badges, and technical documentation.
curl -X POST 'https://api.qrstuff.com/api/qr-codes' \
-H "Authorization: Bearer [key]" \
-H "Content-Type: application/json" \
-d '{
"type": "website",
"data": "https://example.com"
}'
{
"id": "qr_8f3k2m1n",
"status": "active",
"short_url": "https://qrs.tf/a1b2",
"image_url": "https://cdn...",
"created_at": "2026-02-12"
}
Custom Branded QR Code
Brand your QR codes with custom colors for retail, hospitality, and marketing materials.
curl -X POST 'https://api.qrstuff.com/api/qr-codes' \
-d '{
"style": {
"foreground": "#5D4696",
"marker": "#E5006C"
}
}'{
"id": "qr_9x4j7p2q",
"style": {
"foreground": "#5D4696",
"marker": "#E5006C"
}
}
API Overview
The QRStuff API is a comprehensive RESTful API that empowers developers to integrate advanced QR code functionality directly into their applications. Whether you're building a mobile app, web platform, or enterprise system, our API provides everything you need to create, manage, and track dynamic QR codes at scale.
Key Features
Overview
Project Management: Create and organize QR codes into projects, manage project settings, move QR codes between projects, restore deleted projects, and maintain structured QR code organization across your entire application.
40+ QR Code Types
40+ QR Code Types: Generate QR codes for websites, contact details (vCard), social media platforms (Facebook, Instagram, LinkedIn, Twitter, YouTube, TikTok, Snapchat), payment methods (PayPal, Bitcoin, UPI, Venmo, Zelle), WiFi credentials, events, locations, file uploads (PDF, images, audio, video), SMS, email, phone numbers, and many more specialized formats.
Comprehensive Analytics
Comprehensive Analytics: Access detailed scan analytics including total scans, device-wise breakdowns (iOS, Android, Desktop, Tablet), geographic data with country and city-level tracking, time-based insights showing peak scanning periods, unique user identification, and visual chart data for presentations and reports.
Batch Processing
Advanced Batch Processing: Efficiently manage large QR code deployments with bulk download capabilities supporting multiple file formats (PNG, SVG, EPS, PDF), configure print layouts for batch printing with customizable templates, move multiple QR codes between projects simultaneously, and handle enterprise-scale operations seamlessly.
File Management
File Management System: Store and retrieve files for QR codes requiring hosted content - upload PDFs for brochures, images for galleries, audio files for music sharing, video files for promotional content, and any other file type your QR codes need to link to.
Preview & Customization
Preview & Customization: Generate preview URLs for any QR code type before creation to validate data and appearance, customize design elements including colors, patterns, and logos, control error correction levels for different use cases, and ensure pixel-perfect results before deployment.
Getting Started
Before you begin integrating with the QRStuff API, ensure you have completed the following setup requirements to enable seamless integration:
Active Subscription
Active Subscription: You must have an active QRStuff subscription account. The API access is included with all paid subscription plans. Enterprise plans offer higher rate limits and priority support for high-volume applications.
API Credentials
API Credentials: Obtain your unique API key and authentication token from your account dashboard under the API section. These credentials are required for all authenticated API requests and should be kept secure.
Base URL Configuration
Base URL Configuration: All API requests should be made to the base endpoint https://api.qrstuff.com. Ensure your application can make HTTPS requests to this domain without firewall or proxy restrictions.
Authentication Setup
Authentication Setup: Include your API credentials in the Authorization header for all authenticated endpoints. Use Bearer token authentication format to ensure secure communication between your application and the API.
Content Type Headers
Content Type Headers: All requests should be sent with Content-Type: application/json header, and all responses will be returned in JSON format for easy parsing and integration with modern applications.
Rate Limit Awareness
Rate Limit Awareness: Be aware of rate limiting based on your subscription tier. Standard plans support typical application usage, while Enterprise plans offer significantly higher rate limits for high-volume, mission-critical applications requiring thousands of requests per hour.
Authentication Example
Include your API key in the Authorization header for all authenticated requests. Here's a basic example of how to structure your API calls:
curl -X POST 'https://api.qrstuff.com/api/projects' \
-H "Authorization: Bearer [your_api_key]" \
-H "Content-Type: application/json" \
-d '{
"name": "Project Name"
}'API Endpoints
Explore the complete set of endpoints available for integrating QR code functionality into your applications.
| POST | /projects | Create a new project container for organizing QR codes |
| GET | /projects/{id} | Retrieve detailed information about a specific project |
| PUT | /projects/{id} | Update project details, settings, and configuration |
| GET | /projects | List all projects with filtering, sorting, and pagination |
| DELETE | /projects/{id} | Remove projects with soft deletion and retention |
| POST | /projects/{id}/restore | Recover deleted projects within retention period |
| POST | /qr-codes | Generate a new QR code with 40+ data types and customizations |
| GET | /projects/{id}/qr-codes | Retrieve all QR codes from a project with pagination |
| PUT | /qr-codes/{id} | Update QR code content, URLs, design, and settings |
| POST | /api/qrcodes/anonymous-transfer | Transfer QR codes between projects in bulk |
| DELETE | /qr-codes/{id} | Remove QR codes with optional soft delete and recovery |
| POST | /api/batch/submit | Initiate processing of a large batch file |
| GET | /api/qrcodes/{id}/zip/download | Download ZIP archive of all generated images |
| POST | /api/batch/unpack | Extract all QR codes from a completed batch archive |
| POST | /api/batch/update | Update properties across multiple QR codes simultaneously |
| GET | /analytics/scans | Cumulative scan counts with date range filtering |
| GET | /analytics/scans/devices | Breakdown by device type and operating system |
| GET | /analytics/location | Geographic data with country, state, and city-level detail |
| GET | /analytics/top-location | Discover regions with highest engagement rates |
| GET | /analytics/top-date | Identify peak scanning days and dates |
| GET | /analytics/time-of-day | Hourly breakdown of scanning patterns |
| GET | /analytics/unique-users | Track individual user engagement and loyalty |
| GET | /analytics/charts/country | Country-wise distribution for charting libraries |
| GET | /analytics/charts/time | Time-series data for visual scan pattern charts |
| POST | /files | Upload files (PDF, images, audio, video) with validation |
| GET | /files/{id} | Retrieve file info, download URLs, and metadata |
| GET | /files | Browse uploaded files with pagination and filtering |
| DELETE | /files/{id} | Remove files with active-use protection check |
Supported QR Code Types (40+ Data Formats)
Generate QR codes for an extensive variety of use cases and data types. Each type has specific parameters and formatting requirements detailed in the full API documentation:
Basic & Contact Information
7Social Media Platforms
15Location & Events
3Files & Documents
5Payments & Transactions
5Marketing & Engagement
6Business & Utility
4Note: Each QR code type has specific parameter requirements and formatting rules. Consult the detailed API documentation at api.qrstuff.com/docs for complete specifications, example requests, and response formats for each type.
Best Practices
Use Dynamic QR Codes: Always generate dynamic QR codes through the API when possible. Dynamic QR codes allow you to update the destination URL or content without reprinting the physical QR code, track comprehensive analytics including scan counts and user demographics, A/B test different destinations, maintain better control over your marketing campaigns, and extend the lifespan of printed materials by avoiding obsolescence.
Implement Robust Error Handling: Always implement comprehensive error handling in your API integration. Check HTTP response status codes (200 for success, 400 for bad requests, 401 for authentication issues, 429 for rate limits, 500 for server errors), handle rate limits gracefully with exponential backoff strategies, implement retry logic for transient failures, log all errors with contextual information for debugging, and validate API responses before processing. The API returns descriptive error messages with specific error codes to help you troubleshoot issues quickly and efficiently.
Leverage Batch Operations: When working with multiple QR codes, always use batch endpoints for downloading, printing, and moving operations instead of making individual sequential requests. Batch operations reduce the total number of API calls significantly, improve overall performance and response times, ensure you stay within rate limits even for large operations, reduce network overhead and latency, and provide atomic operations where all items succeed or fail together, maintaining data consistency across your application.
Implement Smart Caching: Cache QR code images and relatively static project data appropriately to reduce unnecessary API calls and improve application performance. However, ensure analytics data is fetched fresh when needed for accurate real-time reporting and decision-making. Consider implementing a tiered caching strategy: cache QR code images indefinitely (they don't change), cache project metadata for 5-15 minutes, refresh analytics data every 1-5 minutes for dashboards, and invalidate caches when you make updates through the API. Use ETags and Last-Modified headers for efficient cache validation.
Security First Approach: Never expose your API keys in client-side JavaScript code, public repositories, or version control systems. Store API credentials securely using environment variables, encrypted configuration files, or dedicated secrets management systems like AWS Secrets Manager or HashiCorp Vault. Implement API key rotation periodically (every 90 days recommended), monitor API usage logs for suspicious activity or unexpected patterns, use HTTPS for all requests, implement request signing for additional security in sensitive applications, and restrict API access by IP address or domain when possible for enterprise deployments.
Use Cases & Real-World Examples
Event Management & Ticketing Platform
Integrate QR code generation for comprehensive event management including ticket distribution and attendee tracking. Create unique QR codes for each ticket purchase with encrypted attendee information, track attendance in real-time through scan analytics and check-in applications, manage multiple concurrent events using project organization with separate folders per event, implement VIP and general admission tiers with different QR code designs, send dynamic tickets via email that can be updated if event details change, generate check-in codes for staff and volunteers, update event information dynamically without reissuing tickets, gather valuable attendee insights including arrival times and engagement patterns, implement session tracking for multi-day conferences, and create post-event follow-up campaigns based on attendance data.
Inventory & Asset Management Systems
Build comprehensive inventory management and asset tracking systems with seamless QR code integration. Generate unique identification codes for each product, equipment piece, or asset in your organization, track item location and movement history through scan analytics and geographic data, maintain detailed digital records including purchase date, warranty information, maintenance schedules, and depreciation data, implement automated checkout/check-in systems for equipment lending, create hierarchical organization with projects representing warehouses, departments, or locations, use batch operations to generate codes for new inventory shipments efficiently, update asset information dynamically as items are serviced or relocated, integrate with existing ERP or inventory management software through webhooks, implement audit trails for compliance requirements, and generate reports on asset utilization and location history. Perfect for warehouses, retail operations, libraries, equipment rental businesses, and enterprise asset management.
Marketing Campaign Management & Analytics
Create sophisticated data-driven marketing campaigns with trackable QR codes for print materials, product packaging, outdoor advertising, and promotional items. Generate unique codes for different campaigns, channels, or demographic segments to track source attribution, update campaign destinations and landing pages without reprinting expensive materials, A/B test different landing pages or offers by rotating destinations for specific QR codes, measure campaign effectiveness through detailed geographic and temporal analytics showing exactly when and where engagement occurs, implement seasonal campaigns with scheduled content updates, track ROI by correlating scan data with conversion events, create personalized marketing experiences by encoding user identifiers, segment audiences based on scan behavior and location data, implement retargeting campaigns for users who scanned but didn't convert, and generate comprehensive reports showing campaign performance across all channels. Ideal for retail brands, consumer products, event promotions, and omnichannel marketing strategies.
Educational Content Distribution & Engagement
Enhance educational materials and learning experiences with QR codes linking to rich supplementary content, interactive resources, and assessment tools. Embed codes in textbooks, worksheets, and classroom posters that link to instructional videos, 3D models, audio pronunciations, or interactive simulations, track student engagement and resource usage through analytics to identify which materials are most effective, organize content by course, grade level, or subject using comprehensive project structures, update learning materials dynamically as curriculum evolves without replacing physical materials, create self-paced learning paths where students scan codes to access progressive content, implement formative assessments through QR-linked quizzes and surveys, provide differentiated instruction by linking to resources at various difficulty levels, enable parent involvement by providing codes that link to home learning activities, create interactive field trip experiences with location-based QR codes, and measure learning outcomes by correlating scan data with assessment results. Perfect for K-12 education, higher education, corporate training programs, and museum exhibits.
Restaurant & Hospitality Management
Implement modern contactless solutions for restaurants, hotels, and hospitality venues including digital menus, ordering systems, and guest services. Generate table-specific QR codes for contactless ordering and payment that reduce staff workload and improve table turnover rates, update menus in real-time without reprinting expensive physical menus, highlight daily specials or seasonal offerings dynamically, collect customer feedback through QR-linked forms immediately after dining experiences, implement loyalty program enrollment through scannable codes at checkout, provide multilingual menu options by detecting user device language preferences, track which menu items are viewed most frequently to optimize menu design, enable guests to access hotel services, room service, and concierge information via in-room QR codes, create virtual hotel tours for prospective guests, analyze customer preferences and ordering patterns through detailed scan analytics, implement contactless check-in/check-out procedures, and personalize guest experiences based on previous visit data. Enhance customer experience while gathering valuable business intelligence for operations optimization.
English (UK)
Spanish (ES)
French (FR)