> For the complete documentation index, see [llms.txt](https://georisk.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://georisk.gitbook.io/documentation/georisk-api.md).

# GeoRisk API

## What it does: <a href="#what-it-does" id="what-it-does"></a>

The **GeoRisk API** allows you to input a **latitude and longitude**, and in return, it provides **deep insights about that location**. This includes administrative boundaries (like city/district), environmental risks (like flood or seismic zones), infrastructure proximity (like distance to cemeteries or drains), and overall risk profiling of that land.

Perfect for teams working in **real estate, insurance, urban planning, logistics, or risk analysis**.

## Key Benefits for Business <a href="#key-benefits-for-business" id="key-benefits-for-business"></a>

* **Instant risk assessment** of any land parcel.
* Understand if land is **buildable, encroached, green-belt protected**, or near hazards.
* Supports **automation and large-scale geospatial intelligence** workflows.
* Simplifies **compliance and feasibility analysis** for property developers.

## How It Works <a href="#how-it-works" id="how-it-works"></a>

### API Endpoint <a href="#api-endpoint" id="api-endpoint"></a>

```
GET {base_url}/api/?latitude=<float>&longitude=<float>
```

### Required Headers <a href="#required-headers" id="required-headers"></a>

| Header     | Value             | Description                     |
| ---------- | ----------------- | ------------------------------- |
| Access-key | your-api-key-here | **Required** for authentication |

### **Parameters (Inputs)**

| Name      | Type  | Required | Description                |
| --------- | ----- | -------- | -------------------------- |
| latitude  | Float | Yes      | GPS latitude of the point  |
| longitude | Float | Yes      | GPS longitude of the point |

Example: latitude=12.9716, longitude=77.5946

**Successful Response (200 OK)**

```json
{
"City": "Bangalore",
"District": "Bangalore Urban",
"Taluk": "Bangalore North",
"Vacant": "building_present",
"GroundWaterAvailability": "average",
"FloodProne": "not_flood_prone_but_near_water_body",
"SeismicZone": "Zone_2-Low_Damage_Risk",
...
}
```

This is a **snapshot** of all relevant spatial and hazard information about the location. Use it to understand **where it is, what's nearby, and what's risky**.

### **Response Fields Explained**

<table data-full-width="false"><thead><tr><th width="219">Field</th><th width="170">Type</th><th>Description</th></tr></thead><tbody><tr><td><strong>City</strong></td><td><strong>string</strong></td><td><strong>Name of the city closest to the coordinates</strong></td></tr><tr><td><strong>District</strong></td><td><strong>string</strong></td><td><strong>District in which the coordinates fall</strong></td></tr><tr><td><strong>Taluk</strong></td><td><strong>string</strong></td><td><strong>Sub-district or taluk name</strong></td></tr><tr><td><strong>Town</strong></td><td><strong>string</strong></td><td><strong>Town name, if applicable</strong></td></tr><tr><td><strong>Village</strong></td><td><strong>string</strong></td><td><strong>Village name</strong></td></tr><tr><td><strong>Mandal</strong></td><td><strong>string</strong></td><td><strong>Another subdivision name; alternative to Taluk</strong></td></tr><tr><td><strong>Hobli</strong></td><td><strong>string</strong></td><td><strong>Cluster of villages within a Taluk</strong></td></tr><tr><td><strong>City_center</strong></td><td><strong>string</strong></td><td><strong>Location string of the nearest city center (reverse geocoded)</strong></td></tr><tr><td><strong>DistanceFromCityCenter</strong></td><td><strong>string</strong></td><td><strong>Distance to the city center in meters</strong></td></tr><tr><td><strong>Vacant</strong></td><td><strong>string</strong></td><td><p><strong>Indicates land status: "building_present"</strong></p><p><strong>or "vacant_land"</strong></p></td></tr><tr><td><strong>WithinGreenBelt</strong></td><td><strong>boolean</strong></td><td><strong>Whether the point lies in a green belt zone</strong></td></tr><tr><td><strong>GroundWaterAvailability</strong></td><td><strong>string|null</strong></td><td><strong>"scarce" | "average" | "good" | null (not available)</strong></td></tr><tr><td><strong>WaterBody</strong></td><td><strong>string</strong></td><td><strong>"Encroachment_of_lake_bed" | "lake_bed_converted" | "on_lake_bed" | "none"</strong></td></tr><tr><td><strong>FloodProne</strong></td><td><strong>string</strong></td><td><strong>"flood_prone" |  "not_flood_prone_but_near_water_body" | "no_flood_risk"</strong></td></tr><tr><td><strong>SeismicZone</strong></td><td><strong>string</strong></td><td><strong>"Zone_2-Low_Damage_Risk" | "Zone_3-Moderate_Damage_Risk" | "Zone_4-High_Damage_Risk" | "Zone_5-Very_High_Damage_Risk"</strong></td></tr><tr><td><strong>LandSlideZone</strong></td><td><strong>string</strong></td><td><strong>"Very_Low_Risk" | "Low_Risk" | "Medium_Risk" | "High_Risk" | "Very_High_Risk"</strong></td></tr><tr><td><strong>WindHazardZone</strong></td><td><strong>string</strong></td><td><strong>"Low_Damage_Risk" | "Moderate_Damage_Risk_Zone-B" | "Moderate_Damage_Risk_Zone-A" | "High_Damage_Risk" | "Very_High_Damage_Risk_Zone-B" | "Very_High_Damage_Risk_Zone-A"</strong></td></tr><tr><td><strong>CycloneRiskLevel</strong></td><td><strong>string</strong></td><td><strong>"Cyclonic_Storm" | "Severe_Cyclonic_Storm" | "Very_Severe_Cyclonic_Storm" | "Extremely_Severe_Cyclonic_Storm"</strong></td></tr><tr><td><strong>WithinASIMonument</strong></td><td><strong>boolean</strong></td><td><strong>Whether point is within 100m of an ASI monument</strong></td></tr><tr><td><strong>CongestedLane</strong></td><td><strong>boolean</strong></td><td><strong>True if point is in a lane too narrow (&#x3C;4.5m)</strong></td></tr><tr><td><strong>PropertyAccessibility</strong></td><td><strong>string</strong></td><td><strong>"One Side Access" | "Two Side Access" | "Landlocked"</strong></td></tr><tr><td><strong>StormWaterDrainage</strong></td><td><strong>string</strong></td><td><strong>"On a Drain" | "10 m" | "30 m" | "500 m" | "> 500 m" | "No Drains"</strong></td></tr><tr><td><strong>NearestCemetary</strong></td><td><strong>string | null</strong></td><td><strong>Distance to cemetery in meters or null</strong></td></tr><tr><td><strong>NearestPowerline</strong></td><td><strong>string | null</strong></td><td><strong>Distance to powerline in meters or null</strong></td></tr><tr><td><strong>Datasetversion</strong></td><td><strong>string</strong></td><td><strong>Version of the dataset used</strong></td></tr><tr><td><strong>h3</strong></td><td><strong>string</strong></td><td><strong>H3 geospatial index (hex-based spatial ID)</strong></td></tr><tr><td><strong>version</strong></td><td><strong>string</strong></td><td><strong>API version used for this request</strong></td></tr></tbody></table>

### **Error Scenarios**

<table><thead><tr><th width="242">Status</th><th>Message (Example)</th></tr></thead><tbody><tr><td>400</td><td>Missing latitude or longitude</td></tr><tr><td>403</td><td>Invalid Access-key</td></tr><tr><td>500</td><td>Coordinates do not belong to supported regions</td></tr></tbody></table>

### **Example Usage (Developers)**

**cURL**

```url
curl -X GET "{base_url}/api/?latitude=12.9716&longitude=77.5946" \
-H "Access-key: your-api-key"
```

**Python**

{% code fullWidth="false" %}

```python
import requests
url = "{base_url}/api/" headers = {"Access-key": "your-api-key"}
params = {"latitude": 12.9716, "longitude": 77.5946}
response = requests.get(url, headers=headers, params=params) print(response.json())
```

{% endcode %}
