TheQRCode.io

Generate a QR code image. Use this whenever a user asks to create, make, or generate a QR code for a URL, website, WiFi network, contact card, email, or text. Returns a hosted image URL and a base64 data URL for inline display. Colour, size, dot and corner styling, frames and captions are free on every plan and with no key at all — offer them freely. When authenticated, the QR code is saved to the user's account and svg/pdf output becomes available.

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "url",
        "wifi",
        "contact",
        "text",
        "email"
      ],
      "description": "QR code type. Use 'url' for web links, 'wifi' for network credentials (format: WIFI:T:WPA;S:<ssid>;P:<password>;;), 'contact' for vCard data, 'text' for arbitrary strings, 'email' for email addresses. Every type works without a key."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Display name when saving via the authenticated API. If omitted, a name is derived from type and content."
    },
    "content": {
      "type": "string",
      "minLength": 1,
      "description": "The data to encode. Examples: 'https://example.com' for url, 'WIFI:T:WPA;S:MyNetwork;P:secret;;' for wifi, plain text for text type."
    },
    "size": {
      "type": "integer",
      "minimum": 64,
      "maximum": 1024,
      "description": "Output image size in pixels (64–1024). Defaults to 256."
    },
    "darkColor": {
      "type": "string",
      "pattern": "^#[0-9A-Fa-f]{6}$",
      "description": "Hex color for dark QR modules, e.g. '#1a1a1a'. Defaults to '#000000'."
    },
    "lightColor": {
      "type": "string",
      "pattern": "^#[0-9A-Fa-f]{6}$",
      "description": "Hex color for the background, e.g. '#ffffff'. Defaults to '#FFFFFF'."
    },
    "dotStyle": {
      "type": "string",
      "enum": [
        "square",
        "dots",
        "rounded",
        "extra-rounded",
        "classy",
        "classy-rounded"
      ],
      "description": "Shape of the QR modules. Free on every plan, keyless sessions included."
    },
    "cornerStyle": {
      "type": "string",
      "enum": [
        "square",
        "dot",
        "extra-rounded"
      ],
      "description": "Shape of the three large corner squares. Free on every plan."
    },
    "frameStyle": {
      "type": "string",
      "enum": [
        "square",
        "rounded",
        "circle",
        "dashed"
      ],
      "description": "Draw a frame around the code. 'square' means no frame. Free on every plan."
    },
    "caption": {
      "type": "string",
      "maxLength": 60,
      "description": "Short text rendered under the code, e.g. 'Scan for the menu'. Forces a frame to be drawn, because the text needs a band to sit on. Free on every plan."
    },
    "format": {
      "type": "string",
      "enum": [
        "png",
        "svg",
        "pdf"
      ],
      "description": "Output format, returned as a data URL of that type. Defaults to 'png'. svg and pdf REQUIRE an API key: vector and PDF are the most expensive render path, so they sit behind a per-key rate limit rather than a per-IP one. This is a cost control, not a plan feature — both are free in the dashboard and in the browser generator on every plan."
    }
  },
  "required": [
    "type",
    "content"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List QR codes saved to the authenticated user's account. Supports pagination and filtering by type. Requires an authenticated API key (Developer plan).

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1,
      "description": "Page number for pagination. Defaults to 1."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Number of QR codes per page (1–100). Defaults to 20."
    },
    "type": {
      "type": "string",
      "enum": [
        "url",
        "wifi",
        "contact",
        "text",
        "email"
      ],
      "description": "Filter by QR code type."
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get scan analytics for the authenticated user's QR codes. Optionally filter to a specific QR code by ID. Requires an authenticated API key (Developer plan).

{
  "type": "object",
  "properties": {
    "qrCodeId": {
      "type": "string",
      "description": "Filter analytics to a specific QR code ID. Omit for account-wide totals."
    },
    "timeRange": {
      "type": "string",
      "enum": [
        "1h",
        "1d",
        "7d",
        "30d",
        "90d",
        "1y"
      ],
      "description": "Time range for analytics data. Defaults to '30d'."
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}