Get route weather - iklim.co API Documentation

Get route weather

curl --request POST \
  --url https://api.iklim.co/v1/enroute/weather \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.iklim.co/v1/enroute/weather"

payload = { "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({routeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.iklim.co/v1/enroute/weather', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.iklim.co/v1/enroute/weather",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'routeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.iklim.co/v1/enroute/weather"

	payload := strings.NewReader("{\n  \"routeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.iklim.co/v1/enroute/weather")
  .header("Content-Type", "application/json")
  .body("{\n  \"routeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.iklim.co/v1/enroute/weather")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"routeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "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,
        "riskIndex": 123
      },
      "thunderstormSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "summary": {
          "stormCount": 123,
          "activeStorms": 123,
          "insideAnyThreatBoundary": true,
          "nearestThreatBoundaryDistance": 123,
          "nearestStormCentroidDistance": 123,
          "lastEventAge": 123,
          "riskScore": 123
        },
        "activeStorms": [
          {
            "eventId": "<string>",
            "eventStartUtcEpoch": 123,
            "eventEndUtcEpoch": 123,
            "eventAge": 123,
            "cell": {
              "area": 123,
              "speed": 123,
              "direction": 123,
              "centroidDistance": 123,
              "bearingFromDriver": 123
            },
            "flashRates": {
              "inCloud": 123,
              "cloudToGround": 123,
              "total": 123,
              "cloudToGroundRatio": 123
            },
            "threat": {
              "insideThreatPolygon": true,
              "distanceToThreatBoundary": 123,
              "bearingFromDriver": 123
            },
            "score": {
              "stormRiskScore": 123
            }
          }
        ]
      },
      "precipitationSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "isPrecipitating": true,
        "radarTimeStamp": 123,
        "dataAgeSec": 123,
        "radarSnapshotCount": 123,
        "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
      }
    }
  ],
  "segmentsRecalculated": true,
  "warning": "<string>"
}

POST

enroute

weather

Get route weather

curl --request POST \
  --url https://api.iklim.co/v1/enroute/weather \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.iklim.co/v1/enroute/weather"

payload = { "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({routeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.iklim.co/v1/enroute/weather', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.iklim.co/v1/enroute/weather",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'routeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.iklim.co/v1/enroute/weather"

	payload := strings.NewReader("{\n  \"routeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.iklim.co/v1/enroute/weather")
  .header("Content-Type", "application/json")
  .body("{\n  \"routeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.iklim.co/v1/enroute/weather")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"routeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "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,
        "riskIndex": 123
      },
      "thunderstormSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "summary": {
          "stormCount": 123,
          "activeStorms": 123,
          "insideAnyThreatBoundary": true,
          "nearestThreatBoundaryDistance": 123,
          "nearestStormCentroidDistance": 123,
          "lastEventAge": 123,
          "riskScore": 123
        },
        "activeStorms": [
          {
            "eventId": "<string>",
            "eventStartUtcEpoch": 123,
            "eventEndUtcEpoch": 123,
            "eventAge": 123,
            "cell": {
              "area": 123,
              "speed": 123,
              "direction": 123,
              "centroidDistance": 123,
              "bearingFromDriver": 123
            },
            "flashRates": {
              "inCloud": 123,
              "cloudToGround": 123,
              "total": 123,
              "cloudToGroundRatio": 123
            },
            "threat": {
              "insideThreatPolygon": true,
              "distanceToThreatBoundary": 123,
              "bearingFromDriver": 123
            },
            "score": {
              "stormRiskScore": 123
            }
          }
        ]
      },
      "precipitationSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "isPrecipitating": true,
        "radarTimeStamp": 123,
        "dataAgeSec": 123,
        "radarSnapshotCount": 123,
        "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
      }
    }
  ],
  "segmentsRecalculated": true,
  "warning": "<string>"
}

Body

application/json

routeId

string<uuid>

Unique identifier of the registered route to fetch weather for

currentLocation

object

Driver's current geographic location

Show child attributes

Response

Route weather data returned 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

Show child attributes

currentSegment

object

The route segment the driver is currently in

Show child attributes

upcomingSegments

object[]

List of upcoming route segments ahead of the driver

Show child attributes

segmentsRecalculated

boolean

Indicates whether route segments were recalculated because the driver is off schedule

warning

string

Warning message present when the driver is off schedule

Service Details Register a route