Developer Documentation
Comprehensive QR code reference for developers and businesses. Covers QR code types (URL, WiFi, vCard, etc.), versions 1-40 with capacity data, encoding modes, QR code anatomy, standards, use cases, recipes, scan scenarios, interactive tools (generator, reader, capacity calculator), glossary, and guides. 15 languages supported.
- QR code content types with encoding prefixes and field schemas
- QR code versions 1-40 with module count, capacity per error correction level
- QR code anatomy: finder patterns, timing patterns, alignment patterns, format/version info
- Encoding modes: numeric, alphanumeric, byte, kanji, ECI
- ISO/AIM QR code standards
- Use cases for QR codes across industries
- QR code recipes — step-by-step generation guides for specific scenarios
- Scan scenarios — real-world scanning situations and troubleshooting
- Interactive tools: QR generator, reader, capacity calculator, size calculator, validator, batch generator, WiFi generator, vCard generator, data encoder
- Side-by-side QR code comparisons
- Glossary of QR code terminology
- In-depth guides organized by series
Quick Start
curl -s "https://qrcodefyi.com/api/v1/types/"
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/types/ | List all QR code content types |
| GET | /api/v1/types/{slug}/ | QR code type detail |
| GET | /api/v1/versions/ | QR code versions 1-40 |
| GET | /api/v1/versions/{version}/ | Version detail with capacity |
| GET | /api/v1/components/ | QR code anatomy components |
| GET | /api/v1/encoding-modes/ | Encoding modes |
| GET | /api/v1/standards/ | QR code standards |
| GET | /api/v1/use-cases/ | Use cases |
| GET | /api/v1/recipes/ | QR code recipes |
| GET | /api/v1/scan-scenarios/ | Scan scenarios |
| GET | /api/v1/comparisons/ | QR code comparisons |
| GET | /api/v1/glossary/ | Glossary terms |
| GET | /api/v1/guides/ | Guide articles |
| GET | /api/v1/tools/ | Interactive tools |
| GET | /api/v1/faqs/ | FAQs |
| GET | /api/v1/stats/ | Site statistics |
| GET | /api/v1/search/?q={query} | Search across all content |
URL Patterns
Use these patterns to construct URLs programmatically:
/type/
Browse all QR code content types (e.g. /type/)
/type/{slug}/
QR code type detail with encoding specs (e.g. /type/url/)
/version/
QR code versions 1-40 (e.g. /version/)
/version/{version}/
Version detail with capacity table (e.g. /version/1/)
/anatomy/
Interactive QR code anatomy explorer (e.g. /anatomy/)
/anatomy/{slug}/
QR code component detail (e.g. /anatomy/finder-pattern/)
/encoding/
QR code encoding modes (e.g. /encoding/)
/encoding/{slug}/
Encoding mode detail (e.g. /encoding/numeric/)
/standard/
QR code standards (ISO, AIM) (e.g. /standard/)
/standard/{slug}/
Standard detail (e.g. /standard/iso-18004/)
/use-case/
QR code use cases (e.g. /use-case/)
/use-case/{slug}/
Use case detail (e.g. /use-case/restaurant-menu/)
/recipe/
QR code recipes (e.g. /recipe/)
/recipe/{slug}/
Recipe detail (e.g. /recipe/wifi-access/)
/scenario/
QR code scan scenarios (e.g. /scenario/)
/scenario/{slug}/
Scan scenario detail (e.g. /scenario/low-light/)
/glossary/
QR code terminology glossary (e.g. /glossary/)
/glossary/{slug}/
Glossary term detail (e.g. /glossary/error-correction/)
/guide/
In-depth QR code guides (e.g. /guide/)
/guide/{slug}/
Guide article (e.g. /guide/choosing-error-correction/)
/tools/
Interactive QR code tools (e.g. /tools/)
/tools/qr-generator/
Generate QR codes online (e.g. /tools/qr-generator/)
/tools/qr-reader/
Scan and decode QR codes (e.g. /tools/qr-reader/)
/tools/capacity-calculator/
QR code capacity calculator (e.g. /tools/capacity-calculator/)
/tools/size-calculator/
QR code size calculator (e.g. /tools/size-calculator/)
/tools/qr-validator/
Validate QR code content (e.g. /tools/qr-validator/)
/tools/batch-generator/
Batch QR code generator (e.g. /tools/batch-generator/)
/tools/wifi-generator/
WiFi QR code generator (e.g. /tools/wifi-generator/)
/tools/vcard-generator/
vCard QR code generator (e.g. /tools/vcard-generator/)
/tools/qr-comparison/
QR code comparison tool (e.g. /tools/qr-comparison/)
/tools/data-encoder/
QR data encoder (e.g. /tools/data-encoder/)
/compare/
QR code comparison index (e.g. /compare/)
/compare/{slug}/
Side-by-side comparison (e.g. /compare/qr-vs-data-matrix/)
/search/
Search types, terms, guides (e.g. /search/?q=wifi)
Response Format
All endpoints return JSON with pagination:
Example JSON response
{
"count": 636,
"next": "https://example.com/api/v1/items/?page=2",
"previous": null,
"results": [
{"slug": "example", "name": "Example Item", "...": "..."}
]
}
OpenAPI Specification
Full API schema available as OpenAPI 3.1.0 JSON. Import into Swagger UI, Postman, or any OpenAPI-compatible tool.
SDK Packages
PyPI
pip install qrcodefyi
QR code type data, version capacity, encoding mode reference
RubyGems
gem install qrcodefyi
Ruby QR code reference
crates.io
cargo add qrcodefyi
Rust QR code reference
Embed Widget
Embed data cards on your site:
https://widget.qrcodefyi.com
npm install qrcodefyi-embed
Format Support
- Markdown endpoints: Append
.mdto any page URL for LLM-friendly markdown output. - Internationalization: Content available in 14 languages: ko, ja, zh-hans, es, fr, de, pt, ru, vi, tr, ar, hi, th, id.