Skip to content
    • Pricing
    • Developers
    Back to Blog
    developer

    Introducing the Official Plung JavaScript and TypeScript SDK

    2026-03-27·3 min read·Plung Engineering

    On this page

    • Why an SDK
    • Getting Started
    • What You Can Do
    • Response Metadata
    • Error Handling
    • Start Building

    The official @plung/sdk npm package is now generally available. It is the fastest way to integrate Plung link management into any JavaScript or TypeScript application, giving teams a clean, production-ready path to create short links, generate QR codes, and retrieve analytics with a single SDK.

    Why an SDK

    The @plung/sdk package removes the friction of manual API integration. It provides typed responses, built-in error handling, and a streamlined client experience without requiring developers to wire HTTP requests by hand. It works in both Node.js and browser environments, making it suitable for modern application stacks across frontend and backend surfaces.

    Getting Started

    pnpm add @plung/sdk
    # or
    npm install @plung/sdk
    
    import { PlungClient } from "@plung/sdk"
    
    const client = new PlungClient("your_api_key_here")
    
    const { data } = await client.links.create({
      url: "https://example.com",
    })
    
    console.log(data.shortUrl)
    

    What You Can Do

    • Create and manage short links with optional aliases, expiration, and click limits
    • Generate QR codes for any short link in PNG or SVG format
    • Retrieve click analytics for any link

    Response Metadata

    Every SDK response includes a meta object that surfaces operational context alongside the primary result. That includes current rate limit status, plan information, and usage counters, making it easier to build integrations that stay aware of quota consumption and adapt gracefully as traffic grows.

    Error Handling

    The SDK surfaces typed error classes so developers can respond to authentication failures, rate limit events, and validation errors with precision. This makes it straightforward to build resilient application flows without relying on fragile string matching or custom response parsing.

    Start Building

    The official @plung/sdk package is available now. Install it from npm, review the developer documentation, and start building with the fastest path to Plung in JavaScript and TypeScript.

    Share:

    Share Article

    Written by

    Plung Engineering

    ← PreviousPlung API Notice: Authorization Bearer Tokens Are Now Required for Current API Authentication

    On this page

    • Why an SDK
    • Getting Started
    • What You Can Do
    • Response Metadata
    • Error Handling
    • Start Building

    Related Articles

    P
    announcement

    Plung API Notice: Authorization Bearer Tokens Are Now Required for Current API Authentication

    Current authenticated Plung API requests must send API keys in the Authorization header using the Bearer scheme. This notice explains the change, the impact, and the required migration steps.

    2026-03-21·4 min read
    I
    announcement

    Introducing Plung API v2: Authenticated Endpoints and API Keys

    API keys, per-key rate limiting, and v2 endpoints for shorten, batch, QR, and stats are now available. Here's what changed and how to migrate.

    2026-03-02·6 min read
    v
    announcement

    v1.2 API Update: QR Code Generation Endpoint

    We are expanding the Plung Growth Tools suite with our new programmatic QR Code generation endpoint. You can now generate scannable, cached QR codes for your short links instantly.

    2026-03-01·2 min read

    Product

    • About Us
    • Blog
    • Developers

    Features

    • URL Shortening
    • Custom Aliases
    • QR Codes
    • Password Protection
    • Link Analytics
    • Link Expiration

    Legal

    • Privacy Policy
    • Cookies Policy
    • Terms of Service
    • Acceptable Use Policy

    Support

    • Contact Us
    • Report Abuse

    © 2026 Plung

    All Rights Reserved