---
title: "Linkbreakers TypeScript SDK - Official TypeScript / JavaScript Client Library"
description: "The official Linkbreakers TypeScript SDK for Node.js, Deno, Bun, and browser environments. Full type safety, dual-key authentication, and framework examples for Next.js, Express, and React."
canonical: "https://linkbreakers.com/sdk/typescript"
---

# Linkbreakers TypeScript SDK - Official TypeScript / JavaScript Client Library

> The official Linkbreakers TypeScript SDK for Node.js, Deno, Bun, and browser environments. Full type safety, dual-key authentication, and framework examples for Next.js, Express, and React.

Linkbreakers SDKTypeScript

# Linkbreakers TypeScript SDK

Build lead capture into your TypeScript and JavaScript applications: tracked links and QR codes, visitor identification and attributes. Full type safety with dual-key authentication for frontend and backend.

[Start free with Linkbreakers](https://app.linkbreakers.com?showcase=sdk-typescript&ref=landing-sdk-typescript)[Read the quickstart guide](https://linkbreakers.com/help/article/typescript-sdk-quickstart)

[npm](https://www.npmjs.com/package/linkbreakers)[GitHub](https://github.com/linkbreakers-com/linkbreakers-typescript)[v1.185.0](https://www.npmjs.com/package/linkbreakers/v/1.185.0)linkbreakers

Install via npm / pnpm / yarn

One command

Open source

GitHub

API coverage

Complete

## Why use the TypeScript SDK

Integrate Linkbreakers into your TypeScript / JavaScript stack with type-safe, production-ready methods.

### Full API coverage

Every Linkbreakers dashboard feature is available through the SDK — links, workflows, QR codes, analytics, domains, and visitor tracking.

### Type-safe and documented

Generated from the OpenAPI specification with full type definitions, IDE autocomplete, and inline documentation.

### Production-ready

Built-in error handling, retry logic support, and authentication management. Open source on GitHub with active maintenance.

## Quick start

Install the SDK, authenticate, and make your first API call.

Install

npm / pnpm / yarn

npm install linkbreakers

Create a tracked link

import { Configuration, LinksApi } from 'linkbreakers';

const config = new Configuration({
  accessToken: process.env.LINKBREAKERS_SECRET_KEY,
  basePath: 'https://api.linkbreakers.com',
});

const api = new LinksApi(config);
const response = await api.linksServiceCreate({
  createLinkRequest: {
    destination: 'https://example.com',
    name: 'Campaign Link',
    tags: ['marketing'],
  },
});

console.log(response.link.shortlink);

Identify a visitor (frontend)

import { Configuration, VisitorsApi } from 'linkbreakers';

const config = new Configuration({
  accessToken: process.env.NEXT_PUBLIC_LINKBREAKERS_PK,
  basePath: 'https://api.linkbreakers.com',
});

const visitorsApi = new VisitorsApi(config);
const lbid = new URLSearchParams(window.location.search).get('lbid');

await visitorsApi.visitorsServiceIdentify({
  identifyRequest: {
    lbid,
    visitor: {
      data: {
        '$email': 'user@example.com',
        '$firstName': 'Jane',
        plan: 'premium',
      },
    },
  },
});

List links with filters

const links = await api.linksServiceList({
  tags: ['marketing'],
  pageSize: 20,
});

for (const link of links.links) {
  console.log(`${link.name}: ${link.shortlink}`);
}

## Common use cases

What teams build with the Linkbreakers TypeScript SDK.

Next.js and React frontend visitor tracking

Express and Node.js backend link management

Browser-safe publishable keys for visitor identification

## Part of the Linkbreakers developer ecosystem

The TypeScript SDK is one of five official SDKs. Linkbreakers also offers an MCP server for AI assistants and a CLI for terminal workflows.

[MCP ServerAI assistants via OAuth](https://linkbreakers.com/mcp)[CLITerminal and any LLM](https://linkbreakers.com/cli)[REST APIFull API reference](https://linkbreakers.com/help/api)[EcosystemFull overview](https://linkbreakers.com/help/article/linkbreakers-developer-ecosystem-overview)

## Ready to build with the TypeScript SDK?

Sign up for Linkbreakers, create an API token, and start integrating in minutes.

[Create your workspace](https://app.linkbreakers.com?showcase=sdk-typescript&ref=landing-sdk-typescript)

---

Source: https://linkbreakers.com/sdk/typescript