Skip to content

SDKs & CLI

SDKs & CLI

qr3.app provides official client libraries for the most common languages and a CLI for scripting.

TypeScript / JavaScript

Terminal window
npm install @qr3/sdk
# or
pnpm add @qr3/sdk
import { QR3 } from "@qr3/sdk";
const client = new QR3({ apiKey: process.env.QR3_API_KEY! });
// Create a QR code
const code = await client.codes.create({
type: "url",
url: "https://example.com",
title: "My QR Code",
is_dynamic: true,
});
// List QR codes
const codes = await client.codes.list({ limit: 20 });
// Get scan analytics
const scans = await client.scans.list(code.data.id, { days: 30 });

Python

Terminal window
pip install qr3
from qr3 import QR3
client = QR3(api_key="qr3_sk_your_key")
code = client.codes.create(
type="url",
url="https://example.com",
is_dynamic=True,
)
print(code["data"]["short_code"])
# Download SVG
svg_bytes = client.codes.get_svg(code["data"]["short_code"])

Go

Terminal window
go get github.com/qr3app/qr3-go
package main
import (
"context"
"fmt"
qr3 "github.com/qr3app/qr3-go/qr3"
)
func main() {
client := qr3.New(
"qr3_sk_your_key",
qr3.WithWorkspaceID("ws_your_workspace_id"),
)
code, err := client.Codes.Create(context.Background(), qr3.CreateCodeParams{
Type: "url",
URL: "https://example.com",
})
if err != nil {
panic(err)
}
fmt.Println(code.Data.ShortCode)
// Download PNG
png, _ := client.Codes.GetPNG(context.Background(), code.Data.ShortCode, nil)
_ = png // []byte
}

CLI

Terminal window
npm install -g @qr3/cli
Terminal window
# Authenticate
qr3 login
# Create a QR code
qr3 create https://example.com --title "My QR" --dynamic
# List codes
qr3 list
# Download QR image
qr3 download r7f3Kx --format svg --output code.svg
qr3 download r7f3Kx --format pdf --output code.pdf
# View scan analytics
qr3 scans r7f3Kx --days 30
# Create from file (bulk)
qr3 batch create ./urls.csv

MCP Server (AI Agents)

Install the qr3.app MCP server for AI agents like Claude or Cursor:

claude_desktop_config.json
{
"mcpServers": {
"qr3": {
"command": "npx",
"args": ["-y", "@qr3/mcp-server"],
"env": {
"QR3_API_KEY": "qr3_sk_your_key"
}
}
}
}

Full MCP documentation