Skip to main content
BitlyDeveloper
Start Now

Bitly API npm Package

The @bitly/api-client package is a generated TypeScript client for the Bitly API. It provides typed classes for each API resource so you can interact with Bitly without writing raw HTTP requests.

Installation

npm install @bitly/api-client

Authentication

All API classes accept an accessToken. Generate one in your Bitly API settings.

Usage

import { BitlinksApi } from '@bitly/api-client';

const bitlinksApi = new BitlinksApi({ accessToken: 'BITLY_ACCESS_TOKEN' });

const link = await bitlinksApi.createBitlink({
  shorten: {
    long_url: 'https://your-long-url.com/',
    domain: 'bit.ly',
    // group_guid: 'GROUP_GUID',
  },
});

console.log(link.link); // https://bit.ly/xxxxx

Create a QR code

import { QRCodesApi } from '@bitly/api-client';

const qrcodesApi = new QRCodesApi({ accessToken: 'BITLY_ACCESS_TOKEN' });

const qr = await qrcodesApi.createQRCodePublic({
  public_create_qr_code_request: {
    group_guid: 'GROUP_GUID',
    destination: {
      long_url: 'https://your-long-url.com/',
    },
  },
});

const qrImg = await qrcodesApi.getQRCodeImagePublic({
  qrcode_id: qr.id,
  accept: 'image/png',
});

Resources