Skip to main content
POST
/
v1
/
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"
}
'
{
  "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.

​
radius
number<double>
required

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

Required range: 0 <= x <= 50000
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.

​
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