Endpoints

A list of API endpoints

Quran

Returns the entire Quran

GET /api/quran

Response

Format: JSON

List of Quran Chapters

Returns a list of Quran chapters

GET /api/quran/chapters

Response

Format: JSON

FieldTypeDescription
namestringTransliterated name of chapter
numberintNumber of the chapter
englishstringEnglish name of chapter
verse_countintNumber of verses in chapter

Quran by Chapter

Returns a chapter of the quran

GET /api/quran/{chapter}

Response

Format: JSON

FieldTypeDescription
namestringName of chapter
numberintNumber of the chapter
versesarrayVerses in the chapter
englishstringName in english

Quran by Verse

Returns a verse of the quran

GET /api/quran/{chapter}/{verse}

Response

Format: JSON

FieldTypeDescription
chapterintChapter of the verse
numberintNumber of the verse
textstringText of the verse
arabicstringArabic text of the verse

Hadith

Returns the entire Hadith

GET /api/hadith

Response

Format: JSON

Hadith by Book

Returns a book from the hadith

GET /api/hadith/{book}

Response

Format: JSON

FieldTypeDescription
namestringName of book
hadithsarrayHadiths in the book

Names

Returns the names of Allah

GET /api/names

Response

Format: JSON

Search

Get summarised answers via an LLM

POST /api/search

Request Parameters

Format: JSON

FieldTypeDescription
qstringThe question to ask

Response

Format: JSON

FieldTypeDescription
qstringThe question asked
answerstringAnswer to the question
referencesarrayA list of references used

Daily Reminder

Returns a verse of the Quran, a hadith, and a name of Allah for the day

GET /api/daily

Response

Format: JSON

FieldTypeDescription
namestringName of Allah
hadithstringHadith from Sahih Bukhari
versestringA verse of the Quran
linksmapLinks to the sources
updatedstringTimestamp of update
messagestringSalam, today is ... (Hijri date)

Daily Reminder (by Date)

Returns the daily reminder for a specific date. The "date" format is YYYY-MM-DD.

GET /api/daily/{date}

Response

Format: JSON

FieldTypeDescription
namestringName of Allah
hadithstringHadith from Sahih Bukhari
versestringA verse of the Quran
linksmapLinks to the sources
updatedstringTimestamp of update
messagestringSalam, today is ... (Hijri date)
datestringGregorian date (YYYY-MM-DD)
hijristringHijri date (display format)