India API

API reference

Every endpoint is a GET under /v1 and answers { "data": ..., "meta": ... }. No key; 600 requests a minute per client.

Money and business

Company logos

Logos and details for companies listed on NSE and BSE.

  • GET /v1/logos/{symbol} Logo image for a listed company
  • GET /v1/companies/{symbol} Details of a listed company
  • GET /v1/companies Search listed companies

IFSC and banks

IFSC to bank and branch.

  • GET /v1/ifsc/{code} Branch for an IFSC
  • GET /v1/ifsc Search a bank's branches
  • GET /v1/banks/{code} Bank for a four-letter code
  • GET /v1/banks Search banks

QR codes and barcodes

QR codes, UPI payment QR codes and barcodes as SVG or PNG.

  • GET /v1/qr QR code for any text
  • GET /v1/upi-qr UPI payment QR code
  • GET /v1/barcode/{type} Barcode

HSN and SAC codes

GST classification codes for goods and services.

  • GET /v1/hsn/{code} A code, its parents and children
  • GET /v1/hsn Search codes

Mutual fund NAVs

Latest net asset value of every Indian mutual fund scheme.

  • GET /v1/mutual-funds/{code} A scheme and its NAV
  • GET /v1/mutual-funds Search schemes
  • GET /v1/mutual-funds/fund-houses Fund houses

Number to words

Numbers and rupee amounts in words, the Indian way.

  • GET /v1/words/{number} Spell out a number

Format checks

Check the format of a GSTIN, PAN or IFSC.

  • GET /v1/validate/{kind}/{value} Check an identifier's format

Places and transport

Pincodes

Pincode to post office, district and state.

  • GET /v1/pincode/{pincode} Post offices for a pincode
  • GET /v1/pincode Search post offices
  • GET /v1/pincode/near Post offices near a point

RTO codes

Vehicle registration code to transport office.

  • GET /v1/rto/{code} Office for an RTO code
  • GET /v1/rto List or search RTO codes

Railway stations

Indian Railways station codes to stations, and back.

  • GET /v1/stations/{code} Station for a code
  • GET /v1/stations Search stations
  • GET /v1/stations/zones Railway zones

Constituencies

Which assembly and Lok Sabha constituency a place is in.

  • GET /v1/constituency Constituencies of a place

Airports

Airport codes to airports, and airports by city.

  • GET /v1/airports/{code} Airport for a code
  • GET /v1/airports Search airports

States

States and union territories with their codes.

  • GET /v1/states All states and union territories
  • GET /v1/states/{code} One state

Dates and calendars

Holidays

Bank, government and stock market holidays.

  • GET /v1/holidays/{year} Holidays in a year

Working days

Bank, market, settlement and government working days.

  • GET /v1/working-days/{date} Is a date a working day
  • GET /v1/working-days Count working days between two dates
  • GET /v1/market/status Is the stock market open

Panchang

Hindu almanac for any date and place: tithi, nakshatra, Rahu kalam and more.

  • GET /v1/panchang/{date} Panchang for a date

Sun and moon

Sunrise, sunset, twilight, moonrise and the moon's phase for any date and place.

  • GET /v1/sun-moon/{date} Sun and moon for a date

Language and text

Thirukkural

All 1,330 kurals in Tamil with English translations.

  • GET /v1/thirukkural/{number} A kural by number
  • GET /v1/thirukkural Search kurals
  • GET /v1/thirukkural/today Kural of the day
  • GET /v1/thirukkural/random A random kural
  • GET /v1/thirukkural/chapters All 133 chapters
  • GET /v1/thirukkural/chapters/{number} One chapter

Text tools

Chunk documents, redact Indian identifiers, count tokens, detect language.

  • GET /v1/text/chunk Split a document into chunks
  • GET /v1/text/redact Redact Indian personal identifiers
  • GET /v1/text/tokens Count tokens
  • GET /v1/text/language Detect the language

Transliteration

Rewrite text between Indian scripts and Roman letters.

  • GET /v1/transliterate Transliterate text

Tamil legacy encodings

Old Tamil text that shows as accented Latin letters, to Unicode and back.

  • GET /v1/tamil-font/convert Convert Tamil text
  • GET /v1/tamil-font/encodings Encodings offered

Network and contact checks

IP address location

IP address to country, state, city and network.

  • GET /v1/ip/{address} Location of an IP address
  • GET /v1/ip Location of your own address

Email checks

Is an email address well formed, throwaway, and able to receive mail.

  • GET /v1/email/{address} Check an email address

DNS check

A domain's DNS records at four public resolvers at once.

  • GET /v1/dns/{name} Look up DNS records

Phone numbers

Check and format an Indian phone number, and see whose series it is.

  • GET /v1/phone/{number} Check a phone number

Traceroute from India

The network path from a server in India to any host, with loss and latency per hop.

  • GET /v1/mtr/{host} Trace the route to a host

Developer tools

Regex tester

Run a regular expression against a text and see every match, explained.

  • GET /v1/regex Test a regular expression

Fake test data

Made-up Indian people, companies and addresses for testing apps.

  • GET /v1/fake/{kind} Generate fake records

Generated images

Social preview images and code screenshots from a URL.

  • GET /v1/og-image Social preview image
  • GET /v1/code-image Code as an image

Sky and radio

Satellite passes

When the ISS and amateur radio satellites pass over you, and where they are now.

  • GET /v1/sat-pass Passes over a place
  • GET /v1/satellites/{id} Where a satellite is now
  • GET /v1/satellites Tracked satellites

HF propagation

Space weather and a rough rating of shortwave radio bands, day and night.

  • GET /v1/propagation Space weather and band conditions