islamic-content-sdk

v1.0.6

Published

3 days ago

An integrated and easy-to-use software library to fetch authentic Islamic content (Holy Qur'an and Hadith) in multiple languages directly from official sources.

Downloads

1,164

0High
0Medium
0Low

2yousefreda

Islamic Content SDK

An integrated and easy-to-use software library for developers to fetch authentic Islamic content (The Holy Qur'an and Hadith) in multiple languages directly from official sources.

This project is developed for The Association for Multi-lingual Islamic Content.

[!TIP] AI & LLM Integration: You can also use the official Model Context Protocol (MCP) Server to connect this SDK directly to AI assistants like Claude Desktop, Cursor, VS Code, and more.

Services Overview

This SDK aggregates content from multiple major multi-lingual Islamic platforms:

QuranEnc (quranenc): Quran Translations, suras, verses, and audios.
HadeethEnc (hadeethenc): Hadith collections, category trees, and grades.
IslamHouse (islamhouse): Multi-lingual books, articles, audios, fatwas, and author details.
Risalat Al-Haramain (risalatAlHaramain): Platform content, Fatwas, Quran recitations, and Hadiths.
Bayan Al Islam (bayanAlIslam): Educational booklets and resources tailored for Muslims and Non-Muslims.
Al Montaka (alMontaka): Structured lookups, categories, content filters, and community comments.

Installation

Install the package via your package manager:

npm install islamic-content-sdk

Usage

Initializing the SDK

import { IslamicContentSdk } from "islamic-content-sdk";

const sdk = new IslamicContentSdk();

Detailed Service Methods Reference

Below is a complete guide on how to interact with every single method available in the SDK, including the exact API endpoints and JSON response structures.

Quran Source (QuranEnc API)

API Documentation Link: QuranEnc API

// 1. Get available translations list on the platform
// HTTP Endpoint: GET https://quranenc.com/api/v1/translations/list/{language}?localization={localization}
// Response Shape:
// [
//   {
//     "translation_number": 1,
//     "language_code": "es",
//     "language_name": "Español",
//     "translation_name": "...",
//     "translation_key": "..."
//   }
// ]
const translations = await sdk.quranenc.translationList({
  language: "es",      // Optional: Filter list by language code
  localization: "ar"   // Optional: Localize names in the response
});

// 2. Translate an entire sura (Al-Fatiha in Spanish)
// HTTP Endpoint: GET https://quranenc.com/api/v1/translation/sura/{translationKey}/{suraNumber}
// Response Shape:
// {
//   "result": [
//     {
//       "id": "1",
//       "sura": "1",
//       "aya": "1",
//       "translation": "En el nombre de Alá, el Compasivo, el Misericordioso.",
//       "footnotes": ""
//     }
//   ]
// }
const sura = await sdk.quranenc.translationSura("spanish_montada_eu", 1);

// 3. Translate a specific verse (Ayah 1 of Sura 1)
// HTTP Endpoint: GET https://quranenc.com/api/v1/translation/aya/{translationKey}/{suraNumber}/{ayaNumber}
// Response Shape:
// {
//   "result": {
//     "id": "1",
//     "sura": "1",
//     "aya": "1",
//     "translation": "En el nombre de Alá, el Compasivo, el Misericordioso.",
//     "footnotes": ""
//   }
// }
const aya = await sdk.quranenc.translationAya("spanish_montada_eu", 1, 1);

// 4. Get the audio MP3 file details for a specific verse
// HTTP Endpoint: GET https://d.quranenc.com/data/audio/{translationKey}/{sura3Digits}{aya3Digits}.mp3
// Response Shape:
// {
//   "status": 200,
//   "file_url": "https://d.quranenc.com/data/audio/chinese_suliman/001001.mp3",
//   "content_type": "audio/mpeg"
// }
const audio = await sdk.quranenc.ayaAudio("chinese_suliman", 1, 1);

// 5. Submit translation feedback/note (POST request)
// HTTP Endpoint: POST https://quranenc.com/api/v1/translations/note
// Response Shape:
// {
//   "message": "Note added successfully"
// }
const noteResponse = await sdk.quranenc.addNote({
  sura: 1,
  aya: 1,
  name: "QA Tester",
  email: "[email protected]",
  note: "Test note from SDK automated test suite",
  translation_key: "spanish_montada_eu",
  source: "sdk_test",
  version: "1.0.0"
});

Hadith Source (HadeethEnc API)

API Documentation Link: HadeethEnc API

// 1. Get available languages in the encyclopedia
// HTTP Endpoint: GET https://hadeethenc.com/api/v1/languages
// Response Shape:
// [
//   {
//     "code": "ar",
//     "native": "العربية"
//   }
// ]
const languages = await sdk.hadeethenc.languages();

// 2. Get all categories of Hadith translated in a specific language
// HTTP Endpoint: GET https://hadeethenc.com/api/v1/categories/list/?language={languageCode}
// Response Shape:
// [
//   {
//     "id": "1",
//     "title": "Belief",
//     "parent_id": null
//   }
// ]
const categories = await sdk.hadeethenc.categories("en");

// 3. Get main (root) categories of Hadith in English
// HTTP Endpoint: GET https://hadeethenc.com/api/v1/categories/roots/?language={languageCode}
// Response Shape:
// [
//   {
//     "id": "1",
//     "title": "Belief",
//     "parent_id": null
//   }
// ]
const rootCategories = await sdk.hadeethenc.rootCategories("en");

// 4. List Hadiths under a category with pagination
// HTTP Endpoint: GET https://hadeethenc.com/api/v1/hadeeths/list/?language={language}&category_id={categoryId}&page={page}&per_page={perPage}
// Response Shape:
// [
//   {
//     "id": "2962",
//     "title": "...",
//     "category_id": "1"
//   }
// ]
const hadiths = await sdk.hadeethenc.hadithsList({
  language: "en",
  categoryId: 1,  // Optional
  page: 1,        // Optional
  perPage: 20     // Optional
});

// 5. Get full explanation, translations, and grade of a specific Hadith by ID
// HTTP Endpoint: GET https://hadeethenc.com/api/v1/hadeeths/one/?id={id}&language={language}
// Response Shape:
// {
//   "id": "2962",
//   "title": "...",
//   "hadeeth": "...",
//   "attribution": "...",
//   "grade": "Authentic",
//   "explanation": "..."
// }
const hadith = await sdk.hadeethenc.hadithDetails({
  id: 2962,
  language: "ar"
});

IslamHouse Source (IslamHouse v3 API)

API Documentation Link: IslamHouse API Docs

// ==========================================
// 1. Categories & Types (categoriesAndTypes)
// ==========================================

// Core material types (videos, books, fatwas, etc.)
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/sitecontent/{siteLang}/{contentLang}/json
// Response Shape: [ { "block_name": "showall", "type": "section", "items_count": 12648, "api_url": "..." } ]
const types = await sdk.islamhouse.categoriesAndTypes.allTypes("ar", "ar"); // siteLang, contentLang

// Get all categories in the database
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/categories/showall/{language}/json
// Response Shape: [ { "id": 1, "title": "...", "description": "..." } ]
const allCategories = await sdk.islamhouse.categoriesAndTypes.allCategories("ar");

// Complete category hierarchy tree
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-object-category-tree/{language}/json
// Response Shape: [ { "id": 1, "name": "...", "children": [...] } ]
const tree = await sdk.islamhouse.categoriesAndTypes.categoriesTree("ar");

// Subcategories of a category with content lang localization
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/categories/viewcat/{categoryId}/{siteLang}/{contentLang}/json
// Response Shape: [ { "id": 1, "title": "..." } ]
const childCats = await sdk.islamhouse.categoriesAndTypes.childCategories(1, "ar", "ar");

// Basic details of a category by ID
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/categories/viewitem/{categoryId}/{language}/json
// Response Shape: { "id": 1, "title": "..." }
const singleCategory = await sdk.islamhouse.categoriesAndTypes.singleCategoryBasic(1, "ar");

// Subcategories with nested children
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-sub-categories/{categoryId}/{language}/json
// Response Shape: [ { "id": 1, "title": "..." } ]
const subCategories = await sdk.islamhouse.categoriesAndTypes.subCategories(1, "ar");

// Available material types under a specific category ID
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-category-types-available/{categoryId}/{siteLang}/{contentLang}/json
// Response Shape: [ { "type": "books", "count": 5 } ]
const categoryTypes = await sdk.islamhouse.categoriesAndTypes.categoryTypes(1, "ar", "ar");

// Available languages for materials within a category ID
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-category-source-languages/{categoryId}/{slang}/{language}/json
// Response Shape: [ { "code": "ar", "name": "Arabic" } ]
const categoryLangs = await sdk.islamhouse.categoriesAndTypes.categoryLanguages(1, "ar", "ar");

// ==========================================
// 2. Items Listings (items)
// ==========================================

// List materials by type (e.g. "books", "videos", "audios") and language
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/{type}/{siteLang}/{slang}/{page}/{limit}/json
// Response Shape: [ { "id": 1, "title": "...", "type": "books" } ]
const items = await sdk.islamhouse.items.listItems("books", "ar", "ar", 1, 25);

// List materials published by a specific author ID
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-author-items/{authorId}/{slang}/{siteLang}/{contentLang}/{page}/{limit}/json
// Response Shape: [ { "id": 1, "title": "..." } ]
const authorItems = await sdk.islamhouse.items.authorItems(1, "ar", "ar", "ar", 1, 20);

// List materials categorized under a category ID
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-category-items/{categoryId}/{slang}/{siteLang}/{contentLang}/{page}/{limit}/json
// Response Shape: [ { "id": 1, "title": "..." } ]
const catItems = await sdk.islamhouse.items.categoryItems(1, "ar", "ar", "ar", 1, 20);

// List latest items by period (e.g., "week", "month")
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-latest/{period}/{slang}/{siteLang}/{contentLang}/{page}/{limit}/json
// Response Shape: [ { "id": 1, "title": "..." } ]
const latestItems = await sdk.islamhouse.items.latestItems("week", "ar", "ar", "ar", 1, 25);

// Highlighted featured items on the homepage
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-highlights/{siteLang}/{contentLang}/json
// Response Shape: [ { "id": 1, "title": "..." } ]
const highlights = await sdk.islamhouse.items.highlightedItems("ar", "ar");

// Get the total count of items available for a specific type
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-language-items-count/{type}/{siteLang}/{contentLang}/json
// Response Shape: { "count": 100 }
const itemsCount = await sdk.islamhouse.items.itemsCount("books", "ar", "ar");

// ==========================================
// 3. Single Item Details (item)
// ==========================================

// Details, metadata, and description of a single item
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-item/{itemId}/{language}/json
// Response Shape: { "id": 228065, "title": "...", "description": "...", "prepared_by": [...] }
const itemDetails = await sdk.islamhouse.item.details(228065, "ar");

// List downloadable media/PDF attachments for an item
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/check-attachment/{itemId}/json
// Response Shape: [ { "id": 1, "file_url": "...", "size": "..." } ]
const attachments = await sdk.islamhouse.item.attachments(228065);

// Category tree path leading to this item
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-item-tree/{itemId}/{language}/json
// Response Shape: [ { "id": 1, "name": "..." } ]
const itemTree = await sdk.islamhouse.item.tree(228065, "ar");

// Translation card details of the item
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-item-card-translations/{itemId}/{language}/json
// Response Shape: { "title": "...", "description": "..." }
const itemCardTrans = await sdk.islamhouse.item.cardTranslations(228065, "ar");

// Other translation languages available for this item
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-item-translations/{itemId}/{language}/json
// Response Shape: [ { "locale": "en", "title": "..." } ]
const translations = await sdk.islamhouse.item.translations(228065, "ar");

// ==========================================
// 4. Authors and Publishers (authors)
// ==========================================

// List authors/sources with filter and sort parameters
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-authors-data/{kind}/{locale}/{sort}/{page}/{perPage}/json
// Response Shape: [ { "id": 1, "name": "...", "count": 10 } ]
const authors = await sdk.islamhouse.authors.list({
  kind: "author",     // Optional: "showall" | "author" | "source"
  locale: "ar",       // Optional: "showall" | language code
  sort: "countdesc",  // Optional
  page: 1,            // Optional
  perPage: 10         // Optional
});

// Specific author details by ID
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-author/{authorId}/{language}/json
// Response Shape: { "id": 1, "name": "...", "description": "..." }
const authorDetails = await sdk.islamhouse.authors.details(1, "ar");

// Translation card details of an author
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-author-card-translations/{authorId}/{language}/json
// Response Shape: { "name": "...", "description": "..." }
const authorCard = await sdk.islamhouse.authors.cardTranslations(1, "ar");

// Material types available for an author
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-author-types-avaliable/{authorId}/{siteLang}/{contentLang}/json
// Response Shape: [ { "type": "books", "count": 5 } ]
const authorTypes = await sdk.islamhouse.authors.availableTypes(1, "ar", "ar");

// Languages available for an author
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-author-available-languages/{authorId}/{slang}/{language}/json
// Response Shape: [ { "code": "ar", "name": "Arabic" } ]
const authorLangs = await sdk.islamhouse.authors.availableLocales(1, "ar", "ar");

// ==========================================
// 5. Languages & Terms (languages)
// ==========================================

// Details of all supported languages on the platform
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/languages/get-language-details/json
// Response Shape: [ { "code": "ar", "name": "Arabic" } ]
const langKeys = await sdk.islamhouse.languages.keys();

// Interface translation terms for localization
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/languages/get-language-terms/{language}/json
// Response Shape: { "term_key": "term_value" }
const terms = await sdk.islamhouse.languages.terms("ar");

// Available languages relative to another
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/main/get-available-languages/{slang}/{language}/json
// Response Shape: [ { "code": "ar", "name": "Arabic" } ]
const availLangs = await sdk.islamhouse.languages.availableLanguages("ar", "ar");

// ==========================================
// 6. Holy Quran Recitations (quran)
// ==========================================

// Quran recitation categories (reciters, sections)
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/quran/get-categories/{language}/json
// Response Shape: [ { "id": 1, "name": "..." } ]
const quranCategories = await sdk.islamhouse.quran.categories("ar");

// Basic details of a Quran category
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/quran/get-category/{categoryId}/{language}/json
// Response Shape: { "id": 1, "name": "..." }
const quranCategory = await sdk.islamhouse.quran.singleCategory(1, "ar");

// Details about a specific reciter
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/quran/get-author/{reciterId}/{language}/json
// Response Shape: { "id": 1, "name": "..." }
const reciterDetails = await sdk.islamhouse.quran.authorDetails(1, "ar");

// Recitations list of a specific reciter
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/quran/get-author-recitations/{reciterId}/{language}/json
// Response Shape: [ { "id": 1, "title": "..." } ]
const recitations = await sdk.islamhouse.quran.authorRecitations(1, "ar");

// Detailed info of a specific Quran Surah
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/quran/get-sura/{suraId}/{language}/json
// Response Shape: { "sura_id": 1, "name": "..." }
const suraDetails = await sdk.islamhouse.quran.suraDetails(1, "ar");

// Audio recordings of a specific Surah by various reciters
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/quran/get-sura-recitations/{suraId}/{language}/json
// Response Shape: [ { "id": 1, "title": "..." } ]
const suraRecitations = await sdk.islamhouse.quran.suraRecitations(1, "ar");

// Details of a specific Quran recitation by ID
// HTTP Endpoint: GET https://api3.islamhouse.com/v3/paV29H2gm56kvLPy/quran/get-recitation/{recitationId}/{language}/json
// Response Shape: { "id": 228065, "title": "...", "audio_url": "..." }
const recitation = await sdk.islamhouse.quran.recitationDetails(228065, "ar");

Risalat Al-Haramain Source (Risalat Al-Haramain API)

API Documentation Link: Risalat Al-Haramain API

// ==========================================
// 1. Platform Contents (contents)
// ==========================================

// Get full content of the platform in a specific language
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/get_full_contents?lang={lang}
// Response Shape: { "data": [ { "id": 81, "name": "...", "description": "..." } ] }
const fullContents = await sdk.risalatAlHaramain.contents.getFullContents({
  language: "en", // Optional: URL language path (default: "en")
  lang: "en"     // Optional: Query parameter language (default: "en")
});

// Retrieve contents with optional parameters
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/content?lang={lang}
// Response Shape: { "data": [ { "id": 81, "name": "..." } ] }
const contents = await sdk.risalatAlHaramain.contents.getContents({
  language: "en",
  lang: "en"
});

// Get detailed content of a single item
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/single-content?id={contentId}
// Response Shape: { "data": { "id": 1, "name": "..." } }
const singleContent = await sdk.risalatAlHaramain.contents.singleContent(1, "en");

// Quick search items by name
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/name_search?name={name}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const nameSearchResult = await sdk.risalatAlHaramain.contents.nameSearch("حصن", "ar");

// Check available translation languages for an item
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/available_languages/{contentId}
// Response Shape: { "data": [ { "code": "ar", "name": "Arabic" } ] }
const risalaAvailLangs = await sdk.risalatAlHaramain.contents.availableLanguages(1, "ar");

// Get translation of a content item into a target language
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/content_translation/{contentId}?language={targetLanguage}
// Response Shape: { "data": { "id": 1, "translation": "..." } }
const contentTranslation = await sdk.risalatAlHaramain.contents.contentTranslation(1, "en", "ar");

// ==========================================
// 2. Islamic Content Modules (islamicContent)
// ==========================================

// Get Fatwas
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/fatwas?lang={lang}&is_featured={isFeatured}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const fatwas = await sdk.risalatAlHaramain.islamicContent.fatwas({
  language: "en",    // Optional
  lang: "ar",        // Optional
  isFeatured: 1      // Optional: 0 or 1
});

// Get featured Hadiths
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/hadeeths?lang={lang}&is_featured={isFeatured}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const hadeeths = await sdk.risalatAlHaramain.islamicContent.hadeeths({
  language: "en",
  lang: "ar",
  isFeatured: 1
});

// Get featured Quran recitations
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/quran?lang={lang}&is_featured={isFeatured}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const quranContent = await sdk.risalatAlHaramain.islamicContent.quran({
  language: "en",
  lang: "ar",
  isFeatured: 1
});

// ==========================================
// 3. Platform Search (search)
// ==========================================

// Keyword text search across platform content
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/search?query={query}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const searchResult = await sdk.risalatAlHaramain.search.contents("حصن", "en");

// ==========================================
// 4. Lookups & Meta (lookups)
// ==========================================

// Get available languages
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/langs?api_key={apiKey}
// Response Shape: { "data": [ { "id": 51, "iso_code": "en", "name": "English" } ] }
const risalaLangs = await sdk.risalatAlHaramain.lookups.languages("en");

// Get available content types
// HTTP Endpoint: GET https://risala.prh.gov.sa/{language}/Api/content-types
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const contentTypes = await sdk.risalatAlHaramain.lookups.contentTypes("en");

Bayan Al Islam Source (Bayan Al Islam API)

Postman Resources: Collection | Environment

// 1. Get list of available languages
// HTTP Endpoint: GET https://byenah.com/{language}/Api/languages/list
// Response Shape: { "data": [ { "id": 51, "name_en": "English", "iso_code": "en" } ] }
const bayanLangs = await sdk.bayanAlIslam.languagesList("ar");

// 2. Get content list tailored for Muslims
// HTTP Endpoint: GET https://byenah.com/{language}/Api/content/muslims/full_list
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const muslimList = await sdk.bayanAlIslam.muslimList("en");

// 3. Get content list tailored for Non-Muslims
// HTTP Endpoint: GET https://byenah.com/{language}/Api/content/non-muslims/full_list
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const nonMuslimList = await sdk.bayanAlIslam.nonMuslimList("en");

// 4. Get details of a specific content item by ID
// HTTP Endpoint: GET https://byenah.com/{language}/Api/single-content?id={contentId}
// Response Shape: { "content": { "id": 22184, "name": "..." } }
const contentDetails = await sdk.bayanAlIslam.singleContent(22184, "en");

// 5. Get languages list paginated and filtered by name
// HTTP Endpoint: GET https://byenah.com/{language}/Api/paginated-languages?name={name}&page={page}
// Response Shape: { "data": [ { "id": 51, "name": "..." } ] }
const paginatedLangs = await sdk.bayanAlIslam.paginatedLanguages({
  name: "English", // Optional
  page: 1,         // Optional
  language: "en"   // Optional
});

// 6. Get recent contents (Muslim/Non-Muslim updates)
// HTTP Endpoint: GET https://byenah.com/{language}/Api/recent-contents?lang={lang}&init={init}&ids={ids}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const recent = await sdk.bayanAlIslam.recentContents({
  lang: "ar",
  init: true,
  ids: [22184], // Optional: content IDs list
  language: "en" // Optional
});

// 7. Get website lookup variables
// HTTP Endpoint: GET https://byenah.com/{language}/Api/lookups
// Response Shape: { "data": { "categories": [...] } }
const lookups = await sdk.bayanAlIslam.lookups("en");

// 8. Search materials by title/name
// HTTP Endpoint: GET https://byenah.com/{language}/Api/name_search?name={name}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const searchResult = await sdk.bayanAlIslam.nameSearch("حصن", "ar");

// 9. Check available translation languages for a content ID
// HTTP Endpoint: GET https://byenah.com/{language}/Api/available_languages/{contentId}
// Response Shape: { "data": [ { "code": "ar", "name": "Arabic" } ] }
const availLangs = await sdk.bayanAlIslam.availableLanguages(22184, "ar");

// 10. Get specific translation of a content item
// HTTP Endpoint: GET https://byenah.com/{language}/Api/content_translation/{contentId}?language={targetLanguage}
// Response Shape: { "data": { "id": 1, "translation": "..." } }
const translation = await sdk.bayanAlIslam.contentTranslation(22184, "en", "ar");

// 11. Get translations for media or PDF attachments of a content item
// HTTP Endpoint: GET https://byenah.com/{language}/Api/attachments_translation/{contentId}?language={targetLanguage}
// Response Shape: { "data": [ { "file_url": "..." } ] }
const attachmentsTrans = await sdk.bayanAlIslam.attachmentsTranslation(22184, "en", "ar");

Al Montaka Source (Al Montaka API)

API Documentation Link: Al Montaka API

// ==========================================
// 1. Content and Comments (contents)
// ==========================================

// Get all comments for a specific content ID
// HTTP Endpoint: GET https://content.mofeed.org/Api/comments?content_id={contentId}
// Response Shape: { "message": "", "errors": [], "data": { "current_page": 1, "data": [ { "id": 10702, "comment": "..." } ] } }
const comments = await sdk.alMontaka.contents.comments(1);

// Add a new comment to a specific content item
// HTTP Endpoint: POST https://content.mofeed.org/Api/comment
// Request Body: content_id={contentId}&comment={comment}
// Response Shape: { "message": "Comment added successfully" }
const newComment = await sdk.alMontaka.contents.addComment(1, "Test comment");

// Get filtered content by category IDs
// HTTP Endpoint: GET https://content.mofeed.org/Api/content?category[0]={cat0}&category[1]={cat1}...
// Response Shape: { "message": "", "errors": [], "data": [ { "id": 1, "title": "..." } ] }
const filteredContent = await sdk.alMontaka.contents.content([1, 2]);

// ==========================================
// 2. Site Lookups and Filters (lookups)
// ==========================================

// Get target age groups
// HTTP Endpoint: GET https://content.mofeed.org/Api/age-groups
// Response Shape: { "message": "", "errors": [], "data": [ { "id": 1, "name": "From 18 to 25" } ] }
const ageGroups = await sdk.alMontaka.lookups.ageGroups();

// Get categories matching language and name filter
// HTTP Endpoint: GET https://content.mofeed.org/Api/categories?language_id={languageId}&name_cont={nameCont}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const categories = await sdk.alMontaka.lookups.categories({
  languageId: 1,
  nameCont: "General"
});

// Get publishing entities matching language and name filter
// HTTP Endpoint: GET https://content.mofeed.org/Api/entities?language_id={languageId}&name_cont={nameCont}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const entities = await sdk.alMontaka.lookups.entities({
  languageId: 1,
  nameCont: "Dar"
});

// Get expertise/scientific levels matching filter
// HTTP Endpoint: GET https://content.mofeed.org/Api/expert-levels?language_id={languageId}&name_cont={nameCont}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const expertLevels = await sdk.alMontaka.lookups.expertLevels({
  languageId: 1,
  nameCont: "Level"
});

// Get ideologies matching filter
// HTTP Endpoint: GET https://content.mofeed.org/Api/ideologies?language_id={languageId}&name_cont={nameCont}&parent_id={parentId}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const ideologies = await sdk.alMontaka.lookups.ideologies({
  languageId: 1,
  nameCont: "Sunnah",
  parentId: 0
});

// Get available languages
// HTTP Endpoint: GET https://content.mofeed.org/Api/languages
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const languages = await sdk.alMontaka.lookups.languages();

// Get/search scholars, narrators, or personalities
// HTTP Endpoint: GET https://content.mofeed.org/Api/persons?name_cont={nameCont}&page={page}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const persons = await sdk.alMontaka.lookups.persons({
  nameCont: "Muhammad", // Optional
  page: 1              // Optional
});

// Get website sections matching filter
// HTTP Endpoint: GET https://content.mofeed.org/Api/sections?language_id={languageId}&name_cont={nameCont}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const sections = await sdk.alMontaka.lookups.sections({
  languageId: 1,
  nameCont: "Section"
});

// Get tags matching filter
// HTTP Endpoint: GET https://content.mofeed.org/Api/tags?language_id={languageId}&name_cont={nameCont}
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const tags = await sdk.alMontaka.lookups.tags({
  languageId: 1,
  nameCont: "Tag"
});

// Get targeted groups of audience
// HTTP Endpoint: GET https://content.mofeed.org/Api/targeted-groups
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const targetedGroups = await sdk.alMontaka.lookups.targetedGroups();

// Get integrated YouTube channels list
// HTTP Endpoint: GET https://content.mofeed.org/Api/youtube-channels
// Response Shape: { "data": [ { "id": 1, "name": "..." } ] }
const youtubeChannels = await sdk.alMontaka.lookups.youtubeChannels();

Donation & Support

You can support the projects and efforts of The Association for Multi-lingual Islamic Content through the following official channels: