{"openapi":"3.1.0","info":{"title":"Barcode Labels API","version":"1.0.0","description":"Generate barcodes and printable labels. The API is currently keyless. API keys will be required in a future release; the free tier will remain free. Rate limit: 60 requests/minute per IP (burst 20). /v1 parameters and response shapes never change incompatibly; breaking changes will ship under /v2."},"servers":[{"url":"/"}],"paths":{"/api/v1/barcode":{"get":{"summary":"Generate a barcode image","description":"Returns just the barcode (no label page, no caption unless includetext=true).","parameters":[{"name":"text","in":"query","required":true,"schema":{"type":"string","maxLength":7089}},{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["code128","qr","microqr","datamatrix","upca","upce","ean13","ean8","code39","itf14"]}},{"name":"format","in":"query","schema":{"type":"string","enum":["png","svg","pdf"],"default":"png"}},{"name":"includetext","in":"query","schema":{"type":"boolean","default":false}},{"name":"scale","in":"query","schema":{"type":"integer","minimum":1,"maximum":10,"default":3}},{"name":"height","in":"query","schema":{"type":"number","minimum":1,"maximum":100,"default":15},"description":"Bar height in mm (1D types only)"},{"name":"rotate","in":"query","schema":{"type":"string","enum":["N","R","L","I"],"default":"N"}}],"responses":{"200":{"description":"The barcode image","content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/svg+xml":{"schema":{"type":"string"}},"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}},"500":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}}}}},"/api/v1/label":{"get":{"summary":"Generate a printable label","description":"Returns a barcode laid out on a standard label size, with the encoded text shown above the barcode by default.","parameters":[{"name":"text","in":"query","required":true,"schema":{"type":"string","maxLength":7089}},{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["code128","qr","microqr","datamatrix","upca","ean13","ean8"]}},{"name":"size","in":"query","schema":{"type":"string","enum":["4x6","4x4","4x3","4x2","3.5x1.125","3x3","3x2","3x1","2x3","2.25x1.25","2.25x0.75","2x1","1.75x0.5","1.5x1.5","100x150","100x50","70x50","62x100","50x30","50x25","40x20","38x25","25x10"],"default":"4x6"}},{"name":"orientation","in":"query","schema":{"type":"string","enum":["portrait","landscape"],"default":"landscape"}},{"name":"qty","in":"query","schema":{"type":"integer","minimum":1,"maximum":500,"default":1},"description":"Pages in the PDF (pdf format only)"},{"name":"showtext","in":"query","schema":{"type":"boolean","default":true}},{"name":"format","in":"query","schema":{"type":"string","enum":["pdf","png"],"default":"pdf"},"description":"png renders page 1 only"}],"responses":{"200":{"description":"The label document or image","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}},"500":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}}}}}}}