Skip to main content

Beacon Tower API

Welcome to the Beacon Tower API documentation. Our API provides programmatic access to all platform features.

Authentication​

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

curl -H "X-API-Key: your_api_key_here" \
     https://api.beacontower.ai/v1/devices

Getting an API Key​

  1. Log in to your Beacon Tower account
  2. Navigate to Settings → API Keys
  3. Click "Create New API Key"
  4. Copy and securely store your API key

Base URL​

All API endpoints are relative to:

https://api.beacontower.ai/v1

Rate Limiting​

API requests are limited to:

  • 1,000 requests per hour for standard accounts
  • 10,000 requests per hour for enterprise accounts

Rate limit headers are included in every response:

  • X-RateLimit-Limit: Maximum requests per hour
  • X-RateLimit-Remaining: Remaining requests
  • X-RateLimit-Reset: Unix timestamp when limit resets

Response Format​

All responses are in JSON format. Successful requests return a 2xx status code. Errors return appropriate 4xx or 5xx codes with details:

{
  "error": "NotFound",
  "message": "Device not found",
  "details": {
    "deviceId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

API Reference​

View the complete API Reference for detailed endpoint documentation.

Support​

Need help? Contact us: