API Documentation

Welcome to the official documentation for the iGranth API. This API provides powerful, fast, and structured access to Gurbani data including Ang (Page), Shabad, Single Lines, Advanced Searching, the complete Shabad Kosh (Mahan Kosh), SunderGutkas, Daily Nitnem (Banis), Bulk Downloads, and a built-in GurbaniAkhar/Unicode Converter.

Responses are delivered in pure JSON format with ultra-fast caching, complete Unicode conversion, translations, transliterations, and detailed metadata.

The iGranth API requires an active API Key for all requests. Your API key tracks your rate limits and secures your application.

How to get an API Key?

You can generate and manage your own API keys by creating an account in our Developer Portal. New accounts are placed in Test Mode (with a daily limit) until verified by an administrator.

👨‍💻 Go to Developer Portal (Login/Register) →

📚 Supported Granths (Sources)

Filter searches using the source parameter. You can use either the ID or the Letter Code.

🔍 Search Types (searchtype)

Determines the logic used when querying the database. Default is Type 1.

🌍 Languages List

These are the languages supported for Translations and Transliterations in the API response.

📖 Translation Sources

These IDs represent the authors/sources of the translations provided in the API.

✍️ Writers List

Use the writer parameter in Search to filter by specific authors. Pass a comma-separated list of IDs (e.g., writer=1,3).

🎵 Raags / Sections List

Use the raag parameter to filter searches by Raag IDs (e.g., raag=5,10). Raags are mapped dynamically based on the sections table.

📖 Sunder Gutkas (Maryada) List

Use the SunderGutka ID in the API endpoints to filter banis specific to a Maryada.

🙏 Banis (Nitnem) List

Use the Bani ID in the API to fetch complete lines for a specific Bani. (Note: Your database IDs may vary, use the `/bani` API endpoint to get the exact dynamic IDs for your app).

Retrieve all lines and metadata for a specific Ang (Page) of a particular Granth.

/ang/:page/g/:source?apikey=YOUR_KEY

Parameters

Try Example: Ang 15 (SGGS) →

Retrieve a complete Shabad along with Raag, Writer, and Next/Prev Navigation details using its unique ID.

/shabad/:id?apikey=YOUR_KEY

Parameters

Try Example: Shabad 4AZ →

Retrieve a specific single line along with its individual translations and metadata.

/line/:id?apikey=YOUR_KEY

Parameters

Try Example: Line MME8 →

Powerful search endpoint to find lines across all sources using First Letters, Gurmukhi Words, or Translations with extensive filtering options.

/search/:query?source=G&searchtype=1&writer=1,3&raag=5&results=20&skip=0&apikey=YOUR_KEY

URL Variables

Query Parameters (GET Filters)

Try Example: Search 'DDrgj' →

Access the complete Sikh dictionary (Mahan Kosh) including meanings, alphabetical indexing, and word searches.

1. Get Word by ID

/shabadkosh/:id?apikey=YOUR_KEY

Retrieve a specific word and its meaning using its exact database ID.

2. Search a Word

/shabadkosh/search/:word?apikey=YOUR_KEY

Search the dictionary for a specific word using Gurmukhi Unicode (e.g., ਨਾਨਕ) or Akhar format.

3. Alphabetical Index (Letters List)

/shabadkosh/letter?apikey=YOUR_KEY

Get a complete list of all 41 Gurmukhi letters (ੳ to ਲ਼) used in the dictionary.

4. Words by Letter (With Pagination)

/shabadkosh/letter/:letter?results=20&page=1&apikey=YOUR_KEY

Get all words starting with a specific letter (e.g., 'ਅ'). Supports pagination parameters: results (Max 100) and page.

Try Example: Search 'ਨਾਨਕ' → Try Example: Letter 'ਅ' →

Retrieve a list of all available Sunder Gutkas (Maryadas) or fetch specific banis tied to a single Gutka.

1. List All SunderGutkas

/sundergutka?apikey=YOUR_KEY

Returns a complete list of all configured Sunder Gutkas, along with a count of total Banis assigned to each.

2. List Banis in a Specific SunderGutka

/sundergutka/:id?apikey=YOUR_KEY

Returns a list of all Banis (with metadata) that are enabled for a specific Sunder Gutka ID.

Parameters

Try Example: All Gutkas → Try Example: Gutka ID 1 →

Retrieve compiled Banis (Nitnem) containing ordered lines, paragraphs, translations, transliterations, and SunderGutka specific filters.

1. List All Banis

/bani?apikey=YOUR_KEY

Returns a complete list of all visible Banis in the database.

2. Get Full Bani Content

/bani/:id?apikey=YOUR_KEY

Returns all lines for a specific Bani. Each line includes flags showing which Sunder Gutkas it belongs to. Also returns Bani info and translation sources.

3. Get Filtered Bani Content (By Gutka)

/sundergutka/:sg_id/bani/:bani_id?apikey=YOUR_KEY

Returns the content for a specific Bani, but only includes lines that are enabled for the specified Sunder Gutka. The response also injects sundergutkainfo at the top.

Parameters

Try Example: Full Bani 1 → Try Example: Bani 1 (Gutka Filtered) →

Instantly convert text between GurbaniAkhar (ASCII) and standard Gurmukhi Unicode formats.

/convert/:type/:text?apikey=YOUR_KEY

Parameters

Examples

1. Akhar to Unicode: Convert 'Sbd' to 'ਸਬਦ'

Try Example: /convert/unicode/Sbd →

2. Unicode to Akhar: Convert 'ਸਬਦ' to 'Sbd'

Try Example: /convert/akhar/ਸਬਦ →

Export large datasets including metadata, index lists, or full database dumps for offline application usage. Note: Bulk endpoints have higher execution times and memory limits.

1. Get Metadata (Meta API)

/download/meta?apikey=YOUR_KEY

Returns complete lists of Sources, Writers, Languages, Translators, and Raags/Sections.

2. Get Source Index

/download/index/:source_id?apikey=YOUR_KEY

Returns lightweight index data (Line IDs, Shabad IDs, First Letters) for a specific Granth Source. Useful for building offline search capabilities.

3. Get Full Source Database

/download/full/:source_id?apikey=YOUR_KEY

Returns the entire dataset for a given Source ID, including full lines, translations, transliterations, pronunciations, and dictionary notes. (Caution: Large payload, up to 150MB+ for SGGS).

Parameters

Try Example: Download Meta → Try Example: Index (SGGS) →