Skip to content
This repository was archived by the owner on May 4, 2022. It is now read-only.

API Documentation

Sarabveer Singh edited this page Jan 19, 2020 · 6 revisions

This is Documentation for the current production API, located at api.gurbaninow.com/v2.

Search

URL: https://api.gurbaninow.com/v2/search/:query
Example: https://api.gurbaninow.com/v2/search/DDrgj/?source=G&searchtype=1

Variable Use
:query The Actual Query, whatever is typed into the Search Box.
INFO: GurbaniAkhar Keyset and Unicode can be used for searching on searchtype: 0 and 1. searchtype: 2 only supports GurbaniAkhar. URL Encoding is Recommended
source Sets which Source you want Shabads from:
Default is All Sources
G - Guru Granth Sahib Ji
D - Sri Dasam Granth
B - Bhai Gurdas Ji Vaaran
N - Bhai Nand Lal Ji Guzals
A - Amrit Keertan
U - Uggardanti
searchtype Search Type
0 - First Letter Start (Gurmukhi/Unicode) (DEFAULT)
1 - First Letter Anywhere (Gurmukhi/Unicode)
2 - Full Word/Line (Gurmukhi)
3 - Full Word/Line (English)
4 - Search All Words (Gurmukhi)
5 - Search All Words (English)
6 - Search Any Words (Gurmukhi)
7 - Search Any Words (English)
writer Set Writer (Default is All Writers) - WriterID List
raag Set Raag (Default is All Raags) - RaagID List
ang Ang/PageNo
Leave Empty if Not Used
1,2,3,4,.... - Specify Ang/PageNo
results Set Count of Results (DEFAULT 20, MAX 100)
In case skip is set, this will return results from the skip to skip+results results.
skip Skip Records (DEFAULT 0)
For example, if you want 20 to 30 results, set skip=20 and results=10

Get Shabad

URL: https://api.gurbaninow.com/v2/shabad/:id
Example: https://api.gurbaninow.com/v2/shabad/3589

Variable Use
:id ShabadID

Get Line

URL: https://api.gurbaninow.com/v2/line/:id
Example: https://api.gurbaninow.com/v2/line/1

Variable Use
:id Line ID

Get Ang

URL: https://api.gurbaninow.com/v2/ang/:page

URL2: https://api.gurbaninow.com/v2/ang/:page/:source

Examples: https://api.gurbaninow.com/v2/ang/917, https://api.gurbaninow.com/v2/ang/1/D

Variable Use
:ang Set Ang/Paana Number (REQUIRED)
:source Sets which Source you want Shabads from: (OPTIONAL)
G - Guru Granth Sahib Ji (DEFAULT)
D - Sri Dasam Granth
B - Bhai Gurdas Ji Vaaran
N - Bhai Nand Lal Ji Guzals
A - Amrit Keertan
U - Uggardanti

Get Today's Hukamnama from Darbar Sahib, Amritsar

URL: https://api.gurbaninow.com/v2/hukamnama/today

NOTE: Hukamnama API Updates Daily at 9:00 PM Eastern Time
Sometimes the Hukamnama Source does not have the Hukamnama for the Day at 9:00 PM, the API will re-update around 12:00 AM to make sure the Hukamnama for the Day has been updated.

Get Hukamnama Archives from Darbar Sahib, Amritsar

URL: https://api.gurbaninow.com/v2/hukamnama/:year/:month/:day

Example: https://api.gurbaninow.com/v2/hukamnama/2017/1/1

NOTE: Hukamnama Archives only go back up to Year 2002.

GurbaniAkhar/Unicode Converter

URL: https://api.gurbaninow.com/v2/convert/:type/:text

Variable Use
:type unicode - GurbaniAkhar to Unicode
akhar - Unicode to GurbaniAkhar
:text Text to be Converted. URL Encoding is Recommended

Licence

Clone this wiki locally