Developer Documentation

Comprehensive barcode reference for developers, supply chain professionals, and standards engineers. Covers barcode symbologies (1D linear, 2D matrix, stacked, composite), GS1 prefixes by country, check digit algorithms, industry regulations, print specifications, interactive tools, glossary, and in-depth guides. 15 languages supported.

Quick Start

curl -s "https://barcodefyi.com/api/v1/symbologies/"

API Endpoints

Method Endpoint Description
GET /api/v1/symbologies/ List all barcode symbologies
GET /api/v1/symbologies/{slug}/ Symbology detail with specs
GET /api/v1/categories/ Barcode categories (1D, 2D, etc.)
GET /api/v1/families/ Symbology families
GET /api/v1/components/ Barcode anatomy components
GET /api/v1/industries/ Industries using barcodes
GET /api/v1/algorithms/ Check digit algorithms
GET /api/v1/standards/ Barcode standards
GET /api/v1/gs1-prefixes/ GS1 country prefixes
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:

/symbology/ Browse all barcode symbologies by category (e.g. /symbology/)
/symbology/{slug}/ Symbology detail with technical specs (e.g. /symbology/ean-13/)
/family/ Symbology family groupings (e.g. /family/)
/family/{slug}/ Symbology family detail with evolution story (e.g. /family/upc-ean/)
/anatomy/ Interactive barcode anatomy explorer (e.g. /anatomy/)
/anatomy/{slug}/ Barcode component detail (e.g. /anatomy/quiet-zone/)
/prefix/ GS1 country prefix index (e.g. /prefix/)
/prefix/{slug}/ Country GS1 prefix detail (e.g. /prefix/united-states/)
/industry/ Industries using barcodes (e.g. /industry/)
/industry/{slug}/ Industry barcode requirements (e.g. /industry/retail/)
/check-digit/ Check digit algorithms (e.g. /check-digit/)
/check-digit/{slug}/ Algorithm detail with formula (e.g. /check-digit/modulo-10/)
/worksheet/{slug}/ Step-by-step check digit worksheet (e.g. /worksheet/ean-13-modulo-10/)
/standard/ Barcode standards (ISO, GS1, AIM) (e.g. /standard/)
/standard/{slug}/ Standard detail (e.g. /standard/iso-15420/)
/regulation/ Barcode regulations by country and industry (e.g. /regulation/)
/regulation/{slug}/ Regulation detail (e.g. /regulation/fda-udi/)
/print-spec/ Print specifications per symbology (e.g. /print-spec/)
/print-spec/{slug}/ Print spec detail (e.g. /print-spec/ean-13/)
/timeline/ Barcode history timeline (e.g. /timeline/)
/glossary/ Barcode terminology glossary (e.g. /glossary/)
/glossary/{slug}/ Glossary term detail (e.g. /glossary/quiet-zone/)
/guide/ In-depth barcode guides (e.g. /guide/)
/guide/{slug}/ Guide article (e.g. /guide/choosing-a-barcode/)
/tools/ Interactive barcode tools (e.g. /tools/)
/tools/barcode-generator/ Generate barcodes online (e.g. /tools/barcode-generator/)
/tools/barcode-reader/ Scan and decode barcodes (e.g. /tools/barcode-reader/)
/tools/upc-converter/ UPC-A / UPC-E converter (e.g. /tools/upc-converter/)
/tools/isbn-converter/ ISBN-10 / ISBN-13 converter (e.g. /tools/isbn-converter/)
/tools/size-calculator/ Barcode size calculator (e.g. /tools/size-calculator/)
/compare/ Symbology comparison index (e.g. /compare/)
/compare/{slug}/ Side-by-side comparison (e.g. /compare/ean-13-vs-upc-a/)
/search/ Search symbologies, terms, guides (e.g. /search/?q=ean)

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 barcodefyi

Barcode symbology data, check digit calculation, format validation

RubyGems
gem install barcodefyi

Ruby barcode symbology reference

crates.io
cargo add barcodefyi

Rust barcode symbology reference

Embed Widget

Embed data cards on your site: https://widget.barcodefyi.com
npm install barcodefyi-embed

Format Support

  • Markdown endpoints: Append .md to 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.