Skip to content

Request for API access: Mohamed Farah (Quran iOS app) #3944

Description

@MoFarah-42
  • Please tell us about yourself (include an email address):
    Mohamed Farah, farahmo242@gmail.com. Independent iOS developer. I make "Quran: Madinah Mushaf & Audio", a free Quran app on the App Store (id 6809227627): no ads, no accounts, no analytics, no subscription.

  • Your purpose in using this API:
    I am adding a hadith section to the app, and accuracy is its first priority. I want to show each hadith exactly as sunnah.com has it — the Arabic, the published English, the grading with the grader's name, and the collection / book / hadith reference — and link every hadith back to its page (https://sunnah.com/{collection}:{number}). Sunnah.com is credited on every hadith screen and on the app's Sources page. I will not scrape the website, and I keep the deprecated USC-MSA numbering out of the app entirely, citing only sunnah.com reference numbers.
    Collections: Sahih al-Bukhari, Sahih Muslim, Sunan Abi Dawud, Jami` at-Tirmidhi, Sunan an-Nasa'i, Sunan Ibn Majah, Riyad as-Salihin, Forty Hadith of an-Nawawi.

  • API rate limits:

    • Maximum requests per second: 5 during the initial pull; well under 1 afterwards.
    • Maximum requests per day: 20,000 for the initial pull (spread over a few days); under 200 afterwards.
  • Is your use case better served by having an offline dump of hadith data or programmatic API access?
    API access. The app is offline-first (the whole mushaf is bundled), so I would like to make one bulk pull per collection through the API and bundle the resulting JSON inside the app, re-pulling only when you publish corrections (roughly monthly). If an offline dump becomes available I would prefer that. Please let me know whether bundling a snapshot inside a free app is acceptable under your terms; if not, I will fetch on demand instead.

  • What are the languages in which would you like hadith data?
    Arabic and English.

  • What programming language will your API client be in?
    Python (urllib) for the import script; the app itself is Swift and does not call the API directly.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions