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

Field	Type	Description
name	string	Transliterated name of chapter
number	int	Number of the chapter
english	string	English name of chapter
verse_count	int	Number of verses in chapter

Quran by Chapter

Returns a chapter of the quran

GET /api/quran/{chapter}

Response

Format: JSON

Field	Type	Description
name	string	Name of chapter
number	int	Number of the chapter
verses	array	Verses in the chapter
english	string	Name in english

Quran by Verse

Returns a verse of the quran

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

Response

Format: JSON

Field	Type	Description
chapter	int	Chapter of the verse
number	int	Number of the verse
text	string	Text of the verse
arabic	string	Arabic 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

Field	Type	Description
name	string	Name of book
hadiths	array	Hadiths 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

Field	Type	Description
q	string	The question to ask

Response

Format: JSON

Field	Type	Description
q	string	The question asked
answer	string	Answer to the question
references	array	A 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

Field	Type	Description
name	string	Name of Allah
hadith	string	Hadith from Sahih Bukhari
verse	string	A verse of the Quran
links	map	Links to the sources
updated	string	Timestamp of update
message	string	Salam, 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

Field	Type	Description
name	string	Name of Allah
hadith	string	Hadith from Sahih Bukhari
verse	string	A verse of the Quran
links	map	Links to the sources
updated	string	Timestamp of update
message	string	Salam, today is ... (Hijri date)
date	string	Gregorian date (YYYY-MM-DD)
hijri	string	Hijri date (display format)