API Reference

The Fanbeam API provides a RESTful interface for managing posts, media, channels, and analytics. All API requests require authentication via API keys.

Base URL

Production: https://fanbeam.app/api
Development: https://development.fanbeam.app/api
Local: http://local.fanbeam.app:3000/api

Authentication

All API requests require authentication using an API key in the X-API-Key header:

curl -H "X-API-Key: your-api-key" https://fanbeam.app/api/posts

Learn more about authentication →

OpenAPI Specification

The complete API specification is available in OpenAPI 3.0 format:

• OpenAPI Spec: /api/openapi.json
• Interactive Docs: Use the OpenAPI spec with tools like Swagger UI or Postman

View OpenAPI Spec →

Endpoints

Posts

Manage your social media posts:

• GET /posts - List posts
• GET /posts/:id - Get post details
• POST /posts - Create a new post
• PUT /posts/:id - Update a post
• DELETE /posts/:id - Delete a post

View all endpoints →

Media

Upload and manage media files:

• POST /media/upload/initialize - Initialize upload
• POST /media/upload/file - Upload file chunk
• POST /media/upload/finalize - Finalize upload
• GET /media/:id - Get media metadata
• DELETE /media/:id - Delete media

Channels

Manage connected social media channels:

• GET /channels - List channels
• GET /channels/:id - Get channel details
• DELETE /channels/:id - Disconnect channel

Rate Limits

API requests are rate-limited to ensure fair usage:

• Standard: 100 requests per minute per API key
• Burst: Up to 200 requests in a short burst

Learn more about rate limits →

Webhooks

Receive real-time notifications about events:

• Post published
• Post failed
• Channel disconnected
• Analytics updated

Set up webhooks →

SDK

For TypeScript/JavaScript applications, use our official SDK:

npm install fanbeam

SDK Documentation →