# Nirfindia — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.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 India's NIRF rankings across multiple years and categories to compare higher education institution scores, find participating colleges, and search for specific institutions by name. Get detailed ranking parameters and stay updated with the latest notifications about institutional performance and rankings.

**Category:** Education | **Website:** [nirfindia.org/](https://nirfindia.org/) | **Docs:** [parse.bot/marketplace/dde672fd-012e-4ab5-a556-f919cd469ace/nirfindia-org-api](https://parse.bot/marketplace/dde672fd-012e-4ab5-a556-f919cd469ace/nirfindia-org-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/nirfindia/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get available ranking years

Returns all available ranking years published on NIRF. Years range from 2017 to 2025 in descending order. No parameters required.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nirfindia/get-available-ranking-years \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get nirf parameters

Returns the official NIRF ranking methodology and parameters with their sub-parameters. These define how institutions are evaluated across teaching, research, graduation outcomes, outreach, and peer perception dimensions.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nirfindia/get-nirf-parameters \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get notifications

Retrieves list of recent NIRF notifications and advertisements with their publication dates and PDF links.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nirfindia/get-notifications \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get participating institutions list

Returns all institutions that participated in a specific ranking category and year, regardless of whether they were ranked. Typically returns thousands of institutions with basic identifying information.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Category slug as returned by get_ranking_categories. |
| `year` | string | No | Ranking year from 2017 to 2025. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nirfindia/get-participating-institutions-list \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","year":"<string>"}'
```

### Get ranking categories

Returns all available ranking categories for a given year. Categories vary by year; earlier years (2017-2018) have fewer categories than recent years. Each category includes its display name, URL slug for use with other endpoints, and direct URL.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `year` | string | No | Ranking year from 2017 to 2025. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nirfindia/get-ranking-categories \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"year":"<string>"}'
```

### Get rankings by category

Scrapes the ranked list of institutions for a specific category and year. Without rank_band, returns the top 100 with full score breakdowns and PDF report links. With rank_band, returns institutions in that band with name, city, and state only (no scores). Available rank bands are listed in the response when fetching the top 100.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Category slug as returned by get_ranking_categories (e.g. Overall, Engineering, University, Pharmacy, Management, Medical, College, Research, Law, Dental, Architecture, Agriculture, Innovation, OPENUNIVERSITY, SKILLUNIVERSITY, STATEPUBLICUNIVERSITY, SDGInstitutions). |
| `rank_band` | string | No | Rank band suffix for extended rankings beyond top 100. Use values from available_rank_bands[*].rank_band_param in the top-100 response (e.g. '150' for ranks 101-150, '200' for ranks 151-200). When provided, returns a simplified list without scores. |
| `year` | string | No | Ranking year from 2017 to 2025. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nirfindia/get-rankings-by-category \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","rank_band":"<string>","year":"<string>"}'
```

### Search institutions by name

Searches for institutions by name within a specific category and year. Performs a case-insensitive substring match against institution names in the top 100 ranked institutions for the given category. Returns matching institutions with their rank and score.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Category slug to search in. |
| `query` | string | Yes | Institution name search keyword (case-insensitive substring match). |
| `year` | string | No | Ranking year from 2017 to 2025. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/nirfindia/search-institutions-by-name \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","query":"<string>","year":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.