-
Please tell us about yourself (include an email address):
My name is Idris Ocasio, and I’m the founder/developer of PocketMusala.
Email: Idris.ocasio@pocketmusala.com
-
Your purpose in using this API:
I’m building PocketMusala, a mobile application for Muslim users and communities. The app currently focuses on prayer times, qibla direction, mosque/community profiles, posts, announcements, events, and Islamic community engagement.
I would like to use the hadith API to allow users to discover, read, and reference authentic hadith within the app. Planned use cases include:
- Allowing users to search and read hadith from supported collections.
- Allowing users to attach a hadith reference to posts or reflections inside the app.
- Displaying the hadith text, collection, reference, grading when available, and source attribution.
- Potentially offering curated hadith sections, such as daily hadith, hadith on prayer, character, fasting, charity, and community manners.
My goal is to treat hadith content as canonical source content, not as user-generated text. Users may add their own reflections or comments, but the hadith itself would be displayed from the API/source data with proper attribution and references.
-
API rate limits:
-
Maximum requests per second:
For the initial integration, I expect low to moderate usage. A limit of around 5 requests per second would be sufficient for development and early production usage.
-
Maximum requests per day:
For early production, I estimate around 5,000–10,000 requests per day would be sufficient. This may increase as PocketMusala grows, especially if hadith search and post attachments become widely used. I’m happy to follow your recommended limits and caching guidance.
-
Is your use case better served by having an offline dump of hadith data or programmatic API access?
Programmatic API access would be best for the initial implementation. It would allow PocketMusala to search, retrieve, and display hadith content while relying on your maintained data source.
Long term, an offline snapshot may also be useful for specific curated use cases, such as daily hadith, selected collections, or offline reading. However, I would only use an offline dump if that is explicitly permitted and if attribution/licensing requirements are clear.
For the initial phase, API access is preferred.
-
What are the languages in which would you like hadith data?
English and Arabic would be the primary languages needed.
English is important for most of the current target audience, while Arabic is important for displaying original hadith text where available.
-
What programming language will your API client be in?
The mobile app is built with Kotlin Multiplatform and Compose Multiplatform for Android and iOS.
For API access, I would likely query the service from a backend layer using TypeScript/Node.js with Firebase Cloud Functions, rather than calling the API directly from the mobile client. This would allow me to keep API credentials secure, apply caching/rate limiting, and normalize responses before sending them to the app.
Please tell us about yourself (include an email address):
My name is Idris Ocasio, and I’m the founder/developer of PocketMusala.
Email: Idris.ocasio@pocketmusala.com
Your purpose in using this API:
I’m building PocketMusala, a mobile application for Muslim users and communities. The app currently focuses on prayer times, qibla direction, mosque/community profiles, posts, announcements, events, and Islamic community engagement.
I would like to use the hadith API to allow users to discover, read, and reference authentic hadith within the app. Planned use cases include:
My goal is to treat hadith content as canonical source content, not as user-generated text. Users may add their own reflections or comments, but the hadith itself would be displayed from the API/source data with proper attribution and references.
API rate limits:
Maximum requests per second:
For the initial integration, I expect low to moderate usage. A limit of around 5 requests per second would be sufficient for development and early production usage.
Maximum requests per day:
For early production, I estimate around 5,000–10,000 requests per day would be sufficient. This may increase as PocketMusala grows, especially if hadith search and post attachments become widely used. I’m happy to follow your recommended limits and caching guidance.
Is your use case better served by having an offline dump of hadith data or programmatic API access?
Programmatic API access would be best for the initial implementation. It would allow PocketMusala to search, retrieve, and display hadith content while relying on your maintained data source.
Long term, an offline snapshot may also be useful for specific curated use cases, such as daily hadith, selected collections, or offline reading. However, I would only use an offline dump if that is explicitly permitted and if attribution/licensing requirements are clear.
For the initial phase, API access is preferred.
What are the languages in which would you like hadith data?
English and Arabic would be the primary languages needed.
English is important for most of the current target audience, while Arabic is important for displaying original hadith text where available.
What programming language will your API client be in?
The mobile app is built with Kotlin Multiplatform and Compose Multiplatform for Android and iOS.
For API access, I would likely query the service from a backend layer using TypeScript/Node.js with Firebase Cloud Functions, rather than calling the API directly from the mobile client. This would allow me to keep API credentials secure, apply caching/rate limiting, and normalize responses before sending them to the app.