# iklim.co API Documentation

## Docs

- [API Security](https://api-docs.iklim.co/before-start/en/introduction.md): This page provides important information about the details you need to know before making API requests.
- [Authentication](https://api-docs.iklim.co/before-start/en/authentication.md): Authentication guarantees privacy of API Services by authenticating users. Authentication requires users to log in before accessing iklim.co API Services. This guide covers setup for each available handshake method.
- [User Settings](https://api-docs.iklim.co/before-start/en/final-briefing.md): This page provides important information about the details required to make API requests, such as language selection, user registration, account activation and account subscription processes.
- [Webhook Endpoint Guide](https://api-docs.iklim.co/webhook-messages/en/webhook-endpoint-guide.md): Authentication and response requirements shared across all iklim.co webhook alarm deliveries.
- [Lightning Notification](https://api-docs.iklim.co/webhook-messages/en/lightning.md): Deep dive into iklim.co lightning strike webhook payloads for automation-ready apps.
- [Thunderstorm Notification](https://api-docs.iklim.co/webhook-messages/en/thunderstorm.md): Polygon-based thunderstorm lifecycle payload with severity, timing, and lightning cell analytics.
- [Precipitation Notification](https://api-docs.iklim.co/webhook-messages/en/precipitation.md): Comprehensive webhook reference for rain, snow, and mixed precipitation alerts.
- [Forecast Notification](https://api-docs.iklim.co/webhook-messages/en/forecast.md): Multi-day weather forecast alarm payloads with per-metric violation details and district-level location context.
- [MCP Server](https://api-docs.iklim.co/pages/en/mcp-server.md): Connect AI assistants like Claude to the iklim.co Weather API using the Model Context Protocol (MCP).
- [Password Reset Operation](https://api-docs.iklim.co/api-reference/user-service/password-reset-operation.md): Sent during the password reset request
- [Password Reset Request Operation](https://api-docs.iklim.co/api-reference/user-service/password-reset-request-operation.md): This is the operation that receives the password reset request from users who have forgotten their password. A limit is applied to the password reset request for a user within a certain period. When this limit is exceeded, an email is not sent again and an error message is returned.
- [Pageable User Listing Operation](https://api-docs.iklim.co/api-reference/user-service/pageable-user-listing-operation.md): Can only be used by users with the ADMIN role. Retrieves registered users in the system pageably according to the given filter and sorting options
- [New User Creation Operation](https://api-docs.iklim.co/api-reference/user-service/new-user-creation-operation.md): Can only be used by users with the ADMIN role. Creates a new user record with the provided details. If the password field is left blank, a random password of 12 alphanumeric characters is generated. After the user is created, a welcome email is sent to the relevant user's email address (username). P…
- [Change Password Operation](https://api-docs.iklim.co/api-reference/user-service/change-password-operation.md): The operation that allows a user to change their own password. A user cannot change another user's password through this operation!
- [User Update Operation](https://api-docs.iklim.co/api-reference/user-service/user-update-operation.md): An operation where only users with the ADMIN role can update roles, status, and password; only users with POWER_USER and higher roles, along with the requesting user themselves, can change the username; and users with other roles can update the remaining fields.
- [Get User Operation](https://api-docs.iklim.co/api-reference/user-service/get-user-operation.md): Can only be used by users with POWER_USER and higher roles. Retrieves user details with the given user identifier
- [User Unblocking Operation](https://api-docs.iklim.co/api-reference/user-service/user-unblocking-operation.md): Can only be used by users with the ADMIN role. A user who exceeds the number of unauthorized login attempts in the form of a brute-force attack is permanently blocked. This is the operation used to remove this block.
- [Get Own User Information Operation](https://api-docs.iklim.co/api-reference/user-service/get-own-user-information-operation.md): Retrieves only the requester's own user details without providing any token
- [New User Registration](https://api-docs.iklim.co/api-reference/authentication-service/new-user-registration.md): New User Registration is Made
- [Authentication Token Refresh Operation](https://api-docs.iklim.co/api-reference/authentication-service/authentication-token-refresh-operation.md): When the Authentication Token expires, it is renewed using the refresh token
- [Logout Operation](https://api-docs.iklim.co/api-reference/authentication-service/logout-operation.md): Logout Operations Puts JWT In Blacklist
- [Login Operation](https://api-docs.iklim.co/api-reference/authentication-service/login-operation.md): Login Operations are Made With Username And Password
- [Update Subscription Plan](https://api-docs.iklim.co/api-reference/user-accounts-service/update-subscription-plan.md): Updates the account's subscription plan with the provided details.
- [Request Phone Number Activation](https://api-docs.iklim.co/api-reference/user-accounts-service/request-phone-number-activation.md): Starts the phone number activation process by sending a verification code to the user's phone.
- [Create Account](https://api-docs.iklim.co/api-reference/user-accounts-service/create-account.md): Creates a new account with the provided details.
- [Request Account Activation](https://api-docs.iklim.co/api-reference/user-accounts-service/request-account-activation.md): Initiates the process of account activation by sending an activation email to the user.
- [Update Account](https://api-docs.iklim.co/api-reference/user-accounts-service/update-account.md): Updates account information such as email, phone, or other attributes.
- [Get Account Details](https://api-docs.iklim.co/api-reference/user-accounts-service/get-account-details.md): Retrieves detailed information of the account associated with the specified user ID.
- [Activate Phone Number](https://api-docs.iklim.co/api-reference/user-accounts-service/activate-phone-number.md): Activates the user's phone number using user ID, account ID, and phone verification token.
- [Activate Account](https://api-docs.iklim.co/api-reference/user-accounts-service/activate-account.md): Activates the account using user ID, account ID, and email verification token.
- [Within Operation](https://api-docs.iklim.co/api-reference/lightning-service/within-operation.md): Query Lightnings Within Given Point and Radius. Maximum backward interval is 30 days, maximum radius is 50 km.
- [Page Operation](https://api-docs.iklim.co/api-reference/lightning-service/page-operation.md): Query Lightnings by Time Range With Pagination Support. Maximum backward interval is 5 days.
- [Thunderstorm List (Within Radius)](https://api-docs.iklim.co/api-reference/thunderstorm-service/thunderstorm-list-within-radius.md): Returns a paged list of thunderstorms within a given radius of a center point. This endpoint allows querying data within a maximum radius of 50 km and a time range of 30 days based on the endTimeEpoch value.
- [Thunderstorm List (Paged)](https://api-docs.iklim.co/api-reference/thunderstorm-service/thunderstorm-list-paged.md): Returns a paged list of thunderstorms (storm events) detected in the system. This endpoint allows querying data within a time range of 5 days based on the endTimeEpoch value.
- [Get Thunderstorm Details](https://api-docs.iklim.co/api-reference/thunderstorm-service/get-thunderstorm-details.md): Returns detailed information about a specific thunderstorm historic events.
- [Precipitation Geometry](https://api-docs.iklim.co/pages/en/precipitation-geometry.md): Learn how to decode the protobuf-encoded geometry response from the /v1/precipitations/geometry endpoint and render it as standard GeoJSON.
- [Within Operation](https://api-docs.iklim.co/api-reference/precipitation-api/within-operation.md): Retrieves precipitation data within a specified circular area and time range.
- [Page Operation](https://api-docs.iklim.co/api-reference/precipitation-api/page-operation.md): Retrieves a paginated list of precipitation records within the subscription's geographic boundaries for a specified time range.
- [Geometry Operation](https://api-docs.iklim.co/api-reference/precipitation-api/geometry-operation.md): Retrieves the protobuf-encoded geometry of the specified precipitation events, cropped to the given circular area. Users with power user role or above may omit the center point and radius to retrieve the full geometry without cropping.
- [Hourly Forecast Operation](https://api-docs.iklim.co/api-reference/forecast-service/hourly-forecast-operation.md): Returns hour-by-hour weather metrics for the requested location and time span.
- [Daily Forecast Operation](https://api-docs.iklim.co/api-reference/forecast-service/daily-forecast-operation.md): Returns aggregated daily weather metrics for the requested location.
- [Current Forecast Operation](https://api-docs.iklim.co/api-reference/forecast-service/current-forecast-operation.md): Returns the latest available weather metrics for the requested location.
- [Get Weather Icon](https://api-docs.iklim.co/api-reference/weather-icons/get-weather-icon.md): Serves the WEBP icon for the requested condition and day/night variant.
- [Create a point alarm registration](https://api-docs.iklim.co/api-reference/point-alarms/create-a-point-alarm-registration.md): Creates a new point alarm registration within your allowed country/region boundaries.
- [List point alarm registrations (paged)](https://api-docs.iklim.co/api-reference/point-alarms/list-point-alarm-registrations-paged.md): Returns a paged list of point alarm registrations filtered by recipient IDs and/or polygon intersection.
- [Update a point alarm registration](https://api-docs.iklim.co/api-reference/point-alarms/update-a-point-alarm-registration.md): Updates fields of an existing point alarm registration.
- [List registrations by recipientId](https://api-docs.iklim.co/api-reference/point-alarms/list-registrations-by-recipientid.md): Returns registrations for the given recipient
- [Get registration by ID](https://api-docs.iklim.co/api-reference/point-alarms/get-registration-by-id.md): Returns a single point alarm registration using its unique identifier.
- [Delete (unregister) a point alarm registration](https://api-docs.iklim.co/api-reference/point-alarms/delete-unregister-a-point-alarm-registration.md): Deletes a point alarm registration using its unique identifier.
- [Create registration](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/create-registration.md): Creates a registration with boundary, webhook and filters.
- [List registrations (paged)](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/list-registrations-paged.md): Returns registrations with pagination and filters.
- [Update registration](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/update-registration.md): Updates an existing registration.
- [List neighbourhoods](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/list-neighbourhoods.md): Returns neighbourhoods for a district.
- [Get neighbourhood](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/get-neighbourhood.md): Returns neighbourhood info for {neighborhoodId}.
- [Get by recipient ID](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/get-by-recipient-id.md): Lists registrations for a recipient. The recipient ID must be unique and comply with the US-ASCII character set.
- [Get by registration ID](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/get-by-registration-id.md): Returns a single registration by UUID.
- [List districts](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/list-districts.md): Returns districts for a city.
- [Get district](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/get-district.md): Returns district info for {districtId}.
- [Get city](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/get-city.md): Returns city info for {cityId}.
- [List cities](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/list-cities.md): Returns all cities in Türkiye.
- [Delete registration](https://api-docs.iklim.co/api-reference/geo-alarm-registrations/delete-registration.md): Deletes a registration by UUID.
- [Create registration](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/create-registration.md): Creates a forecast alarm registration with boundary, webhook and threshold filters.
- [List registrations (paged)](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/list-registrations-paged.md): Returns forecast alarm registrations with pagination and filters.
- [Update registration](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/update-registration.md): Updates an existing forecast alarm registration.
- [Get by recipient ID](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/get-by-recipient-id.md): Returns all forecast alarm registrations for a given recipient ID.
- [Get by registration ID](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/get-by-registration-id.md): Returns a single registration by UUID.
- [List districts](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/list-districts.md): Returns all districts for the given city ID.
- [Get district](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/get-district.md): Returns district boundary info for the given district ID.
- [Get city](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/get-city.md): Returns city boundary info for the given city ID.
- [List cities](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/list-cities.md): Returns all cities in Türkiye.
- [Delete registration](https://api-docs.iklim.co/api-reference/forecast-point-alarm-registrations/delete-registration.md): Deletes a forecast alarm registration by UUID.
- [Service Details](https://api-docs.iklim.co/pages/en/enroute.md): Weather-aware route monitoring for drivers. Register a route once, then poll for real-time and forecast weather conditions segment by segment as the journey unfolds.
- [Get route weather](https://api-docs.iklim.co/api-reference/enroute/get-route-weather.md): Returns the latest weather data for a previously registered route.
- [Register a route](https://api-docs.iklim.co/api-reference/enroute/register-a-route.md): Registers a new route with departure time and duration. Returns weather and location status for the current and upcoming segments.

## OpenAPI Specs

- [enroute_version-1](https://api-docs.iklim.co/open-api/tr/enroute_version-1.json)
- [point-alarm_version-1](https://api-docs.iklim.co/open-api/tr/point-alarm_version-1.json)
- [geo-alarm_version-1](https://api-docs.iklim.co/open-api/tr/geo-alarm_version-1.json)
- [forecast-alarm_version-1](https://api-docs.iklim.co/open-api/tr/forecast-alarm_version-1.json)
- [precipitations_version-1](https://api-docs.iklim.co/open-api/tr/precipitations_version-1.json)
- [forecasts_version-1](https://api-docs.iklim.co/open-api/tr/forecasts_version-1.json)
- [thunderstorms_version-1](https://api-docs.iklim.co/open-api/thunderstorms_version-1.json)
- [lightnings_version-1](https://api-docs.iklim.co/open-api/lightnings_version-1.json)
- [auth-version-1](https://api-docs.iklim.co/open-api/auth-version-1.json)
- [accounts-version-1](https://api-docs.iklim.co/open-api/accounts-version-1.json)
- [openapi](https://api-docs.iklim.co/api-reference/openapi.json)