-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3d62f75
commit 9da51d3
Showing
2 changed files
with
90 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,90 @@ | ||
| # hadith-api | ||
| <h1 align="center">Hadith API</h1> | ||
|
|
||
| <p align="center"> | ||
| <img width="460" height="300" src="https://github.com/fawazahmed0/hadith-api/raw/1/hadith.jpg"> | ||
| </p> | ||
|
|
||
| [](https://www.jsdelivr.com/package/gh/fawazahmed0/hadith-api) | ||
| [](https://www.jsdelivr.com/package/gh/fawazahmed0/hadith-api) | ||
|
|
||
| **In the name of God, who have guided me to do this work** | ||
|
|
||
|
|
||
| **Features:** | ||
| - Free & Blazing Fast response | ||
| - No Rate limits | ||
| - Multiple Languages | ||
| - Multiple Grades | ||
|
|
||
|
|
||
| **URL Structure:** | ||
|
|
||
| `https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@{apiVersion}/{endpoint}` | ||
|
|
||
| **Formats:** | ||
|
|
||
| The Endpoints Supports HTTP GET Method and returns the data in two formats: | ||
|
|
||
| `/{endpoint}.json` | ||
|
|
||
| `/{endpoint}.min.json` | ||
|
|
||
| The above formats also work for fallback i.e if `.min.json` link fails, you can use `.json` link and vice versa | ||
|
|
||
| **Warning:** You should include fallback mechanism in your code, [to avoid issues](https://github.com/fawazahmed0/hadith-api/issues/27) | ||
|
|
||
| **Endpoints:** | ||
|
|
||
| - `/editions`<br> | ||
| > Lists all the available editions in prettified json format:<br> | ||
| [https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions.json](https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions.json "https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions.json") <br> | ||
| > Get a minified version of it:<br> | ||
| [https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions.min.json](https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions.min.json "https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions.min.json") | ||
|
|
||
| - `/editions/{editionName}`<br> | ||
| > Get the whole hadith/hadith translation:<br> | ||
| [https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim.json](https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim.json "https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim.json") <br> | ||
| - `/editions/{editionName}/{HadithNo}` <br> | ||
| > Get the 5th Hadith:<br> | ||
| [https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim/5.json](https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim/5.json "https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim/5.json") | ||
|
|
||
| > Get the 5th Hadith in minified format:<br> | ||
| [https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim/5.min.json](https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim/5.min.json "https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim/5.min.json") | ||
|
|
||
| - `/editions/{editionName}/sections/{sectionNo}` <br> | ||
| > Get Section 3:<br> | ||
| [https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim/sections/3.json](https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim/sections/3.json "https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions/eng-muslim/sections/3.json") | ||
|
|
||
|
|
||
| - `/info` <br> | ||
| > Get all the details about hadith book, such as hadith grades, books reference etc <br> | ||
| [https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/info.json](https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/info.json "https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/info.json")<br> | ||
| ### Contribution: | ||
| Without your contribution, this work won't survive, whenever you find any issue, please let me [Know](https://github.com/fawazahmed0/hadith-api/issues/new "Know"), so that I can also fix it and people can benefit from it, incase of any question, issue or problems etc<br> you can let me [Know](https://github.com/fawazahmed0/hadith-api/issues/new "Know") | ||
|
|
||
| - Please help by adding new translations to this repo, you can share me the translation [here](https://github.com/fawazahmed0/hadith-api/issues/new "here") | ||
|
|
||
| or | ||
| - Read [Contribute](https://github.com/fawazahmed0/hadith-api/blob/1/CONTRIBUTING.md "Contribute") to add/update the translation directly to this repo | ||
|
|
||
|
|
||
| ### Download: [Here](https://github.com/fawazahmed0/hadith-api/blob/1/download.md) | ||
|
|
||
| ### Any Issues: [Raise here](https://github.com/fawazahmed0/hadith-api/issues/new "Raise here") | ||
|
|
||
| ### Other Projects: | ||
| - [Quran-api](https://github.com/fawazahmed0/quran-api) | ||
|
|
||
|
|
||
| ### Share: | ||
| Please share this with your friends and Star this repo by clicking on [:star: button](#) above [:arrow_upper_right:](#) | ||
|
|
||
|
|
||
| <br> | ||
| <br> | ||
| <br> | ||
|
|
||
| [:pencil2:*Improve this page*](https://github.com/fawazahmed0/hadith-api/edit/1/README.md) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.