api.dharun.dev

# India API

**Free, open source APIs for Indian data.** Pincodes, IFSC and bank branches, GSTIN and PAN
checks, bank and market holidays, RTO codes, company logos, UPI QR codes, numbers in lakh
and crore, GST invoices as PDF, OCR in Indian languages, PDF and image tools, text to
speech, and more: 37 APIs behind one consistent JSON shape. No API key, no sign-up, open
CORS, and an MCP server so AI assistants can use it too.

[![CI](https://github.com/dharunashokkumar/api.dharun.dev/actions/workflows/ci.yml/badge.svg)](https://github.com/dharunashokkumar/api.dharun.dev/actions/workflows/ci.yml)
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/dharunashokkumar/api.dharun.dev/badge)](https://scorecard.dev/viewer/?uri=github.com/dharunashokkumar/api.dharun.dev)
[![Licence: AGPL-3.0](https://img.shields.io/badge/licence-AGPL--3.0-blue)](LICENSE)

**Documentation: [api.dharun.dev](https://api.dharun.dev)** · [API reference](https://api.dharun.dev/docs) · [Guides](https://api.dharun.dev/guides) · [Use with AI](https://api.dharun.dev/ai) · [OpenAPI](https://api.dharun.dev/openapi.json) · [llms.txt](https://api.dharun.dev/llms.txt)

```bash
curl https://api.dharun.dev/v1/pincode/637001
```

```json
{
  "data": { "pincode": "637001", "district": "Namakkal", "stateCode": "TN", "state": "Tamil Nadu", "offices": [ ... ] },
  "meta": { "source": { "name": "...", "licence": "...", "attribution": "..." } }
}
```

## APIs

Each name links to its page, with every parameter, a real response and code in curl,
JavaScript and Python.

| API | Example | What you get |
|---|---|---|
| [Company logos](https://api.dharun.dev/docs/logos) | `/v1/logos/TCS`, `/v1/companies/RELIANCE` | SVG or PNG logo of an NSE or BSE listed company; sector, ISIN, market cap, indexes |
| [Pincodes](https://api.dharun.dev/docs/pincode) | `/v1/pincode/637001`, `/v1/pincode/near?lat=&lng=` | Post offices, district, state, coordinates; pincodes near a point |
| [IFSC and banks](https://api.dharun.dev/docs/ifsc) | `/v1/ifsc/SBIN0000001` | Bank, branch, address, MICR, payment systems |
| [RTO codes](https://api.dharun.dev/docs/rto) | `/v1/rto/TN-28` | Transport office for a vehicle registration |
| [Holidays](https://api.dharun.dev/docs/holidays) | `/v1/holidays/2026?type=market` | Bank, central government and stock market holidays |
| [Working days](https://api.dharun.dev/docs/working-days) | `/v1/working-days/2026-01-16?calendar=bank&state=TN` | Working day or not, the next one, N working days ahead, T+1 settlement dates; whether NSE is open |
| [HSN and SAC](https://api.dharun.dev/docs/hsn) | `/v1/hsn/0902`, `/v1/hsn?q=tea` | Tariff codes with descriptions and their chapter |
| [Mutual funds](https://api.dharun.dev/docs/mutual-funds) | `/v1/mutual-funds/122639` | Latest NAV of a scheme, search by name or fund house |
| [Railway stations](https://api.dharun.dev/docs/stations) | `/v1/stations/MAS` | Station name, zone, state |
| [Airports](https://api.dharun.dev/docs/airports) | `/v1/airports/MAA` | IATA and ICAO codes, city, coordinates |
| [Phone numbers](https://api.dharun.dev/docs/phone) | `/v1/phone/9500112345` | Valid or not, mobile or landline, original operator and circle |
| [Constituencies](https://api.dharun.dev/docs/constituency) | `/v1/constituency?pincode=637001` | Assembly and parliamentary constituency for a place |
| [Panchang](https://api.dharun.dev/docs/panchang) | `/v1/panchang/2026-01-14?pincode=600001` | Tithi, nakshatra, yoga, karana, sunrise, Rahu kalam, Tamil month |
| [Sun and moon](https://api.dharun.dev/docs/sun-moon) | `/v1/sun-moon/today?pincode=600001` | Sunrise, sunset, twilight, moonrise, moon phase and illumination |
| [Satellite passes](https://api.dharun.dev/docs/satellites) | `/v1/sat-pass?sat=ISS&pincode=600001` | When the ISS or an amateur radio satellite passes over, and whether it can be seen |
| [HF propagation](https://api.dharun.dev/docs/propagation) | `/v1/propagation` | Solar flux, K and A index, NOAA scales, and a day and night rating per band |
| [Thirukkural](https://api.dharun.dev/docs/thirukkural) | `/v1/thirukkural/1` | Couplet, transliteration, two English translations; search and random |
| [Transliteration](https://api.dharun.dev/docs/transliterate) | `/v1/transliterate?to=tamil&text=...` | Between nine Indian scripts, ISO 15919, IAST and ASCII |
| [Tamil legacy encodings](https://api.dharun.dev/docs/tamil-font) | `/v1/tamil-font/convert?from=tscii&text=...` | TSCII text to Unicode and back |
| [IP lookup](https://api.dharun.dev/docs/ip) | `/v1/ip/8.8.8.8`, `/v1/ip` | Country, city and network of an address, or of the caller |
| [Email check](https://api.dharun.dev/docs/email) | `/v1/email/someone@example.com` | Syntax, disposable domain, whether the domain takes mail |
| [DNS check](https://api.dharun.dev/docs/dns) | `/v1/dns/example.com?type=MX` | Records as several public resolvers see them |
| [Traceroute from India](https://api.dharun.dev/docs/mtr) | `/v1/mtr/example.com` | MTR-style path from a server in India: network, loss and latency per hop |
| [QR, UPI QR and barcodes](https://api.dharun.dev/docs/codes) | `/v1/qr?text=hello`, `/v1/upi-qr?pa=shop@okaxis&am=250`, `POST /v1/barcode/read` | QR codes, UPI payment QR codes and links, barcodes; reading codes from a photo |
| [GST invoice](https://api.dharun.dev/docs/invoice) | `POST /v1/invoice` | A GST tax invoice PDF from JSON: CGST and SGST or IGST, HSN summary, amount in words, UPI QR |
| [OCR](https://api.dharun.dev/docs/ocr) | `POST /v1/ocr?lang=eng+tam` | Text from photos, scans and scanned PDFs in English and ten Indian languages |
| [Image tools](https://api.dharun.dev/docs/image-tools) | `POST /v1/image/convert?format=webp&width=800` | Resize and convert (WebP, AVIF, HEIC in), remove backgrounds, perceptual hashes |
| [PDF tools](https://api.dharun.dev/docs/pdf) | `POST /v1/pdf/merge`, `/pages`, `/rotate`, `/compress`, `/text`, `/render` | Merge, split, rotate, compress, read text, draw pages |
| [Typst to PDF](https://api.dharun.dev/docs/typst) | `/v1/typst?text=...` | Typst documents to PDF or PNG, with Indian scripts |
| [Speech](https://api.dharun.dev/docs/speech) | `/v1/tts?text=...&voice=hi`, `POST /v1/audio/denoise` | Text to speech in Hindi, Telugu, Malayalam and English; noise removal |
| [Generated images](https://api.dharun.dev/docs/images) | `/v1/og-image?title=Hello` | Link preview cards and code images, in ten scripts |
| [Text tools](https://api.dharun.dev/docs/text) | `/v1/text/chunk`, `/redact`, `/tokens`, `/language` | Chunking for retrieval, PII redaction, token counts, language detection |
| [Regex tester](https://api.dharun.dev/docs/regex) | `/v1/regex?pattern=...&text=...` | Every match with its groups, replacement, the pattern explained |
| [Fake Indian data](https://api.dharun.dev/docs/fake) | `/v1/fake/companies?count=5` | Test people and companies with PAN and GSTIN that pass format checks |
| [Number to words](https://api.dharun.dev/docs/words) | `/v1/words/1,25,000?lang=ta` | Lakh and crore spelling in English, Hindi, Tamil |
| [Format checks](https://api.dharun.dev/docs/validate) | `/v1/validate/gstin/27AAPFU0939F1ZV` | GSTIN, PAN and IFSC structure and check characters |
| [States](https://api.dharun.dev/docs/states) | `/v1/states/TN` | State codes, GST codes, vehicle prefixes |

## One shape everywhere

- Every JSON response is `{ "data": ..., "meta": { ... } }`. `data` is an object, or an
  array for list endpoints, which add `meta.total`, `meta.limit` and `meta.offset`.
- `meta.source` names the dataset, its version, its licence and the credit it asks for.
- Errors are `{ "error": { "code", "message" } }` with a matching HTTP status.
- Each client has an allowance of 600 requests a minute. A lookup costs 1; a request that
  takes real CPU work (image rendering, astronomy, live DNS) costs 10, a file upload 15,
  and a neural network job (speech, background removal, denoise) 30.
- Text endpoints take `?text=`, or a POST body as `text/plain` or JSON `{"text": "..."}`.
- Image endpoints return the image itself, ready for an `<img>` tag; PDF and audio
  endpoints return the file.
- File endpoints take a POST of the file as the body, or as `multipart/form-data`, up to
  10 MB. Files are deleted when the answer is sent; nothing is kept.

## Use it from AI assistants

One MCP server, one Agent Skill and one Claude Code plugin cover every API.

```bash
# Claude Code: the MCP server
claude mcp add --transport http india-api https://api.dharun.dev/mcp

# Claude Code: the plugin (skill and MCP server together)
/plugin marketplace add dharunashokkumar/api.dharun.dev
/plugin install india-api@dharun-dev

# Any agent that reads Agent Skills (Claude Code, Codex, Copilot, Cursor, Gemini CLI)
npx skills add dharunashokkumar/api.dharun.dev
```

- **MCP server:** `https://api.dharun.dev/mcp`, Streamable HTTP, stateless, no
  authentication. Each tool returns exactly what the matching REST endpoint returns.
  Setup for Claude, ChatGPT, VS Code, Cursor, Windsurf, Gemini CLI and Codex:
  [api.dharun.dev/ai](https://api.dharun.dev/ai). In the MCP Registry as
  `io.github.dharunashokkumar/india-api`.
- **Agent Skill:** [`skills/india-api`](skills/india-api/SKILL.md).
- **Claude Code plugin:** [`plugins/india-api`](plugins/india-api), with the marketplace in
  [`.claude-plugin/marketplace.json`](.claude-plugin/marketplace.json).
- **For crawlers and agents:** [`/llms.txt`](https://api.dharun.dev/llms.txt),
  [`/llms-full.txt`](https://api.dharun.dev/llms-full.txt), every page as Markdown (add
  `.md` or send `Accept: text/markdown`), [`/openapi.json`](https://api.dharun.dev/openapi.json),
  an MCP server card, an AI catalog and an API catalog under `/.well-known/`.

The skill, the plugin and `server.json` are generated from the catalog in
`internal/api/catalog.go`; a test fails when the committed copies are out of date.

## Licence

- **Calling the API** puts no licence on your app.
- **The code** is licensed under th