sunnah-com / api Goto Github PK

Salam, how is the link to construct with API Key? In other word, how do we put the API Key in the link?

• Please tell us about yourself (include an email address):
  My name is Rijad, I'm a student and a web developer. I make small projects with PHP and Python. My email is:
  [email protected]

• Your purpose in using this API:
  I'm building a small website for hadiths. The purpose of this website is to provide a beautiful background for the hadith so you can screenshot the hadith and post it online. I have already build it for Albanian language, but I dont have the hadith in
  English and Arabic, that's why I'm requesting your API.

• API rate limits:
  I don't really know.

• Is your use case better served by having an offline dump of hadith data or programmatic API access?
  If it is possible, it would be more helpful to me if i could get a .sql , .db , .json or any other format.

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

• What programming language will your API client be in?
  PHP

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

  Name: Faraz Ali
  Email: [email protected]
  About Me: I'm a Software Engineer by profession, based in Pakistan. A friend of mine has requested me to make an offline 
  clone of this website. Luckily this website has API, otherwise I would have to go for Scrapping.

• Your purpose in using this API:

  To make an offline application that could be used without internet.
  

• API rate limits:

  • Maximum requests per second: I'm not sure about this.
  • Maximum requests per day: I think my task will be completed once I get all data and there will be no need of daily
    requests.

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

  I would say its for offline snapshot of data, so that it may run in intranet or offline environments.
  

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

  English & Arabic
  

• What programming language will your API client be in?

   Asp.Net MVC / C#
  

• Please tell us about yourself ([email protected]):

• Your purpose in using this API:

I am building a bot that will be generating images with hadith written on it(one hadith everyday)

• API rate limits:

  • Maximum requests per second:
    5(I am the only user)
  • Maximum requests per day:
    20 max

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

I would like to use the api.

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

English, Malayalam(if you are providing)

• What programming language will your API client be in?

javascript, nodejs

• Please tell us about yourself:

Hasin - [email protected]

• Your purpose in using this API:

For a website to be used for myself.

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:
    I'm not sure but hardly any since I'll be the only user.

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

I would rather have an offline snapshot of the data. I don't thhinink i need programmatic API access.

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

English and Arabic if possible. Otherwise just English. 👍

• What programming language will your API client be in?

C# ASP.NET core 3+

please can anyone help me to get the proper api link ? i need it urgently but dont know how to get the api link :((((((((((((((((

• Please tell us about yourself:
  As-salamu alaykum, my name is Nasser Javed I am 15 years old and I live in California. I’m creating this issue in hopes to receive an access key to engender a bot for my discord server. This bot will every single day send one motivational hadith as a circadian reminder to everyone who joins the server. This will only require one api request to get an arbitrary hadith in Arabic along with its translation.

• Your purpose in using this API:
  I have included my intent inside of the bio above.

• API rate limits:

  • Maximum requests per second: 1
  • Maximum requests per day: 3

• Is your use case better served by having an offline dump of hadith data or programmatic API access?
  I am better off utilizing an online endpoint for my purpose.

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

• What programming language will your API client be in?
  C

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

Youniss Kandah [email protected]

• Your purpose in using this API:

I am building an app, you already granted me a key. after 1 day of developing with your key, It stopped working and the API just tells me that my limit Exceeded:

Object {
"message": "Limit Exceeded",
}

• API rate limits:
  • Maximum requests per second:
  • Maximum requests per day:

I dont know...

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

Both, I think offline would be better but either is fine.

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

english and arabic

• What programming language will your API client be in?

JavaScript. (React Native)

As of now, this is available in the Collections table.

Salams,

Are there plans to upgrade/improve this app to a react application. Would love to be part of that effort.

Jazakum Allahu khair for your efforts!

Wsalam,

Abdul-Rahman

ERROR at line 3: Failed to open file 'db/HadithTable.sql', error:

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

sohail khan - [email protected]

• Your purpose in using this API:

working on a hadith app

• API rate limits:
  • Maximum requests per second:
  • Maximum requests per day:

not sure yet. for testing, not a lot.

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

programmatically since this is an app and having the data would be too much in the app.

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

arabic and english

• What programming language will your API client be in?

not sure yet but the app is in Kotlin ( suggestions welcome 😄 )

• Please tell us about yourself:
  Name: Faris Sulaiman
  Email: [email protected]

• Your purpose in using this API:
  Assalamo Alaikum wrb. Iam student in Malaysia and iam doing Electrical and Electronics Engineering. Apart from it iam interested to have an app that help people to get Islamic stuff in one place. For that i made a small app called Islamic Vibes on playstore. The major part which my app lacks is ahadiths. So i searched many sites but couldn't get reliable data source. Finally Allah landed me here and i hope to have access to hadith through this medium,. The app is not popular only 1k people have installed it. Even though iam paying heavy amount every month but still for the sake of Allah i wish to improve it more and more because one who installs it hardly finds to del it because of the beautiful nasheeds and video reminders.

• API rate limits:

  • **Maximum requests per second: 1 to 3 only **
  • Maximum requests per day: 20 to 30 only

• Is your use case better served by having an offline dump of hadith data or programmatic API access?
  < I guess programmatic Api access because my app runs online. Programmatic Api can be updated time to time but offline is hard to update. >

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

• What programming language will your API client be in?
  <only Android >

JazakAllah khair for your hardwork and coorporation. May Allah reward you for the best.. InShaAllah

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

• Your purpose in using this API:

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

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

• What programming language will your API client be in?

• Please tell us about yourself:

Assalamu Aleikum Warahmataullahi Wabaraktuh ,
My name is Yasir Shariff and my email is [email protected]
I'm Student trying to put my knowledge into a good use by developing a simple app for hadith .

• Your purpose in using this API:

Application , I want to test in app am trying to develop , It's sort of daily reminder , It displays a hadith with it's translation.

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:
    For now it's testing , I haven't exactly thought about the limits I require.

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

I need the hadith in Arabic with it's translation in English

• What programming language will your API client be in?

Dart with Flutter.

For example, the body has HTML in it so we can have body and bodyHtml attributes to allow users to use either one.

Assalamu Aleikum Warahmatullah Wabaraktuh

I set up docker for WSL 2 Environment and have tried to access the localhost server but I keep getting 401 Status error and the error being "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required."

Any Assistance will be appreciated .

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

Ahmed Hafiz ([email protected])

• Your purpose in using this API:

I want to build a website, hopefully include translation of my language as well.

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

For now, I just want API access.

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

Arabic, English, Dhivehi

• What programming language will your API client be in?

javascript.

Salam, I have been trying the api from docs but there is a problem i noticed, in whatever GET values i send the request, it returns the same result.

For example:
https://api.sunnah.com/v1/collections/bukhari/books?limit=10&page=2
Returns:

(root):5 Items

data[]: 50 items
total:97
limit:50
previous:null
next:2

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

Youniss - [email protected]

• Your purpose in using this API:

I am creating a hadith app for IOS and Android as a fun project. I am currently using an API online, but it just has limited books. I also wish to have a feature in the App which links the Sahaba with their Hadiths and also has a search feature to search for specific points of interest.

note: I am new to programming and fully self learned, so its not gonna be a masterpiece, nor will I want to get any money off it.

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:
    I dont know :/

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

Im not sure.

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

english, arabic (also if possible German, bosnian, albanian and turkish)

• What programming language will your API client be in?

I am using react native so javascript. But I usually do everything in python. (dont know if that matters).

I attatched some pictures of what I have so far.

You say on the main page to contact a collaborator to get access to the database files, but offer no form of contact for any of them. Github doesn't have its own messaging system, and it appears that your website on your profile doesn't work. Could you rectify this in some way?

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

• Your purpose in using this API:

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

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

• What programming language will your API client be in?

Please tell us about yourself:
I am Rafi. I am learning frontend web dev.

Your purpose in using this API:
I just want to make an website to attach in my portfolio.

API rate limits:
Maximum requests per second

Is your use case better served by having an offline dump of hadith data or programmatic API access?
I need Programmatic API access

What are the languages in which would you like hadith data?
I need translation in English and Bangla (if possble).

What programming language will your API client be in?
I will use React.

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

Gibreel Abdullah
[email protected]

• Your purpose in using this API:

A reddit bot (https://www.reddit.com/user/BrozzerAbdullahBot) currently responds with Quran Verses, creating a hadith feature.

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:
    Maximum requests per second: Less than 5 (Most likely just one)
    Maximum requests per day: Less than 500 (Most likely less than 20)

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

API Access should be better

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

Arabic and English

• What programming language will your API client be in?

Python

• Please tell us about yourself (include an email address):
  Sufyan - [email protected]

• Your purpose in using this API:
  Want to build a mobile app for Hadith

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:

• Is your use case better served by having an offline dump of hadith data or programmatic API access?
  API key will mean as and when something is updated, the app data is auto-refreshed.

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

• What programming language will your API client be in?
  Dart

@shakram02
Could you please send me the stuff too? Jazakallah khairan

AsSalaamu 'Alaikum wa Rahmatu Allaahi,

Jazaakumu Allaahu khairan for the website sunnah.com, it has helped me a lot in the last few years.

Please tell us about yourself:
My name is Usamah Khan. I am not a professional programmer but I am able to program in a few programing languages and I have made a few apps, wa AlHamdu LiAllaahi. I'm interested in making a few beneficial apps including Ahadith In Shaa Allaahu.

Your purpose in using this API:
I'm interested in making a few beneficial apps that work on many different systems, primarily Android, Windows and Linux In Shaa Allaahu. I know that there are already some apps based on sunnah.com but I'd like to try to make an app that makes Hadith easier to access to as many Muslims as possible and with more options In Shaa Allaahu. I could easily include a better search engine for example In Shaa Allaahu.
I would like to have the data dump for the Ahadith in Sunnah.com please. I would also like to have API access please, so that I can make my own data dump using my python scripts In Shaa Allaahu.

API rate limits:

Maximum requests per second: I don't know, but I'm guessing around 10-20 In Shaa Allaahu, probably always below 100 though.
Maximum requests per day: Almost all the time but only for a few days. I want to make a data dump which might take a few days but I won't need many requests after that In Shaa Allaahu.

Is your use case better served by having an offline dump of hadith data or programmatic API access?
I would like to have both please.

What are the languages in which would you like hadith data?
English, Arabic and Urdu

What programming language will your API client be in?
Python and C#

Do you have an exposed api url one could use?

• Please tell us about yourself:
  Amir Faria, from Brazil, founder of Taha Brasil. We are specialized in content about Islam, mainly in the Portuguese language. My email is [email protected]

• Your purpose in using this API:
  We are creating a robust searcher as a service and we would like to show hadiths on the results as well.

• API rate limits:

  • Maximum requests per second:
    I don't have this info yet.

  • Maximum requests per day:
    I don't have this info yet.

• Is your use case better served by having an offline dump of hadith data or programmatic API access?
  For my project, having an offline dump of hadith data would be better.

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

• What programming language will your API client be in?
  JavaScript / Node.js

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

السلام عليكم ورحمة الله وبركاته

Ammad. I am an iOS Developer. I prefer not to write my e-mail address here to avoid unsolicited e-mails. I will be happy to disclose it by other means.

• Your purpose in using this API:

I would like to write an iOS app as seeing that the Quran.com has an app but the Sunnah.com doesn't. So it would be nice to have a companion app alongside with the Quran.com app.

• API rate limits:
  • Maximum requests per second:
  • Maximum requests per day:

Maximum requests per second seems logical if I cannot have offline data.

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

I believe offline is better as the Quran.com works offline too. Maybe the app will do both, when there are new books, hadiths or corrections or updates then the app can fetch it and update the offline data.

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

All languages that are available but I will prioritise English and Arabic first.

• What programming language will your API client be in?

I don't know yet but I will work it out once you give me permission. I intend to write the app natively in Swift. Not cross-platform language.

Assalamu alaikum warahmatullahi wa barakatuhu,

https://api.sunnah.com/v1/collections/bukhari/books?limit=50&page=1
https://api.sunnah.com/v1/collections/bukhari/books?limit=50&page=2

Im trying the URLs above to fetch list of books of a collection. But every time and with all URLs irrespective of 'page' parameter, im always getting first 50 records rather than next paged records on respective URLs.

Following field values are returned though, which means there would be more records in consecutive calls.

URL
https://api.sunnah.com/v1/collections/bukhari/books?limit=50&page=1
Pagination data

"total": 97,
"limit": 50,
"previous": null,
"next": 2

Can you please suggest what could be wrong here?

Jazak Allah Khairan

• Please tell us about yourself:
  We are based out of India and are building an Islamic library app which will be very simple to use and will encourage users to gain more knowledge about Islam. We have been using sunnah.com and found it very helpful. We are planning to launch our app inshallah in mid August.

• Your purpose in using this API:
  I will mention our Vision as that will answer this question the best.
  Vision: A product for the muslim community which helps us lead a more knowledgable islamic life.

• API rate limits:
  You can tell us your limit and we will make sure we do not cross the limit as we do not intend to hamper sunnah.com service. We will cache the memory and make sure we limit the API requests

  • Maximum requests per second:
  • Maximum requests per day:

• Is your use case better served by having an offline dump of hadith data or programmatic API access?
  Yes, we would prefer if we can get offline dump and can keep the data in our server, we will request sunnah.com API in set intervals to check if any update has been done and update accordingly.

• What are the languages in which would you like hadith data?
  Definitely English to begin with and would like to add as many languages as possible as that will help in spreading Islamic knowledge to more people in the world and help them for their here after.

• What programming language will your API client be in?
  Python or Javascript(nodeJS)

• Please tell us about yourself:

Im Amin Hatib my email is [email protected], i run a discord bot name MuslimBot (https://top.gg/bot/574979234578300948) with islamic features.

• Your purpose in using this API:

The discord bot has islamic features such as prayertimes reading quran etc. and now i'd like to add Hadith related commands which gets data from the chosen collection and books to give the user on their discord servers.

• API rate limits:

Im really not sure about that one i run the discord bot now on more than 700 servers and i cant really tell how much this command will be used after implementing it.

• Maximum requests per second: i'd say 5

• Maximum requests per day: 500

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

English and Arabic

• What programming language will your API client be in?

JavaScript mainly

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

Youniss - [email protected]

• Your purpose in using this API:

I am creating a hadith app for IOS and Android as a fun project. I am currently using an API online, but it just has limited books. I also wish to have a feature in the App which links the Sahaba with their Hadiths and also has a search feature to search for specific points of interest.

note: I am new to programming and fully self learned, so its not gonna be a masterpiece, nor will I want to get any money off it.

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:
    I dont know :/

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

Im not sure.

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

english, arabic

• What programming language will your API client be in?

I am using react native so javascript. But I usually do everything in python. (dont know if that matters).

I attatched some pictures of what I have so far.

It can be spun up using docker compose
https://hub.docker.com/_/varnish

If a user specifies the languages in which they want data returned as a query parameter, then only return those languages.

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

My name is muttahhid. I am a web engineer as professional and I am making a slider project that will display haadiths for a mosque in my locality and I need an API key to proceed. I would be very grateful if I could get one. I prefer not to write my e-mail address here to avoid unsolicited e-mails. I will be happy to disclose it by other means.

• Your purpose in using this API:

I am making a slider project that will display haadiths for a mosque in my locality.

• API rate limits:
  • Maximum requests per second:
  • Maximum requests per day:

My project make 2 to 5 API call each 30 minutes.

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

we will be having internet access for making api requests but we can also use offline data source for faster results.

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

We prefer Arabic text, English and French translations.

• What programming language will your API client be in?

PHP is my strength.

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

• Your purpose in using this API:

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

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

• What programming language will your API client be in?

• Please tell us about yourself (include an email address):
  Muhammad Farid ([email protected])

• Your purpose in using this API:
  The website where the aahadeth will be used is https://www.prophetmuhammad.com/. We only have a limited set of hadith. Based on the akhlaq of our Prophet ﷺ, we are developing this website & we intend to share the hadith collection for easier access & searching.

• API rate limits:

Maximum requests per second:Max
Maximum requests per day:Max

• Is your use case better served by having an offline dump of hadith data or programmatic API access?
  Yes. It will be easier to us to directly use the database rather than rebuilding the db through API

• What are the languages in which would you like hadith data?
  Arabic, English, Urdu

• What programming language will your API client be in?
  PHP/Java

• Please tell us about yourself:

MohammedShareef
[email protected]

• Your purpose in using this API:

Deno Flutter application

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:
    Maximum requests per day

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

API access

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

English & Urdu

• What programming language will your API client be in?

Deno Flutter

Assalamu alaikkum,

I am Zackariya Yoosuf, Abu dhabi.
requesting you for API access for our App, QMT | Quran Malayalam Thafseer.

Jazakumullah Khair.

Note: Not a blocker for v1 launch.

Assalam walaykum!

Mohammed Mustafa here. I am a software engineering student. I was looking to contribute to the islamic community through my skills inshallah and saw this repository. Since this is still under development and that I have restful api experiences, I thought I can inshallah be of some help with the development work. Im fluent in python, flask and restful services. I also have used docker a lot (Ill add you as a contributor to some private repositories in my original github account, of which you can see some public ones this and this, and my website.

I have looked through the repository and it looks great mashallah! Since there were no issues or project boards, I am unsure what tasks I can contribute to. Kindly let me know if you have any tasks/pending unresolved issues that need to be addressed so that I can inshallah help resolve them too! Also, im happy to discuss this over a call too :)

Jazakallah-khair!

• Assalamu alaikum, my name is Naved Ansari, ([email protected]):

• I'm ML Developer and want to apply neural network on Hadees for user preference.:

• API rate limits:

  • Maximum requests per second:

• Is your use case better served by having an offline dump of hadith data or programmatic API access?
  Offline Data would be very helpful, as I will integrate it directly on hosting service using Sequelize.

• What are the languages in which would you like hadith data?
  Any Language, I'm going to add a language button down at every hadees.

• What programming language will your API client be in?
  react and node

• Please tell us about yourself (include an email address):
  Full Name - Mohamed Nashath Mohamed Naseer
  Email Address - [email protected]

• Your purpose in using this API:
  For a website in Sri Lanka called SLMuslims.lk

• API rate limits:

  Maximum requests per day:

• Is your use case better served by having an offline dump of hadith data or programmatic API access?
  API access for my purpose

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

• What programming language will your API client be in?
  Javascript