Hadith API

https://hadithapi.com
Admin
Hadith API provides free access to a verified collection of Islamic hadiths in Arabic, Urdu, and...
Tokens:2,630
Snippets:12
Trust Score:5.2
Update:7 months ago
Show doc for...
Tokens:
Raw
### GET /api/books

Source: https://hadithapi.com/docs/books

Retrieve a list of Hadith books. An API key is required for authentication.

```APIDOC
## GET /api/books

### Description
Retrieves a list of Hadith books available through the API. Authentication is required using an API key.

### Method
GET

### Endpoint
/api/books

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your API key, generated in your profile.

### Request Example
```
https://hadithapi.com/api/books?apiKey={API_KEY}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the list of books.
- **message** (string) - A success message.

#### Error Response (403)
- **message** (string) - API key is required.

#### Error Response (401)
- **message** (string) - API key is invalid.

#### Error Response (404)
- **message** (string) - Books not found.

### Sample Code (JavaScript - Fetch API)
```javascript
const apiKey = '{YOUR_API_KEY}';
const apiUrl = `https://hadithapi.com/api/books?apiKey=${apiKey}`;

fetch(apiUrl)
  .then(response => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error('Error fetching books:', error);
  });
```

### Sample Code (JavaScript - jQuery AJAX)
```javascript
const apiKey = '{YOUR_API_KEY}';
const apiUrl = `https://hadithapi.com/api/books?apiKey=${apiKey}`;

$.ajax({
    url: apiUrl,
    type: 'GET',
    success: function(data){
        console.log(data);
    },
    error: function(err){
        console.error('Error fetching books:', err);
    }
});
```

### Sample Code (PHP)
```php
<?php
$apiKey = '{YOUR_API_KEY}';
$apiUrl = 'https://hadithapi.com/api/books?apiKey=' . urlencode($apiKey);

$response = file_get_contents($apiUrl);
if ($response === FALSE) {
    // Handle error
    echo 'Error fetching data';
} else {
    $data = json_decode($response);
    if (json_last_error() === JSON_ERROR_NONE) {
        print_r($data);
    } else {
        // Handle JSON decode error
        echo 'Error decoding JSON';
    }
}
?>
```
```

--------------------------------

### GET /api/hadiths

Source: https://hadithapi.com/docs/hadiths

Retrieve a list of hadiths with various filtering and pagination options.

```APIDOC
## GET /api/hadiths

### Description
Retrieve a list of hadiths with various filtering and pagination options. You can search by English, Urdu, or Arabic keywords, specify a hadith number, book, chapter, or status. Pagination is supported.

### Method
GET

### Endpoint
`https://hadithapi.com/api/hadiths/`

### Parameters
#### Path Parameters
- **apiKey** (string) - Required - Your API key, generated in your profile page.

#### Query Parameters
- **hadithEnglish** (string) - Optional - English word(s) to search within hadiths.
- **hadithUrdu** (string) - Optional - Urdu word(s) to search within hadiths.
- **hadithArabic** (string) - Optional - Arabic word(s) to search within hadiths.
- **hadithNumber** (integer) - Optional - The specific number of the hadith.
- **book** (string) - Optional - The slug of the book (e.g., 'sahih-bukhari', 'sahih-muslim'). See Book Slugs below.
- **chapter** (integer) - Optional - The chapter number within a book.
- **status** (string) - Optional - The status of the hadith (e.g., 'Sahih', 'Hasan', 'Da`eef').
- **paginate** (integer) - Optional - The number of hadiths to return per page. Defaults to 25.

#### Book Slugs
| Book | Slug |
|---|---|
| Sahih Bukhari | sahih-bukhari |
| Sahih Muslim | sahih-muslim |
| Jami' Al-Tirmidhi | al-tirmidhi |
| Sunan Abu Dawood | abu-dawood |
| Sunan Ibn-e-Majah | ibn-e-majah |
| Sunan An-Nasa`i | sunan-nasai |
| Mishkat Al-Masabih | mishkat |
| Musnad Ahmad | musnad-ahmad |
| Al-Silsila Sahiha | al-silsila-sahiha |

### Request Example
```json
{
  "apiKey": "YOUR_API_KEY",
  "hadithEnglish": "prayer",
  "book": "sahih-bukhari",
  "paginate": 10
}
```

### Response
#### Success Response (200)
- **hadiths** (array) - An array of hadith objects.
- **total** (integer) - The total number of hadiths found.
- **per_page** (integer) - The number of hadiths per page.
- **current_page** (integer) - The current page number.
- **last_page** (integer) - The last page number.
- **next_page_url** (string) - URL for the next page, or null if none.
- **prev_page_url** (string) - URL for the previous page, or null if none.

#### Error Responses
- **403** - Forbidden - API key is required.
- **401** - Unauthorized - API key is invalid.
- **404** - Not found - Books not found.

#### Response Example (Success)
```json
{
  "hadiths": [
    {
      "id": 1,
      "hadith_number": 1,
      "book": "Sahih Bukhari",
      "arabic": "...",
      "english": "Narrated \"Al-Bara' bin \'Azib: ...",
      "urdu": "...",
      "status": "Sahih"
    }
  ],
  "total": 100,
  "per_page": 10,
  "current_page": 1,
  "last_page": 10,
  "next_page_url": "https://hadithapi.com/api/hadiths?page=2",
  "prev_page_url": null
}
```
```

--------------------------------

### GET /api/{bookSlug}/chapters

Source: https://hadithapi.com/docs/chapters

Retrieves a list of chapters for a specific Hadith book based on the provided book slug.

```APIDOC
## GET /api/{bookSlug}/chapters

### Description
Fetches all chapters associated with a specific Hadith book. Requires a valid API key for authentication.

### Method
GET

### Endpoint
https://hadithapi.com/api/{bookSlug}/chapters

### Parameters
#### Path Parameters
- **bookSlug** (string) - Required - The unique identifier for the book (e.g., 'sahih-bukhari').

#### Query Parameters
- **apiKey** (string) - Required - Your unique API key generated in your profile.
- **paginate** (integer) - Optional - Number of chapters to return per page.

### Request Example
GET https://hadithapi.com/api/sahih-bukhari/chapters?apiKey=YOUR_API_KEY

### Response
#### Success Response (200)
- **data** (array) - List of chapter objects containing chapter information.

#### Error Responses
- **401** (Unauthorized) - API key is invalid.
- **403** (Forbidden) - API key is missing or required.
- **404** (Not Found) - The specified book slug does not exist.
```

--------------------------------

### Fetch Hadith Books List using PHP

Source: https://hadithapi.com/docs/books

This snippet illustrates how to retrieve the list of Hadith books using PHP's file_get_contents function. It requires a valid API key and decodes the JSON response.

```php
$response = file_get_contents('https://hadithapi.com/api/books?apiKey={API_KEY}');
$response = json_decode($response);
print_r($response);
```

--------------------------------

### Fetch Hadith Books List using JavaScript

Source: https://hadithapi.com/docs/books

This snippet demonstrates how to retrieve a list of Hadith books using the Fetch API in JavaScript. It requires a valid API key and handles both successful responses and errors.

```javascript
const apiUrl = 'https://hadithapi.com/api/books?apiKey={API_KEY}';
fetch(apiUrl)
.then(response => response.json())
.then(data => {
    console.log(data);
})
.catch(error => {
    console.log(error);
})
```

--------------------------------

### Fetch Hadith Books List using jQuery AJAX

Source: https://hadithapi.com/docs/books

This snippet shows how to fetch the list of Hadith books using jQuery's AJAX method. It requires a valid API key and includes success and error handling.

```javascript
const apiUrl = 'https://hadithapi.com/api/books?apiKey={API_KEY}';
$.ajax({
    url: apiUrl,
    type: 'get',
    success: function(data){
        console.log(data);
    },
    error: function(err){
        console.log(err);
    }
})
```

--------------------------------

### Fetch Hadith Chapters (JavaScript)

Source: https://hadithapi.com/docs/chapters

Retrieves a list of chapters for a given Hadith book using the Fetch API in JavaScript. It handles successful responses by parsing JSON data and logs any errors encountered during the request. No external libraries are required.

```javascript
const apiUrl = 'https://hadithapi.com/api/sahih-bukhari/chapters?apiKey={API_KEY}';
fetch(apiUrl)
.then(response => response.json())
.then(data => {
    console.log(data);
})
.catch(error => {
    console.log(error);
})
```

--------------------------------

### Fetch Hadith Chapters (PHP)

Source: https://hadithapi.com/docs/chapters

Retrieves a list of chapters for a Hadith book using PHP's `file_get_contents` function to make the HTTP request. The response is then decoded from JSON into a PHP variable for further processing. This method is suitable for server-side scripting.

```php
$response = file_get_contents('https://hadithapi.com/api/sahih-bukhari/chapters?apiKey={API_KEY}');
$response = json_decode($response);
print_r($response);
```

--------------------------------

### Fetch Hadith Chapters with jQuery (JavaScript)

Source: https://hadithapi.com/docs/chapters

Fetches a list of chapters for a specified Hadith book using jQuery's AJAX method. This method allows for easy handling of asynchronous requests and provides callbacks for success and error scenarios. Requires the jQuery library.

```javascript
const apiUrl = 'https://hadithapi.com/api/sahih-bukhari/chapters?apiKey={API_KEY}';
$.ajax({
    url: apiUrl,
    type: 'get',
    success: function(data){
        console.log(data);
    },
    error: function(err){
        console.log(err);
    }
})
```

--------------------------------

### Fetch Hadiths Data via API

Source: https://hadithapi.com/docs/hadiths

Retrieves a collection of hadiths from the HadithAPI using an API key. Supports various query parameters for filtering results by content, book, or status.

```Javascript
const apiUrl = 'https://hadithapi.com/api/hadiths?apiKey={API_KEY}';
fetch(apiUrl)
.then(response => response.json())
.then(data => {
    console.log(data);
})
.catch(error => {
    console.log(error);
})
```

```jQuery
const apiUrl = 'https://hadithapi.com/api/hadiths?apiKey={API_KEY}';
$.ajax({
    url: apiUrl,
    type: 'get',
    success: function(data){
        console.log(data);
    },
    error: function(err){
        console.log(err);
    }
})
```

```Php
$response = file_get_contents('https://hadithapi.com/api/hadiths?apiKey={API_KEY}');
$response = json_decode($response);
print_r($response);
```
Tokens:
Raw