@quranjs/api
v2.1.0
Published
Official library for fetching authentic, scholarly verified Quran data from Quran.com.
Readme
@quranjs/api
A JavaScript/TypeScript library for fetching authentic, scholarly verified Quran data from the Quran.com API.
Unlike other sources, this SDK connects you directly to the Quran Foundation—ensuring a trusted, highly scrutinized source of reliable content, including properly licensed translations, tafsir, and supplementary materials.
Works seamlessly in both Node.js and browser environments.
Built by the Quran Foundation — the team behind Quran.com
Installation
# npm
npm install @quranjs/api
# yarn
yarn add @quranjs/api
# pnpm
pnpm add @quranjs/apiQuick Start
import { quran } from '@quranjs/api';
// Get all chapters
const chapters = await quran.v4.chapters.findAll();
// Get a specific chapter
const surah = await quran.v4.chapters.findById(1);
// Get verses of a chapter
const verses = await quran.v4.verses.findByChapter(1);
// Search the Quran
const results = await quran.v4.search.search('mercy');Documentation
For complete documentation, guides, and API reference, visit:
Features
- 🚀 Full TypeScript support
- 🌐 Works in Node.js and browsers
- ✅ Scholarly verified data
- 📖 Access chapters, verses, juzs, and more
- 🔍 Full-text search
- 🎧 Audio recitations
- 🌍 Multiple verified translations and languages
Links
- Quran Foundation — Our mission to make the Quran accessible to everyone
- API Documentation — Full API reference
- GitHub Repository — Source code and issues
License
MIT © Quran Foundation
