openapi: 3.0.4
info:
  title: ActiveBarcode REST API
  description: |
    The ActiveBarcode API generates barcodes as SVG or PNG images.
    Use this API to generate barcodes with various types, colors, sizes, rotation, borders, etc.
    You can find out more about ActiveBarcode at [https://www.activebarcode.com](https://www.activebarcode.com).
  termsOfService: https://www.activebarcode.com/agb/
  contact:
    email: info@activebarcode.com
  version: 2.0.0

servers:
  - url: https://api.activebarcode.net/v2
    description: Main API server (SVG / PNG output)

tags:
  - name: Generate barcodes
    description: Endpoints to generate barcodes in different formats (SVG, PNG). 

paths:
  /png:
    get:
      tags:
        - Generate barcodes
      summary: Generate a barcode as PNG
      description: |
        Returns a barcode in [PNG format](https://en.wikipedia.org/wiki/PNG) with the given parameters.

        PNG is a raster image format that supports lossless compression, making it suitable for storing barcodes with precise pixel details. 
        It's widely compatible across platforms and software, ensuring accessibility. 
        Use PNG for barcodes when you need to preserve fine pixel accuracy in a static image for fixed-size designs or as a fallback when SVG isn't supported yet.
        Opt for SVG when you want barcodes that can scale smoothly for various sizes, such as in responsive or print applications.
      parameters:
        - $ref: '#/components/parameters/access'
        - $ref: '#/components/parameters/text'
        - $ref: '#/components/parameters/typeno'
        - $ref: '#/components/parameters/code'
        - $ref: '#/components/parameters/showtext'
        - $ref: '#/components/parameters/width'
        - $ref: '#/components/parameters/height'
        - $ref: '#/components/parameters/rotate'
        - $ref: '#/components/parameters/BorderWidth'
        - $ref: '#/components/parameters/BorderHeight'
        - $ref: '#/components/parameters/alignment'
        - $ref: '#/components/parameters/backcolor'
        - $ref: '#/components/parameters/forecolor'
        - $ref: '#/components/parameters/NotchHeightInPercent'
        - $ref: '#/components/parameters/fontsize'
      responses:
        '200':
          description: Success - PNG image returned
          headers:
            remaining-requests:
              $ref: '#/components/headers/RemainingRequests'
          content:
            image/png:
              schema:
                type: string
                format: binary
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError' 

  /svg:
    get:
      tags:
        - Generate barcodes
      summary: Generate a barcode as SVG
      description: |
        Returns a barcode in [SVG format](https://en.wikipedia.org/wiki/SVG) with the given parameters.

        SVG barcodes are defined in a vector graphics format and stored as XML. 
        SVG barcodes can be scaled infinitely without loss of quality. This makes SVG barcodes ideal for resizing. 
        The XML text files can be edited with text editors or vector graphics editors, and are rendered by most web browsers and many modern applications.
      parameters:
        - $ref: '#/components/parameters/access'
        - $ref: '#/components/parameters/text'
        - $ref: '#/components/parameters/typeno'
        - $ref: '#/components/parameters/code'
        - $ref: '#/components/parameters/showtext'
        - $ref: '#/components/parameters/width'
        - $ref: '#/components/parameters/height'
        - $ref: '#/components/parameters/rotate'
        - $ref: '#/components/parameters/BorderWidth'
        - $ref: '#/components/parameters/BorderHeight'
        - $ref: '#/components/parameters/alignment'
        - $ref: '#/components/parameters/backcolor'
        - $ref: '#/components/parameters/forecolor'
        - $ref: '#/components/parameters/NotchHeightInPercent'
        - $ref: '#/components/parameters/fontsize'
      responses:
        '200':
          description: Success - SVG image returned
          headers:
            remaining-requests:
              $ref: '#/components/headers/RemainingRequests'
          content:
            image/svg+xml:
              schema:
                type: string
                format: binary
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError' 

components:
  parameters:
    access:
      name: access
      in: query
      required: false
      description: |
        Provide your API key to get access.
        If you don't have an API key, you can get it [here](https://www.activebarcode.com/rest/#apikey).

        You can evaluate the REST API by omitting the API key.  
        If no API key is provided, the barcode will be watermarked. It is intended for evaluation purposes only.
      schema:
        type: string
        default: "YOUR-KEY-HERE"
    text:
      name: text
      in: query
      required: false
      description: |
        The text to be encoded as a barcode.  
        May include article numbers or general text.  
        Must be URL-encoded. Supports control codes (e.g. `<CR>`, `<LF>`, `<TAB>`).  

        If omitted, a meaningful default value will be used depending on the selected
        barcode type (`typeno` or `code`). This ensures that a valid barcode is always generated
        even without providing custom text.
      schema:
        type: string
    typeno:
      name: typeno
      in: query
      required: false
      description: |
        Barcode type as a number. Takes precedence over `code`.

        A list of all barcodes with typeno values is [available at our website](https://www.activebarcode.com/rest/parameters/#typeno).

        <details>
          <summary>Or click to expand list of barcodes and their typeno values.</summary>
          - `0` = [ISBN-10](https://www.activebarcode.com/barcode/isbn10/)
          - `1` = [EAN 13](https://www.activebarcode.com/barcode/ean13/)
          - `2` = [EAN 8](https://www.activebarcode.com/barcode/ean8/)
          - `3` = [EAN 5](https://www.activebarcode.com/barcode/ean-5/)
          - `4` = [EAN 2](https://www.activebarcode.com/barcode/ean-2/)
          - `5` = [UPC A](https://www.activebarcode.com/barcode/gtin-12/)
          - `6` = [Code 39](https://www.activebarcode.com/barcode/code39/)
          - `7` = [Code 25 Interleaved](https://www.activebarcode.com/barcode/interleaved-2-of-5/)
          - `8` = [Codabar](https://www.activebarcode.com/barcode/codabar/)
          - `9` = [Code 25 Industrial](https://www.activebarcode.com/barcode/code25/)
          - `10` = [Code 39 Extended](https://www.activebarcode.com/barcode/code39extended/)
          - `11` = [Code 128A](https://www.activebarcode.com/barcode/code128/)
          - `12` = [Code 128B](https://www.activebarcode.com/barcode/code128/)
          - `13` = [Code 128C](https://www.activebarcode.com/barcode/code128/)
          - `14` = [Code 128](https://www.activebarcode.com/barcode/code128/)
          - `15` = [EAN/UCC 128](https://www.activebarcode.com/barcode/gs1-128/)
          - `16` = [EAN 99](https://www.activebarcode.com/barcode/ean99/)
          - `17` = [UPC E](https://www.activebarcode.com/barcode/upce/)
          - `18` = [PostNet](https://www.activebarcode.com/barcode/postnet/)
          - `19` = [Royal Mail](https://www.activebarcode.com/barcode/royalmail/)
          - `20` = [MSI](https://www.activebarcode.com/barcode/msi/)
          - `21` = [Code 93](https://www.activebarcode.com/barcode/code93/)
          - `22` = [Code 93 Extended](https://www.activebarcode.com/barcode/code93/)
          - `23` = [PZN7](https://www.activebarcode.com/barcode/pzn/)
          - `24` = [Identcode](https://www.activebarcode.com/barcode/leitcode/)
          - `25` = [Leitcode](https://www.activebarcode.com/barcode/leitcode/)
          - `26` = [Code 39 Checksum](https://www.activebarcode.com/barcode/code39/)
          - `27` = [Code 39 Extended Checksum](https://www.activebarcode.com/barcode/code39extended/)
          - `28` = [EAN/UCC 128 AI](https://www.activebarcode.com/barcode/gs1-128/)
          - `29` = [EAN 14](https://www.activebarcode.com/barcode/ean14/)
          - `30` = [ITF-14](https://www.activebarcode.com/barcode/itf14/)
          - `31` = [EAN-18/NVE](https://www.activebarcode.com/barcode/sscc-18/)
          - `32` = [SSCC-18](https://www.activebarcode.com/barcode/sscc-18/)
          - `33` = [Codabar Checksum](https://www.activebarcode.com/barcode/codabar/)
          - `34` = [Code 25 Interleaved Checksum](https://www.activebarcode.com/barcode/interleaved-2-of-5/)
          - `35` = [Code 25 Industrial Checksum](https://www.activebarcode.com/barcode/code25/)
          - `36` = [PDF417](https://www.activebarcode.com/barcode/pdf417/)
          - `37` = [DataMatrix](https://www.activebarcode.com/barcode/datamatrix/)
          - `38` = [ISBN-13](https://www.activebarcode.com/barcode/isbn13/)
          - `39` = [ISBN-13 Dual](https://www.activebarcode.com/barcode/isbn13dual/)
          - `40` = [ISSN](https://www.activebarcode.com/barcode/issn/)
          - `41` = [ISMN](https://www.activebarcode.com/barcode/ismn/)
          - `42` = [DataMatrix Square](https://www.activebarcode.com/barcode/datamatrix/)
          - `43` = [DataMatrix Rectangular](https://www.activebarcode.com/barcode/datamatrix/)
          - `44` = [DataMatrix 10x10](https://www.activebarcode.com/barcode/datamatrix/)
          - `45` = [DataMatrix 12x12](https://www.activebarcode.com/barcode/datamatrix/)
          - `46` = [DataMatrix 8x18](https://www.activebarcode.com/barcode/datamatrix/)
          - `47` = [DataMatrix 14x14](https://www.activebarcode.com/barcode/datamatrix/)
          - `48` = [DataMatrix 8x32](https://www.activebarcode.com/barcode/datamatrix/)
          - `49` = [DataMatrix 16x16](https://www.activebarcode.com/barcode/datamatrix/)
          - `50` = [DataMatrix 12x26](https://www.activebarcode.com/barcode/datamatrix/)
          - `51` = [DataMatrix 18x18](https://www.activebarcode.com/barcode/datamatrix/)
          - `52` = [DataMatrix 20x20](https://www.activebarcode.com/barcode/datamatrix/)
          - `53` = [DataMatrix 12x36](https://www.activebarcode.com/barcode/datamatrix/)
          - `54` = [DataMatrix 22x22](https://www.activebarcode.com/barcode/datamatrix/)
          - `55` = [DataMatrix 16x36](https://www.activebarcode.com/barcode/datamatrix/)
          - `56` = [DataMatrix 24x24](https://www.activebarcode.com/barcode/datamatrix/)
          - `57` = [DataMatrix 26x26](https://www.activebarcode.com/barcode/datamatrix/)
          - `58` = [DataMatrix 16x48](https://www.activebarcode.com/barcode/datamatrix/)
          - `59` = [DataMatrix 32x32](https://www.activebarcode.com/barcode/datamatrix/)
          - `60` = [DataMatrix 36x36](https://www.activebarcode.com/barcode/datamatrix/)
          - `61` = [DataMatrix 40x40](https://www.activebarcode.com/barcode/datamatrix/)
          - `62` = [DataMatrix 44x44](https://www.activebarcode.com/barcode/datamatrix/)
          - `63` = [DataMatrix 48x48](https://www.activebarcode.com/barcode/datamatrix/)
          - `64` = [DataMatrix 52x52](https://www.activebarcode.com/barcode/datamatrix/)
          - `65` = [DataMatrix 64x64](https://www.activebarcode.com/barcode/datamatrix/)
          - `66` = [DataMatrix 72x72](https://www.activebarcode.com/barcode/datamatrix/)
          - `67` = [DataMatrix 80x80](https://www.activebarcode.com/barcode/datamatrix/)
          - `68` = [DataMatrix 88x88](https://www.activebarcode.com/barcode/datamatrix/)
          - `69` = [DataMatrix 96x96](https://www.activebarcode.com/barcode/datamatrix/)
          - `70` = [DataMatrix 104x104](https://www.activebarcode.com/barcode/datamatrix/)
          - `71` = [DataMatrix 120x120](https://www.activebarcode.com/barcode/datamatrix/)
          - `72` = [DataMatrix 132x132](https://www.activebarcode.com/barcode/datamatrix/)
          - `73` = [DataMatrix 144x144](https://www.activebarcode.com/barcode/datamatrix/)
          - `74` = [GS1-Data Matrix](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `75` = [GS1-Data Matrix Square](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `76` = [GS1-Data Matrix Rectangular](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `77` = [GS1-Data Matrix 10x10](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `78` = [GS1-Data Matrix 12x12](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `79` = [GS1-Data Matrix 8x18](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `80` = [GS1-Data Matrix 14x14](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `81` = [GS1-Data Matrix 8x32](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `82` = [GS1-Data Matrix 16x16](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `83` = [GS1-Data Matrix 12x26](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `84` = [GS1-Data Matrix 18x18](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `85` = [GS1-Data Matrix 20x20](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `86` = [GS1-Data Matrix 12x36](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `87` = [GS1-Data Matrix 22x22](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `88` = [GS1-Data Matrix 16x36](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `89` = [GS1-Data Matrix 24x24](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `90` = [GS1-Data Matrix 26x26](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `91` = [GS1-Data Matrix 16x48](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `92` = [GS1-Data Matrix 32x32](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `93` = [GS1-Data Matrix 36x36](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `94` = [GS1-Data Matrix 40x40](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `95` = [GS1-Data Matrix 44x44](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `96` = [GS1-Data Matrix 48x48](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `97` = [GS1-Data Matrix 52x52](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `98` = [GS1-Data Matrix 64x64](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `99` = [None](https://www.activebarcode.com/barcode/none/)
          - `100` = [GS1-Data Matrix 72x72](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `101` = [GS1-Data Matrix 80x80](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `102` = [GS1-Data Matrix 88x88](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `103` = [GS1-Data Matrix 96x96](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `104` = [GS1-Data Matrix 104x104](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `105` = [GS1-Data Matrix 120x120](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `106` = [GS1-Data Matrix 132x132](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `107` = [GS1-Data Matrix 144x144](https://www.activebarcode.com/barcode/gs1-datamatrix/)
          - `108` = [GS1-128](https://www.activebarcode.com/barcode/gs1-128/)
          - `109` = [GTIN-8](https://www.activebarcode.com/barcode/ean8/)
          - `110` = [GTIN-12](https://www.activebarcode.com/barcode/gtin-12/)
          - `111` = [GTIN-13](https://www.activebarcode.com/barcode/ean13/)
          - `112` = [GTIN-14](https://www.activebarcode.com/barcode/ean14/)
          - `113` = [QR Code](https://www.activebarcode.com/barcode/qrcode/)
          - `114` = [QR Code ECC Level L](https://www.activebarcode.com/barcode/qrcode/)
          - `115` = [QR Code ECC Level M](https://www.activebarcode.com/barcode/qrcode/)
          - `116` = [QR Code ECC Level Q](https://www.activebarcode.com/barcode/qrcode/)
          - `117` = [QR Code ECC Level H](https://www.activebarcode.com/barcode/qrcode/)
          - `118` = [QR Code 21x21](https://www.activebarcode.com/barcode/qrcode/)
          - `119` = [QR Code 25x25](https://www.activebarcode.com/barcode/qrcode/)
          - `120` = [QR Code 29x29](https://www.activebarcode.com/barcode/qrcode/)
          - `121` = [QR Code 33x33](https://www.activebarcode.com/barcode/qrcode/)
          - `122` = [QR Code 37x37](https://www.activebarcode.com/barcode/qrcode/)
          - `123` = [QR Code 41x41](https://www.activebarcode.com/barcode/qrcode/)
          - `124` = [QR Code 45x45](https://www.activebarcode.com/barcode/qrcode/)
          - `125` = [QR Code 49x49](https://www.activebarcode.com/barcode/qrcode/)
          - `126` = [QR Code 53x53](https://www.activebarcode.com/barcode/qrcode/)
          - `127` = [QR Code 57x57](https://www.activebarcode.com/barcode/qrcode/)
          - `128` = [QR Code 61x61](https://www.activebarcode.com/barcode/qrcode/)
          - `129` = [QR Code 65x65](https://www.activebarcode.com/barcode/qrcode/)
          - `130` = [QR Code 69x69](https://www.activebarcode.com/barcode/qrcode/)
          - `131` = [QR Code 73x73](https://www.activebarcode.com/barcode/qrcode/)
          - `132` = [QR Code 77x77](https://www.activebarcode.com/barcode/qrcode/)
          - `133` = [QR Code 81x81](https://www.activebarcode.com/barcode/qrcode/)
          - `134` = [QR Code 85x85](https://www.activebarcode.com/barcode/qrcode/)
          - `135` = [QR Code 89x89](https://www.activebarcode.com/barcode/qrcode/)
          - `136` = [QR Code 93x93](https://www.activebarcode.com/barcode/qrcode/)
          - `137` = [QR Code 97x97](https://www.activebarcode.com/barcode/qrcode/)
          - `138` = [QR Code 101x101](https://www.activebarcode.com/barcode/qrcode/)
          - `139` = [QR Code 105x105](https://www.activebarcode.com/barcode/qrcode/)
          - `140` = [QR Code 109x109](https://www.activebarcode.com/barcode/qrcode/)
          - `141` = [QR Code 113x113](https://www.activebarcode.com/barcode/qrcode/)
          - `142` = [QR Code 117x117](https://www.activebarcode.com/barcode/qrcode/)
          - `143` = [QR Code 121x121](https://www.activebarcode.com/barcode/qrcode/)
          - `144` = [QR Code 125x125](https://www.activebarcode.com/barcode/qrcode/)
          - `145` = [QR Code 129x129](https://www.activebarcode.com/barcode/qrcode/)
          - `146` = [QR Code 133x133](https://www.activebarcode.com/barcode/qrcode/)
          - `147` = [QR Code 137x137](https://www.activebarcode.com/barcode/qrcode/)
          - `148` = [QR Code 141x141](https://www.activebarcode.com/barcode/qrcode/)
          - `149` = [QR Code 145x145](https://www.activebarcode.com/barcode/qrcode/)
          - `150` = [QR Code 149x149](https://www.activebarcode.com/barcode/qrcode/)
          - `151` = [QR Code 153x153](https://www.activebarcode.com/barcode/qrcode/)
          - `152` = [QR Code 157x157](https://www.activebarcode.com/barcode/qrcode/)
          - `153` = [QR Code 161x161](https://www.activebarcode.com/barcode/qrcode/)
          - `154` = [QR Code 165x165](https://www.activebarcode.com/barcode/qrcode/)
          - `155` = [QR Code 169x169](https://www.activebarcode.com/barcode/qrcode/)
          - `156` = [QR Code 173x173](https://www.activebarcode.com/barcode/qrcode/)
          - `157` = [QR Code 177x177](https://www.activebarcode.com/barcode/qrcode/)
          - `158` = [PZN8](https://www.activebarcode.com/barcode/pzn/)
          </details>
      schema:
        type: integer
        minimum: 0
        maximum: 158
    code:
      name: code
      in: query
      required: false
      description: |
        Barcode type as a mnemonic code like CODE128 in example.

        A list of all barcodes with mnemonic code is [available at our website](https://www.activebarcode.com/rest/parameters/#code).

        <details>
          <summary>Or click to expand list of mnemonic code for all barcode types.</summary>
          - `ISBN` = [ISBN-10](https://www.activebarcode.com/barcode/isbn10/)
          - `EAN13` = [EAN 13](https://www.activebarcode.com/barcode/ean13/)
          - `EAN8` = [EAN 8](https://www.activebarcode.com/barcode/ean8/)
          - `EAN5` = [EAN 5](https://www.activebarcode.com/barcode/ean-5/)
          - `EAN2` = [EAN 2](https://www.activebarcode.com/barcode/ean-2/)
          - `UPCA` = [UPC A](https://www.activebarcode.com/barcode/gtin-12/)
          - `CODE39` = [Code 39](https://www.activebarcode.com/barcode/code39/)  
          - `CODE25I` = [Code 25 Interleaved](https://www.activebarcode.com/barcode/interleaved-2-of-5/)  
          - `CODABAR` = [Codabar](https://www.activebarcode.com/barcode/codabar/)  
          - `CODE25` = [Code 25 Industrial](https://www.activebarcode.com/barcode/code25/)  
          - `CODE39E` = [Code 39 Extended](https://www.activebarcode.com/barcode/code39extended/)  
          - `CODE128A` = [Code 128A](https://www.activebarcode.com/barcode/code128/)  
          - `CODE128B` = [Code 128B](https://www.activebarcode.com/barcode/code128/)  
          - `CODE128C` = [Code 128C](https://www.activebarcode.com/barcode/code128/)  
          - `CODE128` = [Code 128](https://www.activebarcode.com/barcode/code128/)  
          - `EAN128` = [EAN/UCC 128](https://www.activebarcode.com/barcode/gs1-128/)  
          - `EAN99` = [EAN 99](https://www.activebarcode.com/barcode/ean99/)  
          - `UPCE` = [UPC E](https://www.activebarcode.com/barcode/upce/)  
          - `POSTNET` = [PostNet](https://www.activebarcode.com/barcode/postnet/)  
          - `ROYALMAIL` = [Royal Mail](https://www.activebarcode.com/barcode/royalmail/)  
          - `MSI` = [MSI](https://www.activebarcode.com/barcode/msi/)  
          - `CODE93` = [Code 93](https://www.activebarcode.com/barcode/code93/)  
          - `CODE93E` = [Code 93 Extended](https://www.activebarcode.com/barcode/code93/)  
          - `PZN7` = [PZN7](https://www.activebarcode.com/barcode/pzn/)  
          - `IDENTCODE` = [Identcode](https://www.activebarcode.com/barcode/leitcode/)  
          - `LEITCODE` = [Leitcode](https://www.activebarcode.com/barcode/leitcode/)  
          - `CODE39CHECKSUM` = [Code 39 Checksum](https://www.activebarcode.com/barcode/code39/)  
          - `CODE39ECHECKSUM` = [Code 39 Extended Checksum](https://www.activebarcode.com/barcode/code39extended/)  
          - `EAN128AI` = [EAN/UCC 128 AI](https://www.activebarcode.com/barcode/gs1-128/)  
          - `EAN14` = [EAN 14](https://www.activebarcode.com/barcode/ean14/)  
          - `ITF14` = [ITF-14](https://www.activebarcode.com/barcode/itf14/)  
          - `EAN18` = [EAN-18/NVE](https://www.activebarcode.com/barcode/sscc-18/)  
          - `SSCC18` = [SSCC-18](https://www.activebarcode.com/barcode/sscc-18/)  
          - `CODABARCHECKSUM` = [Codabar Checksum](https://www.activebarcode.com/barcode/codabar/)  
          - `CODE25ICHECKSUM` = [Code 25 Interleaved Checksum](https://www.activebarcode.com/barcode/interleaved-2-of-5/)  
          - `CODE25CHECKSUM` = [Code 25 Industrial Checksum](https://www.activebarcode.com/barcode/code25/)  
          - `PDF417` = [PDF417](https://www.activebarcode.com/barcode/pdf417/)  
          - `DATAMATRIX` = [DataMatrix](https://www.activebarcode.com/barcode/datamatrix/)  
          - `ISBN13` = [ISBN-13](https://www.activebarcode.com/barcode/isbn13/)  
          - `ISBN13DUAL` = [ISBN-13 Dual](https://www.activebarcode.com/barcode/isbn13dual/)  
          - `ISSN` = [ISSN](https://www.activebarcode.com/barcode/issn/)  
          - `ISMN` = [ISMN](https://www.activebarcode.com/barcode/ismn/)  
          - `DATAMATRIXSQUARE` = [DataMatrix Square](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIXRECTANGULAR` = [DataMatrix Rectangular](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX10X10` = [DataMatrix 10x10](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX12X12` = [DataMatrix 12x12](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX8X18` = [DataMatrix 8x18](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX14X14` = [DataMatrix 14x14](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX8X32` = [DataMatrix 8x32](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX16X16` = [DataMatrix 16x16](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX12X26` = [DataMatrix 12x26](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX18X18` = [DataMatrix 18x18](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX20X20` = [DataMatrix 20x20](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX12X36` = [DataMatrix 12x36](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX22X22` = [DataMatrix 22x22](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX16X36` = [DataMatrix 16x36](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX24X24` = [DataMatrix 24x24](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX26X26` = [DataMatrix 26x26](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX16X48` = [DataMatrix 16x48](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX32X32` = [DataMatrix 32x32](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX36X36` = [DataMatrix 36x36](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX40X40` = [DataMatrix 40x40](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX44X44` = [DataMatrix 44x44](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX48X48` = [DataMatrix 48x48](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX52X52` = [DataMatrix 52x52](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX64X64` = [DataMatrix 64x64](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX72X72` = [DataMatrix 72x72](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX80X80` = [DataMatrix 80x80](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX88X88` = [DataMatrix 88x88](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX96X96` = [DataMatrix 96x96](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX104X104` = [DataMatrix 104x104](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX120X120` = [DataMatrix 120x120](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX132X132` = [DataMatrix 132x132](https://www.activebarcode.com/barcode/datamatrix/)  
          - `DATAMATRIX144X144` = [DataMatrix 144x144](https://www.activebarcode.com/barcode/datamatrix/)  
          - `GS1DATAMATRIX` = [GS1-Data Matrix](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIXSQUARE` = [GS1-Data Matrix Square](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIXRECTANGULAR` = [GS1-Data Matrix Rectangular](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX10X10` = [GS1-Data Matrix 10x10](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX12X12` = [GS1-Data Matrix 12x12](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX8X18` = [GS1-Data Matrix 8x18](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX14X14` = [GS1-Data Matrix 14x14](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX8X32` = [GS1-Data Matrix 8x32](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX16X16` = [GS1-Data Matrix 16x16](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX12X26` = [GS1-Data Matrix 12x26](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX18X18` = [GS1-Data Matrix 18x18](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX20X20` = [GS1-Data Matrix 20x20](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX12X36` = [GS1-Data Matrix 12x36](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX22X22` = [GS1-Data Matrix 22x22](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX16X36` = [GS1-Data Matrix 16x36](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX24X24` = [GS1-Data Matrix 24x24](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX26X26` = [GS1-Data Matrix 26x26](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX16X48` = [GS1-Data Matrix 16x48](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX32X32` = [GS1-Data Matrix 32x32](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX36X36` = [GS1-Data Matrix 36x36](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX40X40` = [GS1-Data Matrix 40x40](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX44X44` = [GS1-Data Matrix 44x44](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX48X48` = [GS1-Data Matrix 48x48](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX52X52` = [GS1-Data Matrix 52x52](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX64X64` = [GS1-Data Matrix 64x64](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `NONE` = [None](https://www.activebarcode.com/barcode/none/)  
          - `GS1DATAMATRIX72X72` = [GS1-Data Matrix 72x72](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX80X80` = [GS1-Data Matrix 80x80](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX88X88` = [GS1-Data Matrix 88x88](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX96X96` = [GS1-Data Matrix 96x96](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX104X104` = [GS1-Data Matrix 104x104](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX120X120` = [GS1-Data Matrix 120x120](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX132X132` = [GS1-Data Matrix 132x132](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1DATAMATRIX144X144` = [GS1-Data Matrix 144x144](https://www.activebarcode.com/barcode/gs1-datamatrix/)  
          - `GS1128` = [GS1-128](https://www.activebarcode.com/barcode/gs1-128/)  
          - `GTIN8` = [GTIN-8](https://www.activebarcode.com/barcode/ean8/)  
          - `GTIN12` = [GTIN-12](https://www.activebarcode.com/barcode/gtin-12/)  
          - `GTIN13` = [GTIN-13](https://www.activebarcode.com/barcode/ean13/)  
          - `GTIN14` = [GTIN-14](https://www.activebarcode.com/barcode/ean14/)  
          - `QRCODE` = [QR Code](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODEECCLEVELL` = [QR Code ECC Level L](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODEECCLEVELM` = [QR Code ECC Level M](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODEECCLEVELQ` = [QR Code ECC Level Q](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODEECCLEVELH` = [QR Code ECC Level H](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE21X21` = [QR Code 21x21](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE25X25` = [QR Code 25x25](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE29X29` = [QR Code 29x29](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE33X33` = [QR Code 33x33](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE37X37` = [QR Code 37x37](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE41X41` = [QR Code 41x41](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE45X45` = [QR Code 45x45](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE49X49` = [QR Code 49x49](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE53X53` = [QR Code 53x53](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE57X57` = [QR Code 57x57](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE61X61` = [QR Code 61x61](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE65X65` = [QR Code 65x65](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE69X69` = [QR Code 69x69](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE73X73` = [QR Code 73x73](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE77X77` = [QR Code 77x77](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE81X81` = [QR Code 81x81](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE85X85` = [QR Code 85x85](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE89X89` = [QR Code 89x89](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE93X93` = [QR Code 93x93](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE97X97` = [QR Code 97x97](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE101X101` = [QR Code 101x101](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE105X105` = [QR Code 105x105](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE109X109` = [QR Code 109x109](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE113X113` = [QR Code 113x113](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE117X117` = [QR Code 117x117](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE121X121` = [QR Code 121x121](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE125X125` = [QR Code 125x125](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE129X129` = [QR Code 129x129](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE133X133` = [QR Code 133x133](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE137X137` = [QR Code 137x137](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE141X141` = [QR Code 141x141](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE145X145` = [QR Code 145x145](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE149X149` = [QR Code 149x149](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE153X153` = [QR Code 153x153](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE157X157` = [QR Code 157x157](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE161X161` = [QR Code 161x161](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE165X165` = [QR Code 165x165](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE169X169` = [QR Code 169x169](https://www.activebarcode.com/barcode/qrcode/)  
          - `QRCODE173X173` = [QR Code 173x173](https://www.activebarcode.com/barcode/qrcode/)
          - `QRCODE177X177` = [QR Code 177x177](https://www.activebarcode.com/barcode/qrcode/)
          - `CODEPZN8` = [PZN8](https://www.activebarcode.com/barcode/pzn/)
          </details>
      schema:
        type: string
        example: CODE128
    showtext:
      name: showtext
      in: query
      required: false
      description: Whether the human-readable text line is visible. It's visible by default. `1` = visible, `0` = invisible.
      schema:
        type: integer
        enum: [0, 1]
    width:
      name: width
      in: query
      required: false
      description: Width of the resulting image area.
      schema:
        type: integer
        minimum: 1
    height:
      name: height
      in: query
      required: false
      description: Height of the resulting image area.
      schema:
        type: integer
        minimum: 1
    rotate:
      name: rotate
      in: query
      required: false
      description: Rotation in degrees. No rotation is default.
      schema:
        type: integer
        enum: [0, 90, 180, 270]
    BorderWidth:
      name: BorderWidth
      in: query
      required: false
      description: Left/right border (free space around the barcode).
      schema:
        type: integer
        minimum: 0
    BorderHeight:
      name: BorderHeight
      in: query
      required: false
      description: Top/bottom border (free space around the barcode).
      schema:
        type: integer
        minimum: 0
    alignment:
      name: alignment
      in: query
      required: false
      description: >
        Alignment of the barcode within its area. Can use text values `left`, `center`, `right`
        or numeric: `0` (left), `1` (center), `2` (right). Defaults to center if omitted.
      schema:
        type: string
        enum: [left, center, right, "0", "1", "2"]
    backcolor:
      name: backcolor
      in: query
      required: false
      description: Background color, in HTML-hex (without `#`, 6 hex digits), Defaults to `ffffff` = white if omitted.
      schema:
        type: string
        pattern: "^[0-9A-Fa-f]{6}$"
    forecolor:
      name: forecolor
      in: query
      required: false
      description: Foreground color for the barcode and the text, in HTML-hex (without `#`, 6 hex digits), Defaults to `000000` = black if omitted.
      schema:
        type: string
        pattern: "^[0-9A-Fa-f]{6}$"
    NotchHeightInPercent:
      name: NotchHeightInPercent
      in: query
      required: false
      description: Height of notches (for certain barcode types such as EAN-13, UPC etc.) as percent.
      schema:
        type: integer
        minimum: 0
        maximum: 100
    fontsize:
      name: fontsize
      in: query
      required: false
      description: Font size used for the human-readable text line (in points or px).
      schema:
        type: integer
        minimum: 1
  headers:
    RemainingRequests:
      description: Remaining requests. If no API key is provided, this value is 1.
      schema:
        type: integer
        minimum: 0
  responses:
    BadRequest:
      description: Bad Request - invalid parameters.
    Forbidden:
      description: Forbidden - Authorization was denied because the API key was incorrect.
    NotFound:
      description: Not Found - incorrect URL or resource.
    TooManyRequests:
      description: Too Many Requests - A correct API key was provided, but the remaining requests for that API key have been exhausted.
    InternalError:
      description: Internal Server Error - An unexpected condition has prevented the request from being fulfilled.