---
title: "QR code (PNG or SVG)"
method: POST
path: "/qr"
tags: ["Images"]
---

# QR code (PNG or SVG)

`POST /qr`

## Request

- Base URL: `https://api.cofferdock.com`
- URL: `https://api.cofferdock.com/qr`
- Auth: API key in header `x-api-key`

Turns a link or any text (max 1500 characters) into a QR code.

Costs 1 credit per call.

## Request body

- object
  - `data` string, required: The link or text to encode. "url" and "text" are accepted as aliases.
  - `size` integer: Side in pixels.
  - `margin` integer: Quiet zone, in modules.
  - `format` 'png' | 'svg': Image format: "png" (default) or "svg" (vector: scales without losing quality).
  - `dark` string: Colour of the dots.
  - `light` string: Background colour.
  - `ecc` 'L' | 'M' | 'Q' | 'H': Error correction level.
  - `output` 'json' | 'binary' | 'url' | 'image': How to return the image: "json" (base64 in the JSON response), "binary" (the image itself, ready for n8n/Make/Zapier) or "url" (a temporary download link, valid 15 minutes). Default: json when the request is JSON, binary when the input was sent raw.

## Response `200`

The resulting image (shape depends on `output`).

- union
  - object
    - `success` boolean
    - `image` string, byte
    - `mime_type` 'image/png' | 'image/svg+xml'
    - `meta` object
      - `size_bytes` integer
      - `format` string
      - `used` integer: Credits used this month, after this call.
      - `remaining` integer, nullable: Credits left this month (null = unlimited).
      - `unlimited` boolean
  - object: Returned when output=url: a temporary download link (valid 15 minutes).
    - `success` boolean
    - `url` string, uri: Temporary download link. Expires in 15 minutes.
    - `expires_at` string, date-time
    - `mime_type` string
    - `size_bytes` integer
    - `meta` object
      - `used` integer: Credits used this month, after this call.
      - `remaining` integer, nullable: Credits left this month (null = unlimited).
      - `unlimited` boolean

## Other responses

- `400`: Invalid input (nothing is charged).
- `401`: Missing or invalid API key.
- `403`: Email not verified.
- `429`: Monthly credit limit reached, or too many requests per minute for this key (see Retry-After).
- `503`: Server busy (queue full). Retry after the seconds in the Retry-After header.

---

[API](https://skmtc.dev/cofferdock/apis/cofferdock-api.md) · [All operations](https://skmtc.dev/cofferdock/apis/cofferdock-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cofferdock/apis/cofferdock-api/revisions/b57aa000d33a?raw)