Within Operation

Within Operation

curl --request POST \
  --url https://api.iklim.co/v1/precipitations/within \
  --header 'Content-Type: application/json' \
  --data '
{
  "center": {
    "lng": 32.857358,
    "lat": 39.93504
  },
  "radius": 1000,
  "backwardInterval": 3600,
  "endTimeEpoch": 1646374400000,
  "pageNumber": 0,
  "pageSize": 10,
  "intensityThreshold": "MODERATE"
}
'

import requests

url = "https://api.iklim.co/v1/precipitations/within"

payload = {
    "center": {
        "lng": 32.857358,
        "lat": 39.93504
    },
    "radius": 1000,
    "backwardInterval": 3600,
    "endTimeEpoch": 1646374400000,
    "pageNumber": 0,
    "pageSize": 10,
    "intensityThreshold": "MODERATE"
}
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({
    center: {lng: 32.857358, lat: 39.93504},
    radius: 1000,
    backwardInterval: 3600,
    endTimeEpoch: 1646374400000,
    pageNumber: 0,
    pageSize: 10,
    intensityThreshold: 'MODERATE'
  })
};

fetch('https://api.iklim.co/v1/precipitations/within', 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/precipitations/within",
  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([
    'center' => [
        'lng' => 32.857358,
        'lat' => 39.93504
    ],
    'radius' => 1000,
    'backwardInterval' => 3600,
    'endTimeEpoch' => 1646374400000,
    'pageNumber' => 0,
    'pageSize' => 10,
    'intensityThreshold' => 'MODERATE'
  ]),
  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/precipitations/within"

	payload := strings.NewReader("{\n  \"center\": {\n    \"lng\": 32.857358,\n    \"lat\": 39.93504\n  },\n  \"radius\": 1000,\n  \"backwardInterval\": 3600,\n  \"endTimeEpoch\": 1646374400000,\n  \"pageNumber\": 0,\n  \"pageSize\": 10,\n  \"intensityThreshold\": \"MODERATE\"\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/precipitations/within")
  .header("Content-Type", "application/json")
  .body("{\n  \"center\": {\n    \"lng\": 32.857358,\n    \"lat\": 39.93504\n  },\n  \"radius\": 1000,\n  \"backwardInterval\": 3600,\n  \"endTimeEpoch\": 1646374400000,\n  \"pageNumber\": 0,\n  \"pageSize\": 10,\n  \"intensityThreshold\": \"MODERATE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.iklim.co/v1/precipitations/within")

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  \"center\": {\n    \"lng\": 32.857358,\n    \"lat\": 39.93504\n  },\n  \"radius\": 1000,\n  \"backwardInterval\": 3600,\n  \"endTimeEpoch\": 1646374400000,\n  \"pageNumber\": 0,\n  \"pageSize\": 10,\n  \"intensityThreshold\": \"MODERATE\"\n}"

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

{
  "precipitations": [
    {
      "eventId": "6932e0b4d4a02eb8afdf2951",
      "radarTimeStamp": 1646374400000,
      "forecast": false,
      "intensity": "MODERATE"
    }
  ],
  "queryTimestamp": 123,
  "totalRecords": 123,
  "pageNumber": 0,
  "pageSize": 10
}

POST

precipitations

within

Within Operation

curl --request POST \
  --url https://api.iklim.co/v1/precipitations/within \
  --header 'Content-Type: application/json' \
  --data '
{
  "center": {
    "lng": 32.857358,
    "lat": 39.93504
  },
  "radius": 1000,
  "backwardInterval": 3600,
  "endTimeEpoch": 1646374400000,
  "pageNumber": 0,
  "pageSize": 10,
  "intensityThreshold": "MODERATE"
}
'

import requests

url = "https://api.iklim.co/v1/precipitations/within"

payload = {
    "center": {
        "lng": 32.857358,
        "lat": 39.93504
    },
    "radius": 1000,
    "backwardInterval": 3600,
    "endTimeEpoch": 1646374400000,
    "pageNumber": 0,
    "pageSize": 10,
    "intensityThreshold": "MODERATE"
}
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({
    center: {lng: 32.857358, lat: 39.93504},
    radius: 1000,
    backwardInterval: 3600,
    endTimeEpoch: 1646374400000,
    pageNumber: 0,
    pageSize: 10,
    intensityThreshold: 'MODERATE'
  })
};

fetch('https://api.iklim.co/v1/precipitations/within', 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/precipitations/within",
  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([
    'center' => [
        'lng' => 32.857358,
        'lat' => 39.93504
    ],
    'radius' => 1000,
    'backwardInterval' => 3600,
    'endTimeEpoch' => 1646374400000,
    'pageNumber' => 0,
    'pageSize' => 10,
    'intensityThreshold' => 'MODERATE'
  ]),
  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/precipitations/within"

	payload := strings.NewReader("{\n  \"center\": {\n    \"lng\": 32.857358,\n    \"lat\": 39.93504\n  },\n  \"radius\": 1000,\n  \"backwardInterval\": 3600,\n  \"endTimeEpoch\": 1646374400000,\n  \"pageNumber\": 0,\n  \"pageSize\": 10,\n  \"intensityThreshold\": \"MODERATE\"\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/precipitations/within")
  .header("Content-Type", "application/json")
  .body("{\n  \"center\": {\n    \"lng\": 32.857358,\n    \"lat\": 39.93504\n  },\n  \"radius\": 1000,\n  \"backwardInterval\": 3600,\n  \"endTimeEpoch\": 1646374400000,\n  \"pageNumber\": 0,\n  \"pageSize\": 10,\n  \"intensityThreshold\": \"MODERATE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.iklim.co/v1/precipitations/within")

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  \"center\": {\n    \"lng\": 32.857358,\n    \"lat\": 39.93504\n  },\n  \"radius\": 1000,\n  \"backwardInterval\": 3600,\n  \"endTimeEpoch\": 1646374400000,\n  \"pageNumber\": 0,\n  \"pageSize\": 10,\n  \"intensityThreshold\": \"MODERATE\"\n}"

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

{
  "precipitations": [
    {
      "eventId": "6932e0b4d4a02eb8afdf2951",
      "radarTimeStamp": 1646374400000,
      "forecast": false,
      "intensity": "MODERATE"
    }
  ],
  "queryTimestamp": 123,
  "totalRecords": 123,
  "pageNumber": 0,
  "pageSize": 10
}

Body

application/json

center

object

required

Latitude/longitude of the circle center used for the query.

Show child attributes

radius

number<double>

required

Radius in meters defining the search circle around the center point.

Required range: 0 <= x <= 200000

Example:

1000

backwardInterval

integer<int32>

required

Backward interval in seconds counting back from the end time.

Required range: 60 <= x <= 2592000

Example:

3600

endTimeEpoch

integer<int64>

required

Query end time in Epoch milliseconds. Can be extended up to 2 hours future.

Required range: x >= 0

Example:

1646374400000

pageNumber

integer<int32>

required

Zero-based page number to fetch from the paged results.

Required range: x >= 0

Example:

0

pageSize

integer<int32>

required

Number of results returned per page.

Required range: x <= 100

Example:

10

intensityThreshold

enum<string>

Precipitation intensity threshold for filtering results.

Available options:

DRIZZLE,

LIGHT,

MODERATE,

HEAVY,

VERY_HEAVY,

EXTREME

Example:

"MODERATE"

Response

Successfully retrieved the list of precipitation records.

precipitations

object[]

List of precipitation records matching the query.

Show child attributes

queryTimestamp

integer<int64>

The timestamp when the query was executed, in Epoch milliseconds.

totalRecords

integer<int64>

Total number of records found for the given query.

pageNumber

integer<int32>

The current page number of the paginated response.

Example:

0

pageSize

integer<int32>

The number of records returned per page.

Example:

10

Before You Start

Webhook Alarms

MCP Server

Auth & User APIs

Accounts API

Lightning API

Thunderstorm API

Precipitation API

Forecast API

Point Alarm API

Region Alarm API

Forecast Alarm API

Enroute API

Body

Response