# Ingres Iith — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Access groundwater resource estimation data across India at multiple geographic levels—from national summaries down to block-level details—and search specific locations to track groundwater availability and assessment trends. View historical assessment years and generate reports to analyze groundwater resources by state, district, or region.

**Category:** Government & Public Data | **Website:** [ingres.iith.ac.in/](https://ingres.iith.ac.in/) | **Docs:** [parse.bot/marketplace/72d8f7f9-affc-4b1e-b02a-42b8734734eb/ingres-iith-ac-in-api](https://parse.bot/marketplace/72d8f7f9-affc-4b1e-b02a-42b8734734eb/ingres-iith-ac-in-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-ingres-iith-ac-in-api-72d8f7f9/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_assessment_years

Returns the list of assessment year periods available in the INGRES system. Each year is a string in YYYY-YYYY format representing the assessment cycle. Use these values as the year parameter in other endpoints.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ingres-iith-ac-in-api-72d8f7f9/get_assessment_years \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_country_summary

Aggregates state-level groundwater data into national-level summary statistics. Computes totals for extractable resources, extraction, recharge, natural discharges, and the national stage of extraction percentage across all states for the given assessment year.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `year` | string | No | Assessment year in YYYY-YYYY format. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ingres-iith-ac-in-api-72d8f7f9/get_country_summary \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"year":"<string>"}'
```

### get_district_data

Returns block-level groundwater data for a specific district. Requires state identification (state_uuid or state_name) and district identification (district_uuid or district_name). Each block includes detailed computation summaries, water level data, trend analysis, and quality tagging.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `district_name` | string | No | District name in uppercase (e.g. JAIPUR). Used for UUID lookup if district_uuid not provided. |
| `district_uuid` | string | No | District UUID from get_state_data results (locationUUID field). |
| `state_name` | string | No | State name in uppercase (e.g. RAJASTHAN). Used for UUID lookup if state_uuid not provided. |
| `state_uuid` | string | No | State UUID from get_state_list results. |
| `year` | string | No | Assessment year in YYYY-YYYY format. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ingres-iith-ac-in-api-72d8f7f9/get_district_data \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"district_name":"<string>","district_uuid":"<string>","state_name":"<string>","state_uuid":"<string>","year":"<string>"}'
```

### get_report_list

Returns all available groundwater assessment reports organized by assessment year. Each report entry includes filename, file path, year, and upload timestamp.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ingres-iith-ac-in-api-72d8f7f9/get_report_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_state_data

Returns district-level groundwater data for a specific state. Provide state_uuid directly or state_name for automatic UUID lookup. Each district includes category classification (safe, semi_critical, critical, over_exploited) and full groundwater metrics.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `state_name` | string | No | State name in uppercase (e.g. RAJASTHAN, MADHYA PRADESH). Used for UUID lookup if state_uuid not provided. |
| `state_uuid` | string | No | State UUID from get_state_list results (locationUUID field). Takes precedence over state_name. |
| `year` | string | No | Assessment year in YYYY-YYYY format. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ingres-iith-ac-in-api-72d8f7f9/get_state_data \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"state_name":"<string>","state_uuid":"<string>","year":"<string>"}'
```

### get_state_list

Returns all Indian states and union territories with their groundwater summary data for a given assessment year. Each state includes area breakdowns, recharge data, extraction data, loss, resource availability, stage of extraction, and locationUUID for drill-down queries.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `year` | string | No | Assessment year in YYYY-YYYY format. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ingres-iith-ac-in-api-72d8f7f9/get_state_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"year":"<string>"}'
```

### search_location

Searches for states by name using case-insensitive substring matching. Returns matching state names with their UUIDs for use in get_state_data or get_district_data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search query for state name. Case-insensitive substring match. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ingres-iith-ac-in-api-72d8f7f9/search_location \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```