> ## 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. # Register a route > Registers a new route with departure time and duration. Returns weather and location status for the current and upcoming segments. ## OpenAPI ````yaml /open-api/en/enroute_version-1.json post /v1/enroute/register openapi: 3.1.0 info: title: OpenAPI definition version: v0 servers: - url: https://api.iklim.co description: Production server - url: https://api-test.iklim.co description: Test server security: [] tags: - name: Enroute description: Weather-aware route planning API for drivers paths: /v1/enroute/register: post: tags: - Enroute summary: Register a route description: >- Registers a new route with departure time and duration. Returns weather and location status for the current and upcoming segments. operationId: registerRoute requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterRouteRequest' required: true responses: '200': description: Route registered successfully content: application/json: schema: $ref: '#/components/schemas/RouteRegistrationResponse' '400': description: Invalid route geometry provided content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' examples: Invalid route geometry provided: summary: Example response description: Invalid route geometry provided value: timestamp: '2025-04-14T16:58:10.414972912' status: 400 error: Invalid Route message: >- Either 'encodedPolyline' or 'coordinates with precision' must be provided. path: /enroute/register '401': description: Unauthorized content: '*/*': schema: $ref: '#/components/schemas/StandardErrorResponse' '402': description: Paid Subscription Required content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' examples: Payment Required: summary: Example response description: Payment Required value: timestamp: '2025-06-25T11:15:41.429518242' status: 402 error: Payment Required message: You Need To Renew Your Subscription or Purchase New One path: /v1/thunderstorms/page '403': description: Forbidden/Not Allowed content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' examples: No Subscription Found For This Service Endpoint: summary: Missing Subscription description: No Subscription Found For This Service Endpoint value: timestamp: '2025-06-25T11:21:50.510755746' status: 403 error: Forbidden message: No Subscription Found For This Service Endpoint path: /v1/thunderstorms/page This Location Is Not In Allowed Geographic Boundaries: summary: Out of Allowed Geographic Boundaries description: This Location Is Not In Allowed Geographic Boundaries value: timestamp: '2025-06-25T15:59:19.452326857' status: 403 error: Forbidden message: >- The Location You Are Querying [dd.ddddd, dd.ddddd] Is Not Within The Geographic Boundaries Allowed In Your Subscription [Country, Region] path: /v1/thunderstorms/page '409': description: Conflict content: '*/*': schema: $ref: '#/components/schemas/StandardErrorResponse' '429': description: Subscription Limits For This Service is Exceeded content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' examples: Too Many Requests: summary: Example response description: Too Many Requests value: timestamp: '2025-06-25T11:02:12.653874655' status: 429 error: Too Many Requests message: Your Subscription Limits For This Service is Exceeded path: /v1/thunderstorms/page '500': description: Internal Server Error During Request content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' examples: Internal Server Error Example: summary: Example response description: Internal Server Error Example value: timestamp: '2025-04-14T16:58:10.414972912' status: 500 error: Internal Server Error message: An Error Occurred During Invocation path: /endpoint/uri/here components: schemas: RegisterRouteRequest: type: object properties: origin: $ref: '#/components/schemas/GeoPoint' description: Starting point of the route destination: $ref: '#/components/schemas/GeoPoint' description: Destination point of the route departureTime: type: string format: date-time description: Planned departure time, expressed as Unix epoch milliseconds distanceMeters: type: integer format: int32 description: Total route distance in meters durationSeconds: type: integer format: int32 description: Expected total travel duration in seconds geometry: $ref: '#/components/schemas/RouteGeometry' description: >- Route geometry, provided as an encoded polyline or a list of coordinates waypoints: type: array description: >- Optional list of user-defined intermediate stops (e.g. fuel stops, rest areas); these are semantic waypoints, not dense road path coordinates items: $ref: '#/components/schemas/GeoPoint' required: - departureTime - destination - distanceMeters - durationSeconds - geometry - origin RouteRegistrationResponse: type: object properties: routeId: type: string format: uuid description: Unique identifier assigned to the registered route expirationTime: type: string format: date-time description: >- Expiration time of the route registration, expressed as Unix epoch milliseconds distanceUnit: type: string description: Unit used for distance values in this response status: $ref: '#/components/schemas/LocationStatus' description: Current location and progress status of the driver along the route currentSegment: $ref: '#/components/schemas/NowcastRouteSegment' description: The route segment the driver is currently in upcomingSegments: type: array description: List of upcoming route segments ahead of the driver items: $ref: '#/components/schemas/ForecastRouteSegment' StandardErrorResponse: type: object description: Standard API error response structure properties: timestamp: type: string format: date-time description: Timestamp when the error occurred example: YYYY-mm-DDTHH:MM:SS.nnnnnnnnn status: type: integer format: int32 description: HTTP status code example: XXX error: type: string description: Error name or type example: Error Name minLength: 1 message: type: string description: Main error message example: Error Message minLength: 1 messages: type: array description: Additional detailed error messages items: type: string path: type: string description: Request path that caused the error example: /endpoint/uri/here minLength: 1 required: - error - message - path - status - timestamp GeoPoint: type: object properties: lng: type: number format: double description: Longitude coordinate. example: 32.857358 maximum: 180 minimum: -180 lat: type: number format: double description: Latitude coordinate. example: 39.93504 maximum: 90 minimum: -90 required: - lat - lng RouteGeometry: type: object properties: encodedPolyline: type: string description: >- Google/Mapbox encoded polyline string representing the road path geometry polylinePrecision: type: integer format: int32 description: >- Precision factor used to decode the encoded polyline; default is 5, Mapbox high-precision is 6 coordinates: type: array description: >- Ordered list of geographic coordinates representing the road path; used as a fallback when an encoded polyline is not available items: $ref: '#/components/schemas/GeoPoint' LocationStatus: type: object properties: progressPercentage: type: number format: double description: Driver's progress along the route as a percentage (0-100) distanceTraveled: type: number format: double description: Total distance traveled by the driver since route registration remainingDistance: type: number format: double description: Remaining distance to the destination timeElapsedSeconds: type: integer format: int64 description: Time elapsed since route registration, in seconds estimatedTimeRemainingSeconds: type: integer format: int64 description: Estimated remaining time to reach the destination, in seconds scheduleDeviationSeconds: type: integer format: int64 description: >- Deviation from the planned schedule, in seconds; positive means ahead of schedule, negative means behind expectedSegmentIndex: type: integer format: int32 description: >- Zero-based index of the route segment the driver is expected to be in based on the original schedule estimatedArrivalTime: type: string format: date-time description: >- Estimated arrival time at the destination, expressed as Unix epoch seconds; capped at route expiration time if the projected arrival exceeds it NowcastRouteSegment: type: object properties: index: type: integer format: int32 description: Zero-based position of this segment in the route h3Address: type: string description: Uber H3 cell address (resolution 5) covering this segment eta: type: string format: date-time description: Estimated Time of Arrival at this segment etd: type: string format: date-time description: Estimated Time of Departure from this segment distanceToEntry: type: number format: double description: >- Distance from the driver's current position to the entry point of this segment distanceToExit: type: number format: double description: >- Distance from the driver's current position to the exit point of this segment arrivalPoint: $ref: '#/components/schemas/GeoPoint' description: >- Geographic coordinates belonging to the arrival point of this segment departurePoint: $ref: '#/components/schemas/GeoPoint' description: >- Geographic coordinates belonging to the departure point of this segment weatherEvents: $ref: '#/components/schemas/NowcastWeatherEvents' description: Weather events and conditions associated with this segment ForecastRouteSegment: type: object properties: index: type: integer format: int32 description: Zero-based position of this segment in the route h3Address: type: string description: Uber H3 cell address (resolution 5) covering this segment eta: type: string format: date-time description: Estimated Time of Arrival at this segment etd: type: string format: date-time description: Estimated Time of Departure from this segment distanceToEntry: type: number format: double description: >- Distance from the driver's current position to the entry point of this segment distanceToExit: type: number format: double description: >- Distance from the driver's current position to the exit point of this segment arrivalPoint: $ref: '#/components/schemas/GeoPoint' description: >- Geographic coordinates belonging to the arrival point of this segment departurePoint: $ref: '#/components/schemas/GeoPoint' description: >- Geographic coordinates belonging to the departure point of this segment weatherEvents: $ref: '#/components/schemas/ForecastWeatherEvents' description: Weather events and conditions associated with this segment NowcastWeatherEvents: type: object properties: temperature: type: number format: double description: Air temperature in degrees Celsius (degrees C) apparentTemperature: type: number format: double description: Apparent (feels-like) temperature in degrees Celsius (degrees C) humidity: type: number format: double description: Relative humidity as a percentage (%) cloudCover: type: number format: double description: Cloud cover as a percentage (%) windSpeed: type: number format: double description: Wind speed in kilometers per hour (km/h) windGust: type: number format: double description: Wind gust speed in kilometers per hour (km/h) windDirection: type: integer format: int32 description: Wind direction in degrees, measured clockwise from north snowFall: type: number format: double description: Snowfall amount in centimeters (cm) precipitation: type: number format: double description: Precipitation amount in millimeters (mm) precipitationProbability: type: number format: double description: >- Probability of precipitation as a percentage (%); available only for hourly forecast visibility: type: number format: double description: Visibility in meters (m); available only for hourly forecast lightningSummary: $ref: '#/components/schemas/LightningSummary' description: Lightning activity summary for this segment thunderstormSummary: $ref: '#/components/schemas/ThunderstormSummary' description: Thunderstorm activity summary for this segment precipitationSummary: $ref: '#/components/schemas/PrecipitationSummary' description: Precipitation activity summary for this segment ForecastWeatherEvents: type: object properties: temperature: type: number format: double description: Air temperature in degrees Celsius (degrees C) apparentTemperature: type: number format: double description: Apparent (feels-like) temperature in degrees Celsius (degrees C) humidity: type: number format: double description: Relative humidity as a percentage (%) cloudCover: type: number format: double description: Cloud cover as a percentage (%) windSpeed: type: number format: double description: Wind speed in kilometers per hour (km/h) windGust: type: number format: double description: Wind gust speed in kilometers per hour (km/h) windDirection: type: integer format: int32 description: Wind direction in degrees, measured clockwise from north snowFall: type: number format: double description: Snowfall amount in centimeters (cm) precipitation: type: number format: double description: Precipitation amount in millimeters (mm) precipitationProbability: type: number format: double description: >- Probability of precipitation as a percentage (%); available only for hourly forecast visibility: type: number format: double description: Visibility in meters (m); available only for hourly forecast LightningSummary: type: object properties: windowMinutes: type: integer format: int32 description: >- The total historical lookback window considered in the calculation, in minutes. bucketMinutes: type: integer format: int32 description: >- The duration of the sub-time window used for trend calculation, in minutes. totalEventCount: type: integer format: int32 description: >- The total number of lightning events evaluated within the defined time window relative to the driver's location. cgFlashCount: type: integer format: int32 description: >- The number of detected cloud-to-ground flash events within the defined time window. icPulseCount: type: integer format: int32 description: >- The number of detected in-cloud pulse events within the defined time window. lastEventAgeSec: type: integer format: int64 description: >- The elapsed time since the most recent detected lightning event, in seconds. lastFlashAgeSec: type: integer format: int64 description: >- The elapsed time since the most recent detected flash event, in seconds. lastPulseAgeSec: type: integer format: int64 description: >- The elapsed time since the most recent detected pulse event, in seconds. nearestEventDistance: type: number format: double description: >- The distance to the nearest lightning event, calculated relative to the driver's current location, in meters. nearestFlashDistance: type: number format: double description: >- The distance to the nearest flash event, calculated relative to the driver's current location, in meters. nearestPulseDistance: type: number format: double description: >- The distance to the nearest pulse event, calculated relative to the driver's current location, in meters. maxPeakCurrent: type: number format: double description: >- The highest absolute peak current value detected among the events within the defined time window, in amperes. avgPeakCurrent: type: number format: double description: >- The average absolute peak current value of the events within the defined time window, in amperes. avgSensorCount: type: number format: double description: >- The average number of sensors used to locate the events within the defined time window. confidenceScore: type: number format: double description: >- A confidence score normalized between 0 and 100 based on the number of sensors used for the events. confidenceLevel: type: string description: >- The classified confidence level derived from the confidence score. Possible values: LOW, MEDIUM, HIGH. enum: - LOW - MEDIUM - HIGH riskIndex: type: number format: double description: >- A normalized relative risk index calculated between 0 and 100 using factors such as event type, proximity to the driver, recency, peak current, sensor count, and multiplicity; it is not a probability percentage. riskLevel: type: string description: >- The classified risk level derived from the risk index. Possible values: NONE, LOW, MEDIUM, HIGH, EXTREME. enum: - NONE - LOW - MEDIUM - HIGH - EXTREME trend: type: string description: >- The trend information produced by comparing the risk index of the latest sub-time window with the previous sub-time window. Possible values: UNKNOWN, DECREASING, STABLE, INCREASING. enum: - UNKNOWN - DECREASING - STABLE - INCREASING ThunderstormSummary: type: object properties: windowMinutes: type: integer format: int32 description: >- The total historical lookback window considered in the calculation, in minutes. bucketMinutes: type: integer format: int32 description: >- The duration of the sub-time window used for trend calculation, in minutes. summary: $ref: '#/components/schemas/Summary' description: >- Aggregated summary of thunderstorm activity within the lookback window. activeStorms: type: array description: List of currently active thunderstorm events. items: $ref: '#/components/schemas/ActiveStorm' PrecipitationSummary: type: object properties: windowMinutes: type: integer format: int32 description: >- The total historical lookback window considered in the calculation, in minutes. bucketMinutes: type: integer format: int32 description: >- The duration of the sub-time window used for trend calculation, in minutes. currentIntensity: type: string description: Current precipitation intensity based on the latest nowcast record. enum: - DRIZZLE - LIGHT - MODERATE - HEAVY - VERY_HEAVY - EXTREME isPrecipitating: type: boolean description: >- Indicates whether precipitation is currently occurring based on the latest nowcast record. radarTimeStamp: type: integer format: int64 description: >- Timestamp of the radar data used for the current state, expressed as Unix epoch seconds. dataAgeSec: type: integer format: int64 description: Age of the radar data used for the current state, in seconds. radarSnapshotCount: type: integer format: int32 description: Number of radar snapshots used in the window summary calculation. maxIntensity: type: string description: Maximum precipitation intensity observed within the lookback window. enum: - DRIZZLE - LIGHT - MODERATE - HEAVY - VERY_HEAVY - EXTREME trend: type: string description: >- Precipitation intensity trend within the lookback window. Possible values: INCREASING, STABLE, DECREASING, UNKNOWN. enum: - INCREASING - STABLE - DECREASING - UNKNOWN riskLevel: type: string description: >- Risk level derived from the precipitation summary. Possible values: NONE, LOW, MEDIUM, HIGH, EXTREME. enum: - NONE - LOW - MEDIUM - HIGH - EXTREME forecastMaxIntensity: type: string description: >- Maximum forecasted precipitation intensity based on forecast records. enum: - DRIZZLE - LIGHT - MODERATE - HEAVY - VERY_HEAVY - EXTREME expectedEndSec: type: integer format: int64 description: >- Expected end time of the current precipitation event, expressed as Unix epoch seconds. expectedStartSec: type: integer format: int64 description: >- Expected start time of the next precipitation event, expressed as Unix epoch seconds. Summary: type: object properties: stormCount: type: integer format: int32 description: >- Total number of thunderstorm events detected within the lookback window. activeStorms: type: integer format: int32 description: Number of currently active thunderstorm events. insideAnyThreatBoundary: type: boolean description: >- Indicates whether the driver is currently inside any storm's threat boundary. nearestThreatBoundaryDistance: type: number format: double description: >- Distance from the driver's position to the nearest storm threat boundary, in meters. nearestStormCentroidDistance: type: number format: double description: >- Distance from the driver's position to the nearest storm centroid, in meters. maxSeverity: type: string description: >- Maximum severity level among all detected storms. Possible values: LOW, NORMAL, HIGH, UNKNOWN. enum: - LOW - NORMAL - HIGH - UNKNOWN lastEventAge: type: integer format: int64 description: Time elapsed since the most recent thunderstorm event, in seconds. riskScore: type: integer format: int32 description: >- Aggregated risk score for thunderstorm activity, normalized between 0 and 100. riskLevel: type: string description: >- Risk level derived from the risk score. Possible values: LOW, MEDIUM, HIGH, EXTREME, UNKNOWN. enum: - NONE - LOW - MEDIUM - HIGH - EXTREME - UNKNOWN trend: type: string description: >- Thunderstorm activity trend. Possible values: RISING, STABLE, FALLING, UNKNOWN. enum: - RISING - STABLE - FALLING - UNKNOWN ActiveStorm: type: object properties: eventId: type: string description: Unique identifier of the thunderstorm event. severity: type: string description: >- Severity level of this storm. Possible values: LOW, NORMAL, HIGH, UNKNOWN. enum: - LOW - NORMAL - HIGH - UNKNOWN eventStartUtcEpoch: type: integer format: int64 description: Start time of the storm event, expressed as Unix epoch seconds. eventEndUtcEpoch: type: integer format: int64 description: End time of the storm event, expressed as Unix epoch seconds. eventAge: type: integer format: int64 description: Time elapsed since the storm event started, in seconds. cell: $ref: '#/components/schemas/Cell' description: Physical characteristics of the storm cell. flashRates: $ref: '#/components/schemas/FlashRates' description: Flash rate statistics for this storm event. threat: $ref: '#/components/schemas/Threat' description: Threat proximity assessment relative to the driver's position. score: $ref: '#/components/schemas/Score' description: Risk score assessment for this storm event. Cell: type: object properties: area: type: number format: double description: Estimated area of the storm cell, in square kilometers (km2). speed: type: number format: double description: Movement speed of the storm cell, in kilometers per hour (km/h). direction: type: integer format: int32 description: >- Movement direction of the storm cell, in degrees measured clockwise from north. centroidDistance: type: number format: double description: >- Distance from the driver's position to the storm cell centroid, in meters. directionFromDriver: type: string description: >- Relative compass direction of the storm cell from the driver's position. enum: - 'N' - NNE - NE - ENE - E - ESE - SE - SSE - S - SSW - SW - WSW - W - WNW - NW - NNW - UNKNOWN bearingFromDriver: type: integer format: int32 description: Bearing from the driver's position to the storm cell, in degrees. FlashRates: type: object properties: inCloud: type: number format: double description: In-cloud lightning flash rate for this storm event. cloudToGround: type: number format: double description: Cloud-to-ground lightning flash rate for this storm event. total: type: number format: double description: >- Total lightning flash rate (in-cloud + cloud-to-ground) for this storm event. cloudToGroundRatio: type: number format: double description: >- Ratio of cloud-to-ground flashes to total flashes for this storm event. Threat: type: object properties: insideThreatPolygon: type: boolean description: >- Indicates whether the driver is currently inside this storm's threat polygon. distanceToThreatBoundary: type: number format: double description: >- Distance from the driver's position to the storm's threat boundary polygon, in meters. directionFromDriver: type: string description: >- Relative compass direction of the storm threat boundary from the driver's position. enum: - 'N' - NNE - NE - ENE - E - ESE - SE - SSE - S - SSW - SW - WSW - W - WNW - NW - NNW - UNKNOWN bearingFromDriver: type: integer format: int32 description: >- Bearing from the driver's position to the nearest point of the storm threat boundary, in degrees. approachState: type: string description: >- Whether the storm is approaching or moving away from the driver. Possible values: APPROACHING, MOVING_AWAY, STABLE, UNKNOWN. enum: - APPROACHING - MOVING_AWAY - STABLE - UNKNOWN Score: type: object properties: stormRiskScore: type: integer format: int32 description: Risk score for this individual storm, normalized between 0 and 100. stormRiskLevel: type: string description: >- Risk level derived from this storm's risk score. Possible values: LOW, MEDIUM, HIGH, EXTREME, UNKNOWN. enum: - NONE - LOW - MEDIUM - HIGH - EXTREME - UNKNOWN ````