linkkit

Developer-friendly & type-safe Typescript SDK specifically catered to leverage linkkit API.

Summary

Linkkit API: The Linkkit API lets you create and manage short links, QR codes, tags, lists, UTM templates, and analytics — all programmatically.

Authentication

All /v1/* endpoints require authentication. Pass your API key in either header:

Authorization: Bearer <your-api-key>
X-Api-Key: <your-api-key>

Supabase JWTs are also accepted for dashboard clients. If you're accessing the API via RapidAPI, authentication is handled automatically by the RapidAPI proxy.

Pagination

List endpoints support ?page= (1-based, default 1) and ?limit= (default 20, max 100). Responses include a meta object with page, limit, and total.

Table of Contents

• linkkit
  • Authentication
  • Pagination
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Pagination
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add https://github.com/Linkkit-Space/linkkit-ts-sdk

PNPM

pnpm add https://github.com/Linkkit-Space/linkkit-ts-sdk

Bun

bun add https://github.com/Linkkit-Space/linkkit-ts-sdk

Yarn

yarn add https://github.com/Linkkit-Space/linkkit-ts-sdk

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import() to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Linkkit } from "linkkit";

const linkkit = new Linkkit();

async function run() {
  const result = await linkkit.links.healthCheck();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme | Environment Variable | | ------------ | ------ | ----------- | ---------------------- | | bearerAuth | http | HTTP Bearer | LINKKIT_BEARER_AUTH | | apiKeyAuth | apiKey | API key | LINKKIT_API_KEY_AUTH |

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Linkkit } from "linkkit";

const linkkit = new Linkkit({
  security: {
    bearerAuth: process.env["LINKKIT_BEARER_AUTH"] ?? "",
  },
});

async function run() {
  const result = await linkkit.links.healthCheck();

  console.log(result);
}

run();

Available Resources and Operations

Analytics

• getSummary - Summary statistics
• getLinkEvents - Click events for a link

Authentication

• test - Validate API key

Conversions

• list - List conversions

Domains

• list - List domains
• get - Get a domain

Exports

• exportLinksAsCsv - Export links as CSV
• getClicksCsv - Export clicks as CSV

Links

• healthCheck - Health check
• list - List links
• create - Create a link
• upsert - Upsert a link
• get - Get a link
• update - Update a link
• delete - Delete a link
• bulkCreate - Bulk create links

Lists

• getAll - List all lists
• create - Create a list
• get - Get a list
• update - Update a list
• delete - Delete a list

QrCodes

• list - List QR codes
• create - Create a QR code
• get - Get a QR code
• update - Update a QR code
• delete - Delete a QR code

Tags

• list - List tags
• create - Create a tag
• get - Get a tag
• update - Update a tag
• delete - Delete a tag

Tracking

• lead - Track a lead
• trackSale - Track a sale

UtmTemplates

• list - List UTM templates
• create - Create a UTM template
• get - Get a UTM template
• update - Update a UTM template
• delete - Delete a UTM template

Webhooks

• subscribe - Subscribe to an event
• unsubscribe - Unsubscribe

Workspaces

• list - List workspaces

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• analyticsGetLinkEvents - Click events for a link
• analyticsGetSummary - Summary statistics
• authenticationTest - Validate API key
• conversionsList - List conversions
• domainsGet - Get a domain
• domainsList - List domains
• exportsExportLinksAsCsv - Export links as CSV
• exportsGetClicksCsv - Export clicks as CSV
• linksBulkCreate - Bulk create links
• linksCreate - Create a link
• linksDelete - Delete a link
• linksGet - Get a link
• linksHealthCheck - Health check
• linksList - List links
• linksUpdate - Update a link
• linksUpsert - Upsert a link
• listsCreate - Create a list
• listsDelete - Delete a list
• listsGet - Get a list
• listsGetAll - List all lists
• listsUpdate - Update a list
• qrCodesCreate - Create a QR code
• qrCodesDelete - Delete a QR code
• qrCodesGet - Get a QR code
• qrCodesList - List QR codes
• qrCodesUpdate - Update a QR code
• tagsCreate - Create a tag
• tagsDelete - Delete a tag
• tagsGet - Get a tag
• tagsList - List tags
• tagsUpdate - Update a tag
• trackingLead - Track a lead
• trackingTrackSale - Track a sale
• utmTemplatesCreate - Create a UTM template
• utmTemplatesDelete - Delete a UTM template
• utmTemplatesGet - Get a UTM template
• utmTemplatesList - List UTM templates
• utmTemplatesUpdate - Update a UTM template
• webhooksSubscribe - Subscribe to an event
• webhooksUnsubscribe - Unsubscribe
• workspacesList - List workspaces

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Linkkit } from "linkkit";

const linkkit = new Linkkit({
  security: {
    bearerAuth: process.env["LINKKIT_BEARER_AUTH"] ?? "",
  },
});

async function run() {
  const result = await linkkit.links.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Linkkit } from "linkkit";

const linkkit = new Linkkit();

async function run() {
  const result = await linkkit.links.healthCheck({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Linkkit } from "linkkit";

const linkkit = new Linkkit({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await linkkit.links.healthCheck();

  console.log(result);
}

run();

Error Handling

LinkkitError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Linkkit } from "linkkit";
import * as errors from "linkkit/models/errors";

const linkkit = new Linkkit({
  security: {
    bearerAuth: process.env["LINKKIT_BEARER_AUTH"] ?? "",
  },
});

async function run() {
  try {
    const result = await linkkit.links.list({});

    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.LinkkitError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorT) {
        console.log(error.data$.error); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

• LinkkitError: The base class for HTTP error responses.
  • ErrorT: *

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from LinkkitError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Linkkit } from "linkkit";

const linkkit = new Linkkit({
  serverURL: "https://api.uselinkkit.com",
});

async function run() {
  const result = await linkkit.links.healthCheck();

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { Linkkit } from "linkkit";
import { ProxyAgent } from "undici";
import { HTTPClient } from "linkkit/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Linkkit({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Linkkit } from "linkkit";

const sdk = new Linkkit({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable LINKKIT_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy