Fanbeam
Fanbeam
Documentation
API Reference
Getting Started
User Guides
TypeScript SDK
AuthenticationError HandlingInstallationQuick StartTypeScript Types

TypeScript SDK

Type-safe SDK for the Fanbeam API

The Fanbeam SDK provides a type-safe client for interacting with the Fanbeam API. It's automatically generated from the OpenAPI specification and includes full TypeScript type safety.

Features

  • Type-Safe - Full TypeScript types generated from OpenAPI schemas
  • Service Classes - Organized endpoints into intuitive service classes
  • Platform Neutral - Works in Node.js, browsers, and edge runtimes
  • Auto-Generated - Always in sync with the latest API changes

Quick Start

import { posts, client } from 'fanbeam';

// Configure the client
client.setConfig({
  baseUrl: 'https://fanbeam.app/api',
  headers: {
    'X-API-Key': 'your-api-key'
  }
});

// Use service classes
const response = await posts.list();

Installation

Install the SDK →

Quick Start Guide

Get started in 5 minutes →

API Services

  • Posts - Create, update, schedule, and manage posts
  • Media - Upload and manage media files
  • Channels - List and manage connected channels

Examples

  • Posts Examples
  • Media Examples
  • Channels Examples

Documentation

  • Installation
  • Authentication
  • TypeScript Types
  • Error Handling

Troubleshooting

Common issues and solutions

Authentication

Authenticate SDK requests with API keys

On this page

FeaturesQuick StartInstallationQuick Start GuideAPI ServicesExamplesDocumentation