Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api-docs.iklim.co/llms.txt

Use this file to discover all available pages before exploring further.

⛈️ Multi-minute awareness

Describes the full thunderstorm window (start, end, severity) so you can orchestrate escalations minutes in advance.

🌀 Polygon intelligence

Includes the exact exterior ring that intersects your registration, enabling map overlays out of the box.

📡 Lightning fused

Cell metrics expose flash rates, direction, and motion derived from real-time lightning telemetry.
{
  "thunderstormId": "692d5b2cf4142f722546d77a",
  "eventId": "EAF202512010907001",
  "registrationId": "e71fedf8-a0a9-462e-a972-47dc8a5586df",
  "recipientId": "recipient-04c2b9c7ad01",
  "eventStartUtc": 1764580080,
  "eventEndUtc": 1764582780,
  "severity": "LOW",
  "threshold": 3,
  "speedKmh": 38.892,
  "distance": 0,
  "affectedPolygon": {
    "exterior": [
      { "lng": 28.943784, "lat": 40.979168 },
      { "lng": 28.943784, "lat": 41.051032 },
      { "lng": 29.015216, "lat": 41.051032 },
      { "lng": 29.015216, "lat": 40.979168 },
      { "lng": 28.943784, "lat": 40.979168 }
    ],
    "holes": []
  },
  "cell": {
    "area": 8.999704133858742,
    "speedKmh": 33.293898860271185,
    "direction": 255,
    "distance": null,
    "centroid": {
      "lng": 28.9795,
      "lat": 41.0151
    },
    "polygon": {
      "exterior": [
        { "lng": 28.961642, "lat": 41.0151 },
        { "lng": 28.970571, "lat": 41.033066 },
        { "lng": 28.988429, "lat": 41.033066 },
        { "lng": 28.997358, "lat": 41.0151 },
        { "lng": 28.988429, "lat": 40.997134 },
        { "lng": 28.970571, "lat": 40.997134 },
        { "lng": 28.961642, "lat": 41.0151 }
      ],
      "holes": []
    },
    "flashRates": {
      "inCloud": 4.33,
      "cloudToGround": 0.34,
      "total": 4.67
    }
  }
}
1

Decode the time window 🕒

Convert eventStartUtc/eventEndUtc to your user’s timezone and show a friendly countdown in customer apps.
2

Render polygons on the map 🗺️

Overlay affectedPolygon + cell.polygon on your GIS layer to highlight precisely where the danger lies.
3

Automate escalations 🚨

When severity ≥ MEDIUM and distance ≤ 5 km, automatically notify high-value customers or halt risky operations.