Skip to content

Request for API access: [Yahaya Abdulrauf] #3101

@AbYahaya

Description

@AbYahaya
  • Please tell us about yourself (include an email address):

Filu (yabdulrauf911@gmail.com). Software Engineer Building Waraq, an internal translation platform for Islamic book translation and publication

  • Your purpose in using this API:

Waraq is a translation pipeline for classical Arabic texts. When the OCR'd source contains a hadith citation or quotation, the platform looks it up against multiple canonical sources to verify the matn, attach the canonical collection reference (Sahih al-Bukhari, Sahih Muslim, etc.), and persist a verifiable provenance record alongside the German translation. sunnah.com is the primary lookup source in this verification stack — its canonical numbering and authoritative collections (the Six Books / Kutub as-Sittah) make it the right anchor for academic-grade citation. Output is published-quality bilingual editions; no public re-distribution of the API data — sunnah.com remains the cited source.

  • API rate limits:

    • Maximum requests per second:
    • Maximum requests per day:
    • Maximum requests per second: 2
      Maximum requests per day: 5,000
      Conservative limits matched to single-translator workload (one book at a time, batched verification at translation time). Happy to operate at lower limits if preferred.
  • Is your use case better served by having an offline dump of hadith data or programmatic API access?

Programmatic API access. The platform queries sunnah.com on demand during translation runs, often in combination with other sources (Shamela / OpenITI for the Arabic matn, dorar.net for grading) — having live API access lets us pull the exact hadith on the relevant pass without shipping a bulk dataset around. An offline dump would be a useful supplementary fallback but the primary path is the live API.

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

Arabic (matn — primary) and English (sunnah.com's hadithEnglish — used as a secondary reference for the German translator).

  • What programming language will your API client be in?

Python 3.12 (httpx async HTTP client; FastAPI backend).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions