Skip to content

Request for API access: [Your Name] #3791

Description

@nabilnasir
  • Please tell us about yourself (include an email address):
    Nabil — data scientist based in Malaysia, working on customer data platforms . This request is for a personal, non-commercial project.

    I'd rather not post my email address on a public issue — I'll be notified of any reply on this thread, so I can respond here. If you need the address to issue a key or send a snapshot, say the word and I'll provide it privately Happy to do whatever is least friction for you.

  • Your purpose in using this API:
    I maintain a personal knowledge-management vault (Obsidian, private) of study notes on sirah, fiqh and Islamic political thought. Notes routinely cite hadith, and I run a verification step (takhrij) that resolves each citation to its canonical collection, book and hadith number before the note is consideredreviewed — so that nothing sits in my notes as an unverified attribution to the Prophet ﷺ. Today that step is done by hand against sunnah.com in a browser, which is slow and does not scale past a few citations at a time.

To be explicit about handling: the vault is private and unpublished, and I am aware that the English translations sunnah.com carries are modern copyrighted works. Retrieved text would be stored locally for my own reading, always with the sunnah.com reference recorded alongside it, and never republished or redistributed in any form.

  • API rate limits:
    (Modest — these apply only if API access is the route rather than a dump.)

    • Maximum requests per second: 2
    • Maximum requests per day: 1,000
  • Is your use case better served by having an offline dump of hadith data or
    programmatic API access?

    An offline dump, if you are willing to provide one. My lookups are reference-resolution against your canonical numbering — collection, book, hadith number, and the grading where you carry it — which a static snapshot serves completely, and it lets me run verification locally without putting any load on your servers at all. I would re-request an updated snapshot periodically rather than treat it as a one-time grab.

    If a dump is not something you hand out, API access would work as well and I am happy with the rate limits above.

  • What are the languages in which would you like hadith data?
    Arabic (primary — I read the Arabic and quote it directly) and English.
    Indonesian/Malay as well, if available for any collections.

  • What programming language will your API client be in?
    Python.

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