sunnah-com
Request for API access: Amira El-Garf
-
Please tell us about yourself (include an email address): My name is Amira El-Garf, a senior year computer engineering student email: [email protected]
-
Your purpose in using this API: it's for my graduation project The goal is to build a semantic search engine that serves as a core component of a larger educational application. This application aims to help users detect and correct errors in their Qur'an recitation (Tajwid).
The semantic search engine will allow users to search a topic (e.g., "rules of madd," "virtues of Ikhlas") and instantly retrieve related and authoritative texts:
- Quranic Ayāt.
- Hadith (related to recitation, virtues, and general Islamic practice).
- API rate limits:
Our system requires bulk access for the following reasons, which go beyond the standard API use case:
Vectorization: We must download the entire text of the six canonical Hadith collections (Kutub al-Sittah) in both Arabic and English. This corpus will be converted into high-dimensional vector embeddings using an Arabic NLP model (e.g., AraBERT).
Semantic Search: The semantic search database must be pre-indexed with all the Hadith data before deployment, meaning a massive, one-time initial download is necessary, which the public API is not designed to handle.
Data Quality: Sunnah.com's commitment to text accuracy and referencing is crucial for the reliability of our educational application.
- Is your use case better served by having an offline dump of hadith data or programmatic API access?
I would rather have an offline snapshot of the data but both works for me
- What are the languages in which would you like hadith data?
English and Arabic
- What programming language will your API client be in?
python
