OffgridOS API Documentation

Integrate Offgrid systems into your applications.

Overview

The OffgridOS API provides programmatic access to:

• System status and metrics
• Historical data
• Control commands
• Alert management
• User administration

Authentication

All API requests require authentication via API key:

Authorization: Bearer YOUR_API_KEY

Generate API keys in your OffgridOS dashboard under Settings > API.

Base URL

https://api.offgridos.com/v1

Endpoints

System Status

GET /systems/{system_id}/status

Returns current status of all connected devices.

Metrics

GET /systems/{system_id}/metrics

Query parameters: start_date, end_date, resolution

Control

POST /systems/{system_id}/control

Body: { "command": "set_mode", "value": "off-grid" }

Alerts

GET /systems/{system_id}/alerts
POST /systems/{system_id}/alerts/{alert_id}/acknowledge

Rate Limits

| Plan | Requests/minute | |------|----------------| | Basic | 60 | | Pro | 300 | | Enterprise | Custom |

Webhooks

Configure webhooks to receive real-time notifications:

• System alerts
• Status changes
• Maintenance events
• Threshold breaches

SDKs

Official SDKs available for:

• JavaScript/TypeScript
• Python
• Go

View Full API Reference