OpenAPI Specification

The Fanbeam API is fully documented using the OpenAPI 3.0 specification. You can use this specification to generate client libraries, explore the API, or integrate with API tools.

Accessing the Specification

The OpenAPI specification is available at:

https://fanbeam.app/api/openapi.json

Using the Specification

Interactive Documentation

You can use tools like Swagger UI or Scalar to explore the API interactively:

1. Download the OpenAPI spec from /api/openapi.json
2. Import it into Swagger UI, Postman, or your preferred API tool
3. Explore endpoints, schemas, and examples

Code Generation

Generate client libraries for your preferred language:

TypeScript/JavaScript:

npx @hey-api/openapi-ts -i https://fanbeam.app/api/openapi.json -o ./src/client

Python:

openapi-generator generate -i https://fanbeam.app/api/openapi.json -g python -o ./python-client

Go:

openapi-generator generate -i https://fanbeam.app/api/openapi.json -g go -o ./go-client

Postman Collection

Import the OpenAPI spec into Postman:

1. Open Postman
2. Click Import
3. Select Link and enter: https://fanbeam.app/api/openapi.json
4. Postman will create a collection with all endpoints

Specification Details

The OpenAPI spec includes:

• All endpoints - Complete list of available API endpoints
• Request/Response schemas - Detailed schemas for all requests and responses
• Authentication - API key authentication details
• Examples - Request and response examples
• Error responses - Error schema documentation

SDK Generation

The official Fanbeam TypeScript SDK is generated from this OpenAPI specification:

npm install fanbeam

View SDK Documentation →

Next Steps

• API Endpoints
• Authentication
• SDK Documentation