Skip to main content
POST
/
v1
/
enroute
/
register
Register a route
curl --request POST \
  --url https://api.iklim.co/v1/enroute/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "origin": {
    "lng": 32.857358,
    "lat": 39.93504
  },
  "destination": {
    "lng": 32.857358,
    "lat": 39.93504
  },
  "departureTime": "2023-11-07T05:31:56Z",
  "distanceMeters": 123,
  "durationSeconds": 123,
  "geometry": {
    "encodedPolyline": "<string>",
    "polylinePrecision": 123,
    "coordinates": [
      {
        "lng": 32.857358,
        "lat": 39.93504
      }
    ]
  },
  "waypoints": [
    {
      "lng": 32.857358,
      "lat": 39.93504
    }
  ]
}
'
{
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expirationTime": "2023-11-07T05:31:56Z",
  "distanceUnit": "<string>",
  "status": {
    "progressPercentage": 123,
    "distanceTraveled": 123,
    "remainingDistance": 123,
    "timeElapsedSeconds": 123,
    "estimatedTimeRemainingSeconds": 123,
    "scheduleDeviationSeconds": 123,
    "expectedSegmentIndex": 123,
    "estimatedArrivalTime": "2023-11-07T05:31:56Z"
  },
  "currentSegment": {
    "index": 123,
    "h3Address": "<string>",
    "eta": "2023-11-07T05:31:56Z",
    "etd": "2023-11-07T05:31:56Z",
    "distanceToEntry": 123,
    "distanceToExit": 123,
    "arrivalPoint": {
      "lng": 32.857358,
      "lat": 39.93504
    },
    "departurePoint": {
      "lng": 32.857358,
      "lat": 39.93504
    },
    "weatherEvents": {
      "temperature": 123,
      "apparentTemperature": 123,
      "humidity": 123,
      "cloudCover": 123,
      "windSpeed": 123,
      "windGust": 123,
      "windDirection": 123,
      "snowFall": 123,
      "precipitation": 123,
      "precipitationProbability": 123,
      "visibility": 123,
      "lightningSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "totalEventCount": 123,
        "cgFlashCount": 123,
        "icPulseCount": 123,
        "lastEventAgeSec": 123,
        "lastFlashAgeSec": 123,
        "lastPulseAgeSec": 123,
        "nearestEventDistance": 123,
        "nearestFlashDistance": 123,
        "nearestPulseDistance": 123,
        "maxPeakCurrent": 123,
        "avgPeakCurrent": 123,
        "avgSensorCount": 123,
        "confidenceScore": 123,
        "confidenceLevel": "LOW",
        "riskIndex": 123,
        "riskLevel": "NONE",
        "trend": "UNKNOWN"
      },
      "thunderstormSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "summary": {
          "stormCount": 123,
          "activeStorms": 123,
          "insideAnyThreatBoundary": true,
          "nearestThreatBoundaryDistance": 123,
          "nearestStormCentroidDistance": 123,
          "maxSeverity": "LOW",
          "lastEventAge": 123,
          "riskScore": 123,
          "riskLevel": "NONE",
          "trend": "RISING"
        },
        "activeStorms": [
          {
            "eventId": "<string>",
            "severity": "LOW",
            "eventStartUtcEpoch": 123,
            "eventEndUtcEpoch": 123,
            "eventAge": 123,
            "cell": {
              "area": 123,
              "speed": 123,
              "direction": 123,
              "centroidDistance": 123,
              "directionFromDriver": "N",
              "bearingFromDriver": 123
            },
            "flashRates": {
              "inCloud": 123,
              "cloudToGround": 123,
              "total": 123,
              "cloudToGroundRatio": 123
            },
            "threat": {
              "insideThreatPolygon": true,
              "distanceToThreatBoundary": 123,
              "directionFromDriver": "N",
              "bearingFromDriver": 123,
              "approachState": "APPROACHING"
            },
            "score": {
              "stormRiskScore": 123,
              "stormRiskLevel": "NONE"
            }
          }
        ]
      },
      "precipitationSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "currentIntensity": "DRIZZLE",
        "isPrecipitating": true,
        "radarTimeStamp": 123,
        "dataAgeSec": 123,
        "radarSnapshotCount": 123,
        "maxIntensity": "DRIZZLE",
        "trend": "INCREASING",
        "riskLevel": "NONE",
        "forecastMaxIntensity": "DRIZZLE",
        "expectedEndSec": 123,
        "expectedStartSec": 123
      }
    }
  },
  "upcomingSegments": [
    {
      "index": 123,
      "h3Address": "<string>",
      "eta": "2023-11-07T05:31:56Z",
      "etd": "2023-11-07T05:31:56Z",
      "distanceToEntry": 123,
      "distanceToExit": 123,
      "arrivalPoint": {
        "lng": 32.857358,
        "lat": 39.93504
      },
      "departurePoint": {
        "lng": 32.857358,
        "lat": 39.93504
      },
      "weatherEvents": {
        "temperature": 123,
        "apparentTemperature": 123,
        "humidity": 123,
        "cloudCover": 123,
        "windSpeed": 123,
        "windGust": 123,
        "windDirection": 123,
        "snowFall": 123,
        "precipitation": 123,
        "precipitationProbability": 123,
        "visibility": 123
      }
    }
  ]
}

Body

application/json
​
origin
object
required

Starting point of the route

​
destination
object
required

Destination point of the route

​
departureTime
string<date-time>
required

Planned departure time, expressed as Unix epoch milliseconds

​
distanceMeters
integer<int32>
required

Total route distance in meters

​
durationSeconds
integer<int32>
required

Expected total travel duration in seconds

​
geometry
object
required

Route geometry, provided as an encoded polyline or a list of coordinates

​
waypoints
object[]

Optional list of user-defined intermediate stops (e.g. fuel stops, rest areas); these are semantic waypoints, not dense road path coordinates

Response

Route registered successfully

​
routeId
string<uuid>

Unique identifier assigned to the registered route

​
expirationTime
string<date-time>

Expiration time of the route registration, expressed as Unix epoch milliseconds

​
distanceUnit
string

Unit used for distance values in this response

​
status
object

Current location and progress status of the driver along the route

​
currentSegment
object

The route segment the driver is currently in

​
upcomingSegments
object[]

List of upcoming route segments ahead of the driver