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({
  apiKey: process.env.BRANDWAVE_API_KEY,
});

Authentication

Use API keys for server-side integrations, automation, and AI tools. Browser apps can pass the signed-in user's access token when they need to call Brandwave on behalf of that user.

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#