---
title: "Which QR code platforms have SDKs for TypeScript or Python?"
description: "Official Linkbreakers SDKs for TypeScript, Python, Go, Java and Rust: install lines, a first request in each, and the REST API, webhooks and MCP server."
canonical: "https://linkbreakers.com/developers"
last-updated: 2026-11-16
---

# Which QR code platforms have SDKs for TypeScript or Python?

Linkbreakers has official SDKs for TypeScript, Python, Go, Java and Rust. Each one is generated from the API's OpenAPI description and published again with every API release, so it covers the whole REST API: create a dynamic QR code, put a workflow behind it, and read who scanned.

| Language | Package | Latest | Install |
|---|---|---|---|
| TypeScript | `linkbreakers` on [npm](https://www.npmjs.com/package/linkbreakers) | [1.200.2](https://www.npmjs.com/package/linkbreakers/v/1.200.2) | `npm install linkbreakers` |
| Python | `linkbreakers` on [PyPI](https://pypi.org/project/linkbreakers/) | [1.200.2](https://pypi.org/project/linkbreakers/1.200.2/) | `pip install linkbreakers` |
| Go | `github.com/linkbreakers-com/linkbreakers-go` on [Go modules](https://pkg.go.dev/github.com/linkbreakers-com/linkbreakers-go) | [1.200.2](https://pkg.go.dev/github.com/linkbreakers-com/linkbreakers-go@v1.200.2) | `go get github.com/linkbreakers-com/linkbreakers-go` |
| Java | `com.linkbreakers:linkbreakers-sdk` on [Maven Central](https://central.sonatype.com/artifact/com.linkbreakers/linkbreakers-sdk) | [1.200.2](https://central.sonatype.com/artifact/com.linkbreakers/linkbreakers-sdk/1.200.2) | `implementation("com.linkbreakers:linkbreakers-sdk:1.200.2")` |
| Rust | `linkbreakers` on [crates.io](https://crates.io/crates/linkbreakers) | [1.200.2](https://crates.io/crates/linkbreakers/1.200.2) | `cargo add linkbreakers` |

A QR code library draws an image from a string. These SDKs create a code you can repoint after it is printed, put steps behind it (a form that asks for an email, a condition that sends iPhones and Android phones to different stores) and read every scan and visitor back in your own backend, the same day.

## Quickstart

Each sample creates a link with its dynamic QR code and prints its short URL, with a [workspace API token](https://linkbreakers.com/help/article/what-are-api-tokens) in `LINKBREAKERS_TOKEN`.

TypeScript:

```typescript
import { Configuration, LinksApi } from 'linkbreakers';

const links = new LinksApi(new Configuration({
  accessToken: process.env.LINKBREAKERS_TOKEN ?? '',
}));

// Creates the link, its short URL and its dynamic QR code.
const { link } = await links.linksServiceCreate({
  createLinkRequest: { destination: 'https://example.com', name: 'Flyer' },
});
console.log(link?.shortlink);
```

Python:

```python
import os
from linkbreakers import ApiClient, Configuration, CreateLinkRequest, LinksApi

config = Configuration(access_token=os.environ["LINKBREAKERS_TOKEN"])
with ApiClient(config) as client:
    # Creates the link, its short URL and its dynamic QR code.
    response = LinksApi(client).links_service_create(
        create_link_request=CreateLinkRequest(destination="https://example.com", name="Flyer")
    )
    print(response.link.shortlink)
```

Go:

```go
package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/linkbreakers-com/linkbreakers-go"
)

func main() {
	config := linkbreakers.NewConfiguration()
	config.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("LINKBREAKERS_TOKEN"))
	client := linkbreakers.NewAPIClient(config)

	// Creates the link, its short URL and its dynamic QR code.
	request := linkbreakers.NewCreateLinkRequest("https://example.com")
	request.SetName("Flyer")
	response, _, err := client.LinksAPI.LinksServiceCreate(context.Background()).CreateLinkRequest(*request).Execute()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response.Link.GetShortlink())
}
```

Java:

```java
import com.linkbreakers.ApiClient;
import com.linkbreakers.api.LinksApi;
import com.linkbreakers.model.CreateLinkRequest;
import com.linkbreakers.model.CreateLinkResponse;

public class Quickstart {
  public static void main(String[] args) throws Exception {
    ApiClient client = new ApiClient();
    client.setBearerToken(System.getenv("LINKBREAKERS_TOKEN"));

    // Creates the link, its short URL and its dynamic QR code.
    CreateLinkResponse response = new LinksApi(client).linksServiceCreate(
        new CreateLinkRequest().destination("https://example.com").name("Flyer"), null);
    System.out.println(response.getLink().getShortlink());
  }
}
```

Rust:

```rust
use linkbreakers::apis::{configuration::Configuration, links_api};
use linkbreakers::models::CreateLinkRequest;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut config = Configuration::new();
    config.bearer_access_token = Some(std::env::var("LINKBREAKERS_TOKEN")?);

    // Creates the link, its short URL and its dynamic QR code.
    let request = CreateLinkRequest {
        destination: "https://example.com".into(),
        name: Some("Flyer".into()),
        ..Default::default()
    };
    let response = links_api::links_service_create(&config, request, None).await?;
    println!("{}", response.link.and_then(|link| link.shortlink).unwrap_or_default());
    Ok(())
}
```

Needs an async runtime: `cargo add tokio --features full`.

Other QR code platforms publish SDKs or client libraries too; check in each one's developer docs which languages are official and which plan opens the API. How they compare: [What is the best QR code API for developers?](https://linkbreakers.com/help/article/best-qr-code-api-for-developers) For AI agents rather than code, see [Is there an MCP server that lets an AI agent create and track QR codes?](https://linkbreakers.com/help/article/qr-code-mcp-server-for-ai-agents)

## The REST API the SDKs wrap

`POST https://api.linkbreakers.com/v1/links` with a `destination` creates the link, its short URL and its QR code, and `GET https://api.linkbreakers.com/v1/links/{id}?include=qrcodeSignedUrl` returns the QR code image URL. `POST https://api.linkbreakers.com/v1/webhooks` makes Linkbreakers POST every scan of that link to your endpoint as JSON, signed with HTTP Message Signatures (RFC 9421). AI agents can create and track QR codes through the hosted MCP server at `https://mcp.linkbreakers.com`. The Free plan costs $0, needs no credit card, and includes the REST API, webhooks and the MCP server.

REST API for links, QR codes, workflow steps, media (PDFs, images, videos), visitors, events, analytics, webhooks and custom domains. Bearer auth with a workspace API token.

## Base URL

`https://api.linkbreakers.com`

## Authentication

Send a [workspace API token](https://linkbreakers.com/help/article/what-are-api-tokens) as `Authorization: Bearer <token>`. Create one yourself in the [dashboard](https://app.linkbreakers.com/workspace/dashboard/api-tokens) after a [free signup](https://app.linkbreakers.com?offer=free-plan&ref=landing-free-plan&showcase=default); no sales contact is needed.

MCP clients sign in with OAuth 2.1 instead: the MCP server does not accept workspace API tokens. The full walkthrough for agents is [auth.md](https://linkbreakers.com/auth.md), and the protected resource metadata is at https://api.linkbreakers.com/.well-known/oauth-protected-resource.

## Rate limits

Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.

- Workspace API token: 720 requests per 60 seconds, per token.
- Dashboard session or OAuth token: 600 requests per 60 seconds, per token.
- No credentials: 300 requests per 60 seconds, per client IP.

Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.

## Example requests

List pricing plans (no token needed):

```bash
curl https://api.linkbreakers.com/v1/pricing/plans
```

List links:

```bash
curl "https://api.linkbreakers.com/v1/links?pageSize=5" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Create a link with a tracked QR code:

```bash
curl -X POST https://api.linkbreakers.com/v1/links \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"destination": "https://example.com", "waitForQrcode": true}'
```

Get the link's QR code image URL (signed, it expires, so fetch it when you render):

```bash
curl "https://api.linkbreakers.com/v1/links/$LINK_ID?include=qrcodeSignedUrl" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Send that link's scans to your endpoint with a webhook (linkId is the link's id; leave it out to receive every link's scans):

```bash
curl -X POST https://api.linkbreakers.com/v1/webhooks \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Scans", "endpointUrl": "https://hooks.example.com/linkbreakers", "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed"}'
```

## Scan webhooks

A webhook is created with `name` and `endpointUrl`, optionally a `linkId` to receive one link's scans only, and `triggers` to pick the workflow step kinds that fire it (`KIND_ENTRY`, `KIND_INTERACTION`, `KIND_CONDITION`, `KIND_EXIT`; empty means all). There is one delivery per step completion (a step completed twice in a visit sends two), each a JSON `POST` whose body is an envelope:

- `type`: the visit event, `visit.entered` (entry), `visit.interacted` (a form or other interaction), `visit.routed` (a condition) or `visit.exited` (the exit, for a plain QR code the redirect)
- `id`, `version`, `createdAt`, `attempt` and `webhook`: the delivery ID (the same on every retry), the contract version, when the step was completed, the attempt number, and the webhook's `id` and `name`
- `data.event`: the scan, with `action` (`SCAN` or `CLICK`), `scannedAt`, `device` (type, browser, platform, country, city, in-app browser), `visitor` (email, phone and attributes once known), `traces` (what the visitor did at each step), `journey` and `link` (its `metadata` and `tags`)
- `data.step`: the workflow step that was completed
- `data.lbid`: the Linkbreakers ID of the visit, for attribution in your own systems

Headers: `X-Linkbreakers-Event` (the event) and `X-Linkbreakers-Delivery-ID` (deduplicate retries on it), both covered by `Signature`, `Signature-Input` and `Signature-Agent` with `Content-Digest`, verifiable with public keys only ([how](https://linkbreakers.com/help/article/verify-webhook-signatures)). The full payload and delivery rules are in [How do webhooks work in Linkbreakers?](https://linkbreakers.com/help/article/how-do-webhooks-work-in-linkbreakers)

A tested Python example, from creating the QR code to a receiver that answers first, skips retries and saves each scan: [Create a QR code from Python and get its scans in a webhook](https://linkbreakers.com/help/article/best-qr-code-api-for-developers#create-a-qr-code-from-python-and-get-its-scans-in-a-webhook).

## Endpoints by resource

- [Agents](https://linkbreakers.com/help/api/agents) (9 endpoints): AI chat personas you build (a role, a tone, guardrails and knowledge documents) and plug into a link's Chat Bot step, where they talk to your visitors.
- [Analytics](https://linkbreakers.com/help/api/analytics) (16 endpoints): Scan and visit numbers: rolling workspace totals, time series, and breakdowns by country, device, hour, link or workflow step, with funnels, A/B splits and visitor attributes.
- [Analytics Dashboards](https://linkbreakers.com/help/api/analytics-dashboards) (6 endpoints): Saved analytics dashboards, for the whole workspace or one link: each widget names its data source and how it is charted.
- [Custom Domains](https://linkbreakers.com/help/api/custom-domains) (7 endpoints): Your own domain for short links and QR codes: add it, get the DNS records to set, and check it is live with its certificate.
- [Directories](https://linkbreakers.com/help/api/directories) (5 endpoints): Folders for your links: directories hold links and other directories, as a tree.
- [Events](https://linkbreakers.com/help/api/events) (2 endpoints): Every scan and visit as a raw event, and the workflow steps each visitor went through.
- [Integrations: Contact Tools](https://linkbreakers.com/help/api/integrations-contact-tools) (10 endpoints): Send the people who scan your QR codes and fill your forms to the tool you reach customers with (CRMs and email marketing tools), as contacts on a list or audience.
- [Integrations: Forms](https://linkbreakers.com/help/api/integrations-forms) (8 endpoints): Connect Google Forms, Tally, Typeform, Jotform or Paperform: each response is attached to the visitor whose visit opened the form.
- [Integrations: Google Analytics](https://linkbreakers.com/help/api/integrations-google-analytics) (4 endpoints): Send every scan, visit, form submission and captured visitor detail to your Google Analytics 4 property, server side.
- [Integrations: Retargeting Pixels](https://linkbreakers.com/help/api/integrations-retargeting-pixels) (3 endpoints): Fire your ad platforms' pixels (Meta, Google, TikTok, LinkedIn, Google Tag Manager) when someone opens one of your links or scans one of your QR codes, to retarget them later.
- [Integrations: Slack](https://linkbreakers.com/help/api/integrations-slack) (5 endpoints): Post scans, visits and form submissions on your links to a Slack channel as they happen.
- [Jobs](https://linkbreakers.com/help/api/jobs) (1 endpoints): Follow a bulk link creation that runs in the background. Start it with `POST /v1/links/bulk/jobs`, then check it here until it is done.
- [Link Settings](https://linkbreakers.com/help/api/link-settings) (4 endpoints): How much identifying data visitors are asked for: the workspace's data collection level and each link's settings.
- [Links](https://linkbreakers.com/help/api/links) (15 endpoints): Short links and their QR codes: create them (one at a time, in bulk or in the background), read, update and delete them, and render their QR code images.
- [Media](https://linkbreakers.com/help/api/media) (11 endpoints): Your media library: images, PDFs and videos for link pages, QR codes and workflow steps. Upload, import from a URL, replace and delete.
- [Members](https://linkbreakers.com/help/api/members) (9 endpoints): The people in your workspace: invite them, change their role, revoke or restore their access, sign them out, remove them.
- [Page Theme Templates](https://linkbreakers.com/help/api/page-theme-templates) (10 endpoints): Reusable page looks: save a link's theme as a template, publish it, import a public one, and apply it to links.
- [Page Themes](https://linkbreakers.com/help/api/page-themes) (5 endpoints): The look of a link's pages (colors, fonts, cover, badge, buttons): read and update one link's theme, or restyle many links at once.
- [Pricing](https://linkbreakers.com/help/api/pricing) (1 endpoints): The public plan catalog: what each plan costs and what it allows. No authentication needed.
- [QR Code Designs](https://linkbreakers.com/help/api/qr-code-designs) (5 endpoints): The look of a link's QR code: colors, dot and corner shapes, and the logo in its center. Apply a template to a link's code.
- [QR Code Templates](https://linkbreakers.com/help/api/qr-code-templates) (9 endpoints): Reusable QR code designs: save one, publish it, import a public one, and apply it to links.
- [Tags](https://linkbreakers.com/help/api/tags) (2 endpoints): The labels you put on links to group and filter them: list them, or delete tags from every link that carries them.
- [Visitors](https://linkbreakers.com/help/api/visitors) (9 endpoints): The people who scan your QR codes or open your links: identify them with your own data ($email, $phone, any key), read, search, update and delete them.
- [Webhooks](https://linkbreakers.com/help/api/webhooks) (5 endpoints): Your own URLs, called with each event you subscribe them to (scans, visits, form submissions).
- [Workflow Steps](https://linkbreakers.com/help/api/workflow-steps) (12 endpoints): What happens when someone opens a link: the steps (redirects, forms, pages, conditions, a chat bot) and where each step's exits lead.
- [Workspace Tokens](https://linkbreakers.com/help/api/workspace-tokens) (6 endpoints): The API tokens that authenticate these endpoints: create, list, update and revoke them.
- [Workspaces](https://linkbreakers.com/help/api/workspaces) (5 endpoints): Your workspace: read and update its settings, see how much of its plan it has used, or delete it.

## Endpoints that need no authentication

- `GET https://api.linkbreakers.com/v1/pricing/plans`: List pricing plans
- `GET https://api.linkbreakers.com/v1/public/page-theme-templates`: List page theme templates
- `GET https://api.linkbreakers.com/v1/public/qrcode-templates`: List QR code templates
- `GET https://api.linkbreakers.com/v1/workspace-tokens/scopes`: List the scopes a token can have

## Bulk operations

- `POST https://api.linkbreakers.com/v1/links/batch`: Create multiple links from a bare JSON array
- `POST https://api.linkbreakers.com/v1/links/bulk`: Create multiple links in a single request
- `POST https://api.linkbreakers.com/v1/links/bulk/jobs`: Create links in bulk in the background
- `POST https://api.linkbreakers.com/v1/page-themes/bulk-update`: Restyle many links' page themes
- `POST https://api.linkbreakers.com/v1/workflow-steps/bulk-insert`: Insert one step into many links' workflows

For one QR code per table, product or serial number from a single link, use a [dynamic short link](https://linkbreakers.com/help/article/dynamic-slugs-capture-data-from-the-url-path): `POST /v1/links/{id}/qrcode-images:render` draws up to 100 codes per call in the link's design. On packaging, the same call renders a [GS1 Digital Link](https://linkbreakers.com/help/article/gs1-digital-link-qr-codes-with-linkbreakers) code per batch (`01/{gtin}/10/{batch}`), and a visitor data condition sends a recalled batch to its notice.

## Examples

Runnable examples, one directory per task, in [linkbreakers-com/examples](https://github.com/linkbreakers-com/examples):

- [Bulk dynamic QR codes from a CSV (Python)](https://github.com/linkbreakers-com/examples/tree/main/bulk-dynamic-qr-codes-from-csv-python): one dynamic QR code and short link per CSV row with the Python SDK, SVG files out, scan counts back to a CSV.
- [Bulk dynamic QR codes from a CSV (TypeScript)](https://github.com/linkbreakers-com/examples/tree/main/bulk-dynamic-qr-codes-from-csv-typescript): the same CSV workflow with the TypeScript SDK: one bulk call per 250 rows, SVG QR codes out, scan counts back to a CSV.
- [One QR code for the App Store and Google Play (Python)](https://github.com/linkbreakers-com/examples/tree/main/app-download-qr-code-iphone-android-python): a Device Platform condition that sends iPhones to the App Store, Android phones to Google Play and everything else to a fallback page.
- [QR code scans by product line and country (Python)](https://github.com/linkbreakers-com/examples/tree/main/qr-code-scans-by-product-and-country-python): packaging codes tagged by product line, then scans per product line and country read from the analytics API with the tag_id and countries filters.

## CLI

- Homebrew: `brew install linkbreakers-com/tap/linkbreakers` ([registry](https://github.com/linkbreakers-com/homebrew-tap))
- Install script (macOS, Linux): `curl -fsSL https://cli.linkbreakers.com/install.sh | bash`
- npm: `npm install -g linkbreakers-cli` ([registry](https://www.npmjs.com/package/linkbreakers-cli), latest [1.200.2](https://www.npmjs.com/package/linkbreakers-cli/v/1.200.2))
- Docs: https://linkbreakers.com/cli, source: https://github.com/linkbreakers-com/linkbreakers-cli, latest release [v1.200.2](https://github.com/linkbreakers-com/linkbreakers-cli/releases/tag/v1.200.2)

## MCP servers

- Linkbreakers MCP: `https://mcp.linkbreakers.com` (oauth2). Create links, QR codes, workflows and media, and read visitors and analytics in your workspace.
  Local stdio server: `npx -y linkbreakers-mcp` (package `linkbreakers-mcp` on [npm](https://www.npmjs.com/package/linkbreakers-mcp), latest [1.200.2](https://www.npmjs.com/package/linkbreakers-mcp/v/1.200.2), source at https://github.com/linkbreakers-com/linkbreakers-mcp)
  Linkbreakers MCP supports MCP Apps (`io.modelcontextprotocol/ui`, `text/html;profile=mcp-app`) and the OpenAI Apps SDK (`openai/outputTemplate`): tool results render as interactive UI in the conversation. Views: Link card (`ui://linkbreakers/link-card.html`, for `links_create`, `links_get`); Visitors (`ui://linkbreakers/visitors-card.html`, for `visitors_list`); Workspace metrics (`ui://linkbreakers/workspace-metrics.html`, for `analytics_workspace_metric`). [MCP Apps guide](https://linkbreakers.com/help/article/mcp-apps-interactive-ui)
- Linkbreakers Docs MCP: `https://linkbreakers.com/mcp` (no sign-in). Search and read the Linkbreakers help center and developer docs. No sign-in required.

## Machine-readable descriptions

- [OpenAPI](https://linkbreakers.com/openapi.json) (upstream: https://api.linkbreakers.com/internal/openapi/api/v1/api.swagger.json)
- [API catalog](https://linkbreakers.com/.well-known/api-catalog) (RFC 9727)
- [API llms.txt](https://linkbreakers.com/api/llms.txt)
- [Agent view](https://linkbreakers.com/?mode=agent)

## SDKs

- TypeScript SDK: package `linkbreakers` on [npm](https://www.npmjs.com/package/linkbreakers), latest version [1.200.2](https://www.npmjs.com/package/linkbreakers/v/1.200.2), install with `npm install linkbreakers`, docs at https://linkbreakers.com/sdk/typescript, source at https://github.com/linkbreakers-com/linkbreakers-typescript
- Python SDK: package `linkbreakers` on [PyPI](https://pypi.org/project/linkbreakers/), latest version [1.200.2](https://pypi.org/project/linkbreakers/1.200.2/), install with `pip install linkbreakers`, docs at https://linkbreakers.com/sdk/python, source at https://github.com/linkbreakers-com/linkbreakers-python
- Go SDK: package `github.com/linkbreakers-com/linkbreakers-go` on [Go modules](https://pkg.go.dev/github.com/linkbreakers-com/linkbreakers-go), latest version [1.200.2](https://pkg.go.dev/github.com/linkbreakers-com/linkbreakers-go@v1.200.2), install with `go get github.com/linkbreakers-com/linkbreakers-go`, docs at https://linkbreakers.com/sdk/go, source at https://github.com/linkbreakers-com/linkbreakers-go
- Java SDK: package `com.linkbreakers:linkbreakers-sdk` on [Maven Central](https://central.sonatype.com/artifact/com.linkbreakers/linkbreakers-sdk), latest version [1.200.2](https://central.sonatype.com/artifact/com.linkbreakers/linkbreakers-sdk/1.200.2), install with `com.linkbreakers:linkbreakers-sdk`, docs at https://linkbreakers.com/sdk/java, source at https://github.com/linkbreakers-com/linkbreakers-java
- Rust SDK: package `linkbreakers` on [crates.io](https://crates.io/crates/linkbreakers), latest version [1.200.2](https://crates.io/crates/linkbreakers/1.200.2), install with `cargo add linkbreakers`, docs at https://linkbreakers.com/sdk/rust, source at https://github.com/linkbreakers-com/linkbreakers-rust

## Plans

The Free plan costs $0, needs no credit card, and includes the REST API, webhooks and the MCP server. Prices and limits are in [pricing.md](https://linkbreakers.com/pricing.md). Questions: support@linkbreakers.com.

Updated 2026-11-16 by Laurent Schaffner.
