Outage Detection System API¶

Welcome to the Outage Detection System (ODS) API documentation. This system provides real-time monitoring of power outages and network incidents across multiple data sources.

Overview¶

The ODS API aggregates data from multiple sources to provide comprehensive visibility into:

Power Outages - From ODIN, Cal OES, and weather-related events
Network Incidents - From Cloudflare Radar, BGP/RIPE RIS, and Kentik
Reachability Status - Active probing of network endpoints

Quick Links¶

Getting Started - Set up and start using the API
API Reference - Complete endpoint documentation
Data Sources - Learn about our data sources
Schemas - Data type definitions

Base URL¶

https://ods-api.m-8b1.workers.dev

Authentication¶

Currently, the API is open for read access. No authentication is required for GET endpoints.

Rate Limits¶

The API is served via Cloudflare Workers with generous rate limits. For high-volume usage, please contact us.

Example Request¶

curl https://ods-api.m-8b1.workers.dev/incidents

Response Format¶

All responses are JSON with the following structure:

{
  "items": [
    {
      "id": "odin-pge-1234",
      "kind": "power",
      "status": "ongoing",
      "startedAt": "2025-01-15T10:30:00Z",
      "confidence": 0.75,
      "region": "Alameda, CA",
      "source": "odin"
    }
  ]
}

Support¶

For issues or feature requests, please open an issue on our GitHub repository.