Skip to content

Request for API access: [Your Name] #3484

Description

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

    My name is Bex Akim. I am developing Qiraah, a non-commercial and charitable educational application that helps Russian- and Kyrgyz-speaking students learn to read the Quran.

    Email: akimbaevb01@gmail.com

  • Your purpose in using this API:

    We would like to use the API in Qiraah to create a carefully reviewed educational hadith section.

    The application will display the original Arabic text, collection name, hadith number, authenticity information, source reference, and concise explanations in Russian and Kyrgyz.

    Hadiths will be reviewed by qualified teachers or editors before publication. We will not present automatically generated explanations as verified Islamic scholarship.

    Qiraah is not intended to be a commercial hadith platform. Students will be able to use the educational content free of charge. API responses will be cached on our server and will not be requested separately for every user or every page view.

  • API rate limits:

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

    An offline snapshot would be preferable for the main reviewed catalogue because it would allow us to preserve stable references, conduct human verification, provide offline access, and avoid unnecessary API requests.

    Programmatic API access would still be useful for development, checking references, importing selected records, and periodically verifying whether source data has been updated.

    If only one option can be provided, we would prefer an offline dump with clear collection, grading, attribution, and update information.

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

    • Arabic — required for the original hadith text
    • English — for reference and editorial cross-checking
    • Russian — if available
    • Kyrgyz — if available

    We understand that Russian and Kyrgyz translations may not be available. In that case, we will prepare separately reviewed explanations while preserving the Arabic source, exact reference, and available English translation.

  • What programming language will your API client be in?

    TypeScript/JavaScript. The web and server-side client is built with TypeScript.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    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