TypeScript SDK#

The @brandwave/ts package is a fully-typed TypeScript client for the Brandwave API. It provides zero-dependency access to creator marketing data with automatic case conversion, pagination, and error handling.

Installation#

bash
npm install @brandwave/ts

Quick setup#

typescript
import { createBrandwave } from '@brandwave/ts';

const bw = createBrandwave({
  accessToken: process.env.BRANDWAVE_ACCESS_TOKEN,
});

Authentication

The SDK currently uses access tokens from your dashboard. Organization API keys for server-side and agent authentication are planned for a future release.

Available resources#

The SDK organises endpoints into resources. Each resource supports standard CRUD operations plus specialised queries.

  • bw.activities — Creator content and campaign activities
  • bw.campaigns — Marketing campaigns
  • bw.creators — Influencer and creator profiles
  • bw.organizations — Workspace management
  • bw.users — User accounts and settings

Type exports

All types are exported directly from @brandwave/ts. Import them with import type { Activity } from '@brandwave/ts'.

Explore resources#