api icon indicating copy to clipboard operation
api copied to clipboard

Request for API access: [Nicolas AbdAllah - junayd.org]

Open websentinel-agency opened this issue 2 months ago • 0 comments

  • Please tell us about yourself (include an email address): My name is Nicolas AbdAllah Abou Adam.
    I run a small web agency called WebSentinel, where I build websites and web applications.

    The project I am requesting access for is a personal, non-commercial project (it is not intended as a business product and is not monetized).
    Email: [email protected]

  • Your purpose in using this API: I am developing a personal Islamic web application called Junayd.

    Junayd is a mobile-style React web application for Muslims in France that focuses on:

    • Displaying prayer times by city in France.
    • Providing authentic adhkār (invocations) for the morning, evening, and night/before sleeping.

    The religious content is:

    • Based on the Qur’an and authentic Sunnah,
    • Following the manhaj of Ahl al-Sunna,
    • Structurally inspired by Hisn al-Muslim (Fortress of the Muslim) by Sa‘īd al-Qaḥṭānī for the adhkār sections.

    I would use your API specifically to:

    • Retrieve authentic hadith / du‘ā’ texts that correspond to the adhkār used in the app.
    • Get the Arabic text, a phonetic transliteration in Latin script, and a French translation when available.
    • Display correct hadith references and basic metadata (collection, hadith number, authenticity grading), so users can see the textual evidence behind each invocation.

    This is a personal, non-commercial project:

    • Mainly for my own use and possibly a small circle of users around me.
    • Not a large-scale commercial service and not a mass data extraction tool.
    • The focus is devotional and educational, not business.
  • API rate limits:

    • Maximum requests per second:
      Around 1–2 requests per second is sufficient.
    • Maximum requests per day:
      Approximately 5,000 requests per day is more than enough for my initial use (development, testing, and early personal usage).
  • Is your use case better served by having an offline dump of hadith data or programmatic API access? For my use case (a small, curated subset of hadith related to adhkār), an offline snapshot/dump of the relevant hadith data would be ideal because:

    • I can store only the hadith I actually use in the app (mainly adhkār-related),
    • It reduces runtime network calls and dependency on external services for end users.

    However, programmatic API access would also be very useful:

    • During development and initial data curation,
    • To fetch additional hadiths or updated metadata in the future as I refine the content.

    If I must choose only one, I would say:
    An offline dump of the relevant hadith data first, with API access as a very helpful complement.

  • What are the languages in which would you like hadith data? Primarily:

    • Arabic – original hadith text.
    • French – translations for my main target audience (Muslims living in France).
    • Arabic transliteration (phonetic in Latin script) – so that users who cannot read Arabic script can still pronounce the adhkār correctly.

    Optionally (nice to have):

    • English – for cross-checking and potential future versions of the project.
  • What programming language will your API client be in? The main client will be implemented in:

    • TypeScript / JavaScript, inside a React (Vite) frontend.

    Later, if needed, I may add a small Node.js backend (also in TypeScript) for caching, background jobs, or pre-processing of the hadith data.

websentinel-agency avatar Nov 15 '25 12:11 websentinel-agency