-
Notifications
You must be signed in to change notification settings - Fork 76
Description
- Please tell us about yourself (include an email address):
Zaanouni Mélik
- Your purpose in using this API:
Assalam Aaleykom, I am developing a personal web application (Hadith Vocalizer) aimed at helping beginner and intermediate students of Arabic. The core feature is to retrieve Hadith texts from the Sunnah.com API, and then process the Arabic text to automatically add full vocalization (Tashkeel) using a third-party specialized service (Farasa Seq2seq Diacritization). The application will display the original Arabic text, the fully vocalized Arabic text, and the French translation side-by-side for an enhanced learning experience. I would also like to add word translation, for exemple for each hadith, the hardest words would be selected and displayed bellow with their translation.
-
API rate limits:
- Maximum requests per second:
- Maximum requests per day:
As for the moment I don't plan to publish the app I need the minimum possible for a private use, if I get to a satisfying result maybe I will ask for another key barak Allahu fikom to benefit the ummah
-
Is your use case better served by having an offline dump of hadith data or programmatic API access?
Our primary use case is better served by an offline data dump. We are currently using public domain JSON data dumps (like those from the Fawaz Ahmed repository) for the core content (Riyad as-Salihin text and translations) to ensure fast, static, and reliable loading for the user. However, we request programmatic API access for potential future features, such as: 1. Advanced cross-collection search. 2. Access to more comprehensive metadata not available in the static files. 3. Real-time updates for other future collections.
- What are the languages in which would you like hadith data?
Arabic, English and French
- What programming language will your API client be in?
The client-side (frontend) will use JavaScript/TypeScript (within a Next.js framework). The proxy API route (backend) will use Node.js/TypeScript to manage requests to Sunnah.com and the Farasa vocalization service.
Jazakom Allahu khayran