dorar hadith api Download - dorar hadith api Source code download

Dorar.net Hadith API

May the peace, blessings, and mercy of God be upon you

A while ago I tried to use the dental pearls API
But I faced some difficulties, including that the API only deals with JSONP, and you will not be able to deal with it in normal ways because of CORS.

If you succeed in avoiding CORS by using JSONP you will get the output in HTML format. Also, there is no documentation or document explaining the details of this API and how to deal with it.

I decided to create an intermediary API that avoids the CORS problem and gives you the data in JSON format along with a detailed explanation of the API and how to use it
In addition to containing some additional features that are not found in the official API

alert

Each search is cache for 5 seconds
There is a usage limit: 100 searches per day per IP

You can edit them from the config.js file

Run the API

fork or clone this project
Install dependencies

npm install

Check the config.js file and modify whatever you want
Run the API

npm start

The API will be available at the following link

http://localhost:5000

Use it on localhost as you want, or upload it to your own hosting or server

Documentation

Postman

Link: Postman

Use Postman to learn how to work with the API and see examples
fork the collection to use it as you wish
Do not forget to change the environment to dev and you can change the link for the variable {{url}} if you have changed it or changed the port

OpenAPI v3 (Swagger)

API documentation

To view interactive API documentation:

Run the server:
```
 npm run dev
```
Open your browser and go to:
```
 http://localhost:5000/api-docs
```

Here you will find the Swagger UI that allows you to explore all available endpoints and test the API directly from the browser.

Endpoints

The API contains a set of endpoint

When the endpoint starts with /api , it searches through the official Durar Al-Suniya API
When the endpoint begins with /site , this is how it is searched through the Durar Al-Sunniyya search page

/v1/api/hadith/search?value={text}

Searching for hadiths gives 15 results

Format the response as JSON

{
  "metadata" : {
    "length" : " عدد نتائج البحث " ,
    "page" : " رقم الصفحة " ,
    "removeHTML" : " هل عناصر الـ HTML ممسوحة أم لا " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : [
    {
      "hadith" : " الحديث " ,
      "rawi" : " الراوي " ,
      "mohdith" : " المحدث " ,
      "book" : " الكتاب " ,
      "numberOrPage" : " رقم الحديث او الصفحة " ,
      "grade" : " درجة الصحة "
    }
  ]
}

/v1/site/hadith/search?value={text}

Searching for hadiths gives 30 results

Format the response as JSON

{
  "metadata" : {
    "length" : " عدد نتائج البحث " ,
    "page" : " رقم الصفحة " ,
    "removeHTML" : " هل عناصر الـ HTML ممسوحة أم لا " ,
    "specialist" : " نوع الاحاديث هل هي للمتخصصين أم لا " ,
    "numberOfNonSpecialist" : " عدد الأحاديث لغير المتخصصين " ,
    "numberOfSpecialist" : " عدد الأحاديث للمتخصصين " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : [
    {
      "hadith" : " الحديث " ,
      "rawi" : " الراوي " ,
      "mohdith" : " المحدث " ,
      "mohdithId" : " رقم المحدث " ,
      "book" : " الكتاب " ,
      "bookId" : " رقم الكتاب " ,
      "numberOrPage" : " رقم الحديث او الصفحة " ,
      "grade" : " درجة الصحة " ,
      "explainGrade" : " توضيح درجة الصحة " ,
      "takhrij" : " تخريج الحديث في كتب أخرى " ,
      "hadithId" : " رقم الحديث لاستخدامه في البحث عن الأحاديث البديلة أو الحديث البديل الصحيح " ,
      "hasSimilarHadith" : " هل الحديث له أحاديث مشابهة أم لا " ,
      "hasAlternateHadithSahih" : " هل الحديث له حديث صحيح بديل أم لا " ,
      "similarHadithDorar" : " رابط الأحاديث المشابهة في موقع الدرر " ,
      "alternateHadithSahihDorar" : " رابط الحديث الصحيح في موقع الدرر " ,
      "urlToGetSimilarHadith" : " رابط لكي تبحث عن الأحاديث المشابهة " ,
      "urlToGetAlternateHadithSahih" : " رابط لكي تبحث عن الحديث الصحيح " ,
      "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
      "sharhMetadata" : {
        "id" : " رقم الشرح " ,
        "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
        "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث "
      }
    }
  ]
}

/v1/site/hadith/similar/:id

It brings you similar conversations corresponding to the id

Format the response as JSON

{
  "metadata" : {
    "length" : " عدد نتائج البحث " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : [
    {
      "hadith" : " الحديث " ,
      "rawi" : " الراوي " ,
      "mohdith" : " المحدث " ,
      "mohdithId" : " رقم المحدث " ,
      "book" : " الكتاب " ,
      "bookId" : " رقم الكتاب " ,
      "numberOrPage" : " رقم الحديث او الصفحة " ,
      "grade" : " درجة الصحة " ,
      "explainGrade" : " توضيح درجة الصحة " ,
      "hadithId" : " رقم الحديث لاستخدامه في البحث عن الأحاديث البديلة أو الحديث البديل الصحيح " ,
      "hasSimilarHadith" : " هل الحديث له أحاديث مشابهة أم لا " ,
      "hasAlternateHadithSahih" : " هل الحديث له حديث صحيح بديل أم لا " ,
      "similarHadithDorar" : " رابط الأحاديث المشابهة في موقع الدرر " ,
      "alternateHadithSahihDorar" : " رابط الحديث الصحيح في موقع الدرر " ,
      "urlToGetSimilarHadith" : " رابط لكي تبحث عن الأحاديث المشابهة " ,
      "urlToGetAlternateHadithSahih" : " رابط لكي تبحث عن الحديث الصحيح " ,
      "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
      "sharhMetadata" : {
        "id" : " رقم الشرح " ,
        "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
        "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث "
      }
    }
  ]
}

/v1/site/hadith/:id

It brings you the conversation corresponding to the id

Format the response as JSON

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "hadith" : " الحديث " ,
    "rawi" : " الراوي " ,
    "mohdith" : " المحدث " ,
    "mohdithId" : " رقم المحدث " ,
    "book" : " الكتاب " ,
    "bookId" : " رقم الكتاب " ,
    "numberOrPage" : " رقم الحديث او الصفحة " ,
    "grade" : " درجة الصحة " ,
    "explainGrade" : " توضيح درجة الصحة " ,
    "hadithId" : " رقم الحديث لاستخدامه في البحث عن الأحاديث البديلة أو الحديث البديل الصحيح " ,
    "hasSimilarHadith" : " هل الحديث له أحاديث مشابهة أم لا " ,
    "hasAlternateHadithSahih" : " هل الحديث له حديث صحيح بديل أم لا " ,
    "similarHadithDorar" : " رابط الأحاديث المشابهة في موقع الدرر " ,
    "alternateHadithSahihDorar" : " رابط الحديث الصحيح في موقع الدرر " ,
    "urlToGetSimilarHadith" : " رابط لكي تبحث عن الأحاديث المشابهة " ,
    "urlToGetAlternateHadithSahih" : " رابط لكي تبحث عن الحديث الصحيح " ,
    "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
    "sharhMetadata" : {
      "id" : " رقم الشرح " ,
      "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
      "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث "
    }
  }
}

/v1/site/hadith/alternate/:id

It brings you the correct hadith corresponding to the id

Format the response as JSON

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "hadith" : " الحديث " ,
    "rawi" : " الراوي " ,
    "mohdith" : " المحدث " ,
    "mohdithId" : " رقم المحدث " ,
    "book" : " الكتاب " ,
    "bookId" : " رقم الكتاب " ,
    "numberOrPage" : " رقم الحديث او الصفحة " ,
    "grade" : " درجة الصحة " ,
    "hadithId" : " رقم الحديث لاستخدامه في البحث عن الأحاديث البديلة أو الحديث البديل الصحيح " ,
    "hasSimilarHadith" : " هل الحديث له أحاديث مشابهة أم لا " ,
    "hasAlternateHadithSahih" : " هل الحديث له حديث صحيح بديل أم لا " ,
    "similarHadithDorar" : " رابط الأحاديث المشابهة في موقع الدرر " ,
    "urlToGetSimilarHadith" : " رابط لكي تبحث عن الأحاديث المشابهة " ,
    "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
    "sharhMetadata" : {
      "id" : " رقم الشرح " ,
      "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
      "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث "
    }
  }
}

/v1/site/share/:id

To search for an explanation of a single hadith using id

Format the response as JSON

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "hadith" : " الحديث " ,
    "rawi" : " الراوي " ,
    "mohdith" : " المحدث " ,
    "book" : " الكتاب " ,
    "numberOrPage" : " رقم الحديث او الصفحة " ,
    "grade" : " درجة الصحة " ,
    "takhrij" : " تخريج الحديث في كتب أخرى " ,
    "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
    "sharhMetadata" : {
      "id" : " رقم الشرح " ,
      "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
      "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث " ,
      "sharh" : " شرح الحديث "
    }
  }
}

/v1/site/share/text/:text

To search for an explanation of one hadith based on the method of the given text

Format the response as JSON

{
  "metadata" : {
    "specialist" : " نوع الاحاديث هل هي للمتخصصين أم لا " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "hadith" : " الحديث " ,
    "rawi" : " الراوي " ,
    "mohdith" : " المحدث " ,
    "book" : " الكتاب " ,
    "numberOrPage" : " رقم الحديث او الصفحة " ,
    "grade" : " درجة الصحة " ,
    "takhrij" : " تخريج الحديث في كتب أخرى " ,
    "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
    "sharhMetadata" : {
      "id" : " رقم الشرح " ,
      "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
      "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث " ,
      "sharh" : " شرح الحديث "
    }
  }
}

/v1/site/share/search?value={text}

Searching for an explanation of the hadiths gives 30 results

Format the response as JSON

{
  "metadata" : {
    "length" : " عدد نتائج البحث " ,
    "page" : " رقم الصفحة " ,
    "removeHTML" : " هل عناصر الـ HTML ممسوحة أم لا " ,
    "specialist" : " نوع الاحاديث هل هي للمتخصصين أم لا " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : [
    {
      "hadith" : " الحديث " ,
      "rawi" : " الراوي " ,
      "mohdith" : " المحدث " ,
      "book" : " الكتاب " ,
      "numberOrPage" : " رقم الحديث او الصفحة " ,
      "grade" : " درجة الصحة " ,
      "takhrij" : " تخريج الحديث في كتب أخرى " ,
      "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
      "sharhMetadata" : {
        "id" : " رقم الشرح " ,
        "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
        "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث " ,
        "sharh" : " شرح الحديث "
      }
    }
  ]
}

/v1/site/mohdith/:id

To search for information about the speaker using the id

Format the response as JSON

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "name" : " المحدث " ,
    "mohdithId" : " رقم المحدث " ,
    "info" : " معلومات عن المحدث "
  }
}

/v1/site/book/:id

To search for information about the book using the id

Format the response as JSON

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "name" : " الكتاب " ,
    "bookId" : " رقم الكتاب " ,
    "author" : " المؤلف " ,
    "reviewer" : " المراجع " ,
    "publisher" : " دار النشر " ,
    "edition" : " رقم الطبعة " ,
    "editionYear" : " سنة الطبعة "
  }
}

Query

query elements you can use
With a detailed explanation below the table

key. key	Description
`value`	It is the content of the text of the hadith that you want to search for
`page`	To select the page you want
`removehtml`	Delete `HTML` elements in speech
`specialist`	It is used to determine the type of hadiths, whether they are for specialists or not
`xclude`	A word or phrase that you want to exclude from the search
`st`	Determine the search method
`t`	Define the search scope
`d[]`	Determine the degree of the hadith, whether it is authentic or weak
`m[]`	Specify the names of the updates you want
`s[]`	Select the books you want to search
`rawi[]`	Specify the names of the narrators you want

These brackets [] indicate that this element accepts more than one option

value. value

The content of the hadith text that you want to search for
Example: /v1/api/hadith/search?value=جملة البحث
This will search based on the search term

removehtml

Delete HTML elements in speech
Such as <span class="search-keys">...</span>
Example: /v1/api/hadith/search?value=جملة البحث&removehtml=true
This will delete HTML elements from the search results
The default value is true

specialist

It is used to determine the type of hadiths, whether they are for specialists or not
Its values are true for specialists and false for non-specialists
Example: /v1/api/hadith/search?value=جملة البحث&specialist=true
It will give you more and different conversations, especially for specialists
It contains additional information, such as grading hadiths in other books
The default value is false

xclude

Example: A word or phrase that you want to exclude from the search
Example: /v1/api/hadith/search?value=جملة البحث&xclude=اليهود
Thus, the word اليهود will be excluded from the search

st

The search method is limited to only three options
These methods are: جميع الكلمات , أي كلمة , بحث مطابق
Its values are: w , a , p
To search by جميع الكلمات st=w
To search for أي كلمة it will be st=a
To search with بحث مطابق st=p
Example: /v1/api/hadith/search?value=جملة البحث&st=p
Thus, it will search identically to the search term

All the values and research methods they represent
Or you can get it as a JSON file from here

t

Define the search scope
These ranges are: جميع الأحاديث , الأحاديث المرفوعة , الأحاديث القدسية , آثار الصحابة , شروح الأحاديث
Its values are: * , 0 , 1 , 2 , 3
To search for جميع الأحاديث it will be t=*
To search for الأحاديث المرفوعة , t=0
To search for الأحاديث القدسية t=1
To search for آثار الصحابة t=2
To search for شروح الأحاديث , t=3
Example: /v1/api/hadith/search?value=جملة البحث&t=1
Thus, it will search only for the holy hadiths that match the search term

All values and the search ranges they represent
Or you can get it as a JSON file from here

d[]

Determine the degree of the hadith, whether it is authentic or weak
Its values are: 0 , 1 , 2 , 3 , 4
To search for جميع الدرجات d[]=0
To search for أحاديث حكم المحدثون عليها بالصحة it will be d[]=1
To search for أحاديث حكم المحدثون على أسانيدها بالصحة it will be d[]=2
To search for أحاديث حكم المحدثون عليها بالضعف it will be d[]=3
To search for أحاديث حكم المحدثون على أسانيدها بالضعف it will be d[]=4
Example: /v1/api/hadith/search?value=جملة البحث&d[]=3
Thus, he will only search for hadiths that are doomed to be weak
You can select more than one option
Example: /v1/api/hadith/search?value=جملة البحث&d[]=1&d[]=2
Thus, he will only search for hadiths that are judged to be authentic in terms of text and chain of transmission

All the values and degrees they represent
Or you can get it as a JSON file from here

m[]

Specify the names of the updates you want
It has multiple values, including: 0 , 179 , 204 , 256 , 261 ...etc.
Where 0 represents جميع المحدثين
And 179 represents الإمام المالك
And 204 represents الإمام الشافعي
And 256 represents البخاري
And 261 represents مسلم
Example: /v1/api/hadith/search?value=جملة البحث&m[]=179
Thus, he will search only for the hadiths that were narrated by Imam Malik
You can select more than one option
Example: /v1/api/hadith/search?value=جملة البحث&m[]=256&m[]=261
Thus, he will only search for the hadiths that were narrated by Bukhari and Muslim

All the values and the names of the speakers they represent
Or you can get it as a JSON file from here

s[]

Select the books you want to search
It has multiple values, including: 0 , 13457 , 6216 , 3088 , 96 ...etc.
Where 0 represents جميع المحدثين and 13457 represents الأربعون النووية
And 6216 represents صحيح البخاري
And 3088 represents صحيح مسلم
And 96 represents الصحيح المسند
Example: /v1/api/hadith/search?value=جملة البحث&s[]=96
Thus, he will search only for the hadiths contained in the book Al-Sahih Al-Musnad
You can select more than one option
Example: /v1/api/hadith/search?value=جملة البحث&s[]=6216&s[]=13457
Thus, he will search only for the hadiths that were mentioned in my book, The Forty Nawawi and the book Sahih Al-Bukhari

All the values and the names of the books they represent
Or you can get it as a JSON file from here

rawi[]

Specify the names of the narrators you want
It has multiple values, including: 0 , 1819 , 8918 , 2664 ...etc.
Where 0 represents جميع الرواة
Where 1819 represents أسماء بنت أبي بكر
And 8918 represents عمر بن الخطاب
And 2664 represents ابن عباس
Example: /v1/api/hadith/search?value=جملة البحث&rawi[]=1819
Thus, he will search only for the hadiths narrated by Asmaa bint Abi Bakr
You can select more than one option
Example: /v1/api/hadith/search?value=جملة البحث&rawi[]=8918&rawi[]=2664
Thus, he will search only for the hadiths narrated by Omar bin Al-Khattab and Ibn Abbas
Here are values that symbolize more than one person at the same time
Such as 2665 symbolizes ابن عباس أو أبو هريرة
And 8924 symbolizes عمر بن الخطاب وأبو هريرة
And 264 symbolizes أبو الدرداء وأبو أمامة وعبدالله بن عمر وابن عباس وجابر بن عبدالله

All the values and the names of the narrators that represent them
Or you can get it as a JSON file from here

Data

All available data and the values it represents can be obtained from these endpoints

[
  {
    "endpoint" : " /v1/data/book " ,
    "description" : " احضار كل الكتب المتاحة " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/degree " ,
    "description" : " احضار كل درجات الحديث المتاحة " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/methodSearch " ,
    "description" : " احضار كل طرق البحث المتاحة " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/mohdith " ,
    "description" : " احضار كل المحدثين المتاحين " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/rawi " ,
    "description" : " احضار كل الرواة المتاحين " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/zoneSearch " ,
    "description" : " احضار كل نطاقات البحث المتاحة " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  }
]

There is a problem or do you have a suggestion?

Open an issue if you encounter a problem or have a suggestion

Contribution

Of course we welcome any of our contributions ❤

Expand