MohammedArab1 / ThaqalaynAPI

REST + GQL API that can fetch from any of the hadiths available on thaqalayn.net. Fetches all the hadiths found on the website on a weekly basis.

Thaqalayn.net API

https://www.thaqalayn-api.net/

A Rest API that allows for the retrieval of hadiths from thaqalayn.net in JSON format. To create it, I first built a web scraper (python) to get all the hadiths on thaqalayn.net. Afterwards I stored the data in an online database and created an API using node.js + express. I also created a simple front-end with react to showcase one of the endpoints (api/random). The front-end can be reached at https://thaqalayn-api.web.app/

How to use

Here is a simple example of how to fetch one of the endpoints using axios. Change url to whatever endpoint you'd like.

const url = "https://www.thaqalayn-api.net/api/random"

request = axios.get(url).then(res => {
        console.log(res.data);
        //...
    })

Endpoints

All endpoints

1. Retrieve all the available books, with minimum and maximum Id's:
   • https://www.thaqalayn-api.net/api/allbooks
2. Retrieve a random hadith from any book:
   • https://www.thaqalayn-api.net/api/random
3. Retrieve a random hadith from a given book:
   • https://www.thaqalayn-api.net/api/[bookId]/random
4. Make a query throughout the entire database. This is a very simplistic case-insensitive search mechanism that accepts both english and arabic and searches for any hadith with an exact match. Use it with query q:
   • https://www.thaqalayn-api.net/api/query?q=[query]
5. Make a query for a specific book. Same rules as above apply here:
   • https://www.thaqalayn-api.net/api/query/[bookId]?q=[query]
6. Get all the hadiths for a particular book:
   • https://www.thaqalayn-api.net/api/[bookId]
7. Return a specific hadith based on id:
   • https://www.thaqalayn-api.net/api/[bookId]/[id]

Examples

1. Retrieve a random hadith from a given book:
   • https://www.thaqalayn-api.net/api/Al-Amali-Mufid/random
2. Make a query throughout all books:
   • https://www.thaqalayn-api.net/api/query?q=misery%20and%20wretchedness
3. Make a query for a specific book:
   • https://www.thaqalayn-api.net/api/query/Al-Kafi-Volume-6-Kulayni?q=misery%20and%20wretchedness
4. Get all the hadiths for a particular book:
   • https://www.thaqalayn-api.net/api/Al-Amali-Mufid
5. Get a specific hadith based on id:
   • https://www.thaqalayn-api.net/api/Uyun-akhbar-al-Rida-Volume-1-Saduq/80

Extra info

In this github repository you'll also find 4 python files, 2 of them web scrapers:

1. WebScraper/WebScraperComplete.py -> This scrapes the entire thaqalayn.net website and creates a JSON for every book. Also creates a JSON containing all the books.
2. WebScraper/WebScraperPerBook.py -> This scrapes only a single book given the URL of the book from thaqalayn.net. The code is mostly a simple copy/paste from WebScraperComplete.py. If you want to use it, you will need to comment out line 39 and use line 38 with whatever URL you want.
3. WebScraper/ChangeJSON.py -> If you're unhappy with the json's you got from the previous web scrapers, can use this to modify them as you like.
4. WebScraper/CreateBookNamesJSON -> This python file uses the API and creates a JSON of all the names with the min-max IDs. This JSON is then used to create the /allBooks endpoint.

I also included all the scraped JSONs, in case anyone would like to use them directly. This data includes each book separately, all books combined, and a list of all books present with the maximum query id.

Feel free to use any part of this project and modify as you'd like.