# Animated QR code

Make a QR code that draws itself: an animated SVG in any style that ends as a complete, scannable code.

The code is drawn by the same renderer as every other QR tool and then taken apart into groups of dots that fade in one after another. The SVG holds the finished code as its resting picture, so it is never left half drawn.

- Endpoint: `POST https://setget.net/v1/tools/qr-animate` with JSON `{"input": {...}}`
- MCP: `run_tool` with `slug` = `qr-animate`
- Page: https://setget.net/tools/qr-animate

## Inputs

- `text` (required, string): The text or link to store in the code.
- `effect` (optional, string, one of `center`, `wipe`, `sparkle`, `eyes`, `rain`, default `"center"`): How the code appears: outward from the center, wiped across, sparkling in dot by dot, the three eyes first, or raining down.
- `duration` (optional, number, default `1.8`, range 0.5..6.0): How long the reveal takes, in seconds.
- `repeat` (optional, string, one of `once`, `loop`, default `"once"`): Play once and stay finished, or start again after showing the finished code for two seconds.
- `error_correction` (optional, string, one of `L`, `M`, `Q`, `H`): How much damage the code survives: L about 7%, M 15%, Q 25%, H 30%. Higher levels hold less. Left out: M, or H when there is a logo.
- `module_size` (optional, integer, default `8`, range 1..40): Width of one small square (module) in pixels.
- `margin` (optional, integer, default `4`, range 0..20): Blank quiet zone around the code, in modules. Scanners expect at least 4.
- `foreground` (optional, string): Color of the dots: hex such as #000000, a basic color name, or a CSS linear-gradient(...) or radial-gradient(...). Left out: black.
- `background` (optional, string): Color behind the code: hex, a basic name, "transparent", or a CSS gradient. Left out: white.
- `preset` (optional, string, one of `classic`, `rounded`, `liquid`, `dots`, `ocean`, `sunset`, `forest`, `grape`, `candy`, `ink`, `gold`, `midnight`): A ready-made look. Any style input you set yourself wins over the preset.
- `dot_style` (optional, string, one of `square`, `rounded`, `liquid`, `dots`, `diamond`, `star`, `vertical`, `horizontal`, `leaf`, `mosaic`, `plus`, `hexagon`, `heart`, `maze`): Shape of the small squares (modules). Left out: square.
- `dot_scale` (optional, number, range 0.5..1): Size of each dot within its square, from 0.5 to 1. Thin shapes need more, such as diamond 0.7 and star 0.95 (the error names the least); liquid always fills its square.
- `eye_frame_style` (optional, string, one of `square`, `rounded`, `extra-rounded`, `circle`, `leaf`, `dotted`): Shape of the outer ring of the three corner eyes.
- `eye_ball_style` (optional, string, one of `square`, `rounded`, `circle`, `diamond`, `leaf`, `octagon`): Shape of the solid middle of the three corner eyes.
- `eye_colour` (optional, string): Color of the eye rings. Left out: the dot color.
- `eye_ball_colour` (optional, string): Color of the middle of the eyes. Left out: the eye ring color.
- `eye_colours` (optional, string): A color for each eye, separated by commas, in the order top-left, top-right, bottom-left: for instance "#b91c1c, #1d4ed8, #15803d". Plain colors only. An eye left out, or left empty between commas, keeps eye_colour.
- `corner_radius` (optional, number, range 0..0.5): Rounds the corners of the background, as a fraction of its side.
- `shape` (optional, string, one of `square`, `circle`, `squircle`, `octagon`, `hexagon`, `shield`, `bubble`, `heart`): Outline of the whole code: square, or a silhouette such as circle or heart. The code itself stays a complete square inside it, behind a clear ring as wide as margin, and matching dots fill the rest of the outline. Left out: square.
- `logo` (optional, string): A picture for the middle of the code, as a data: URI (PNG, JPEG, WebP, GIF or SVG, up to about 290 KB).
- `logo_size` (optional, number, range 0.1..0.4): Largest logo width as a fraction of the code, from 0.1 to 0.4. It is made smaller when the code would not scan. Left out: 0.22.
- `logo_padding` (optional, number, range 0..3): Clear space around the logo, in modules. Left out: 1.
- `logo_shape` (optional, string, one of `none`, `square`, `rounded`, `circle`): Shape of the clear area behind the logo. "none" leaves the background showing.
- `logo_background` (optional, string): Color of the clear area behind the logo. Left out: the background color.
- `logo_text` (optional, string): One to four characters for the middle of the code in place of a picture, such as initials. Drawn as outlines in the frame font, so they look the same everywhere.
- `logo_icon` (optional, string, one of `heart`, `star`, `wifi`, `phone`, `mail`, `link`, `home`, `pin`, `cart`, `bag`, `camera`, `music`, `calendar`, `person`, `globe`, `lock`, `gift`, `cup`, `bolt`, `chat`, `play`, `info`, `tag`, `book`): A small symbol for the middle of the code in place of a picture.
- `logo_colour` (optional, string): Color of the center text or symbol. Left out: the eye color.
- `background_image` (optional, string): A photo shown behind the code, as a data: URI (up to about 440 KB). The dots are drawn over it so the code still scans.
- `background_image_wash` (optional, number, range 0..0.9): How much the photo is lightened, from 0 to 0.9. Left out: 0.35.
- `frame` (optional, string, one of `none`, `label`, `banner`, `banner-top`, `rounded`): A border with a short call to action under (or above) the code.
- `frame_text` (optional, string): The words in the frame. Left out: SCAN ME.
- `frame_colour` (optional, string): Color of the frame. Left out: the dot color.
- `frame_text_colour` (optional, string): Color of the frame text. Left out: whichever of dark or light reads best.
- `frame_font` (optional, string, one of `sans`, `mono`): Letter style of the frame text.

## Example 1: From the center outward

```json
{"input":{"text":"https://setget.net","effect":"center","preset":"ocean"}}
```

## Example 2: Sparkling in, on a loop

```json
{"input":{"text":"https://setget.net","effect":"sparkle","preset":"candy","repeat":"loop"}}
```

## Example 3: Eyes first, slowly

```json
{"input":{"text":"https://setget.net","effect":"eyes","dot_style":"liquid","duration":3}}
```

**Does an animated code still scan?** Yes, as soon as it has finished appearing. The picture ends as the complete code and stays that way, and the scan rating in the result is the rating of that finished code.

**Where does the animation play?** In web pages, as a picture or inline, in every current browser. Anything that does not play SVG animation, a printer or a file preview for instance, shows the finished code.

**Can I get a GIF or a video?** Yes: the QR export tool makes a GIF, an animated PNG or an MP4 of the same reveal, for slides, social posts and screens that do not show SVG.

**Does the code expire or track scans?** No. The content is stored in the picture itself, so the code works forever. Nothing is redirected or counted, and nothing needs an account.

**Can I add a logo, colors or rounded dots?** Yes. Every QR tool takes the same style inputs: dot and eye shapes, colors and CSS gradients, a logo, a background photo, a frame with text, and ready-made presets. Unstyled codes stay exactly as they always were.
