widequran

Async Rust SDK for the WideQuran API. Access all 114 surahs, 6,236 ayahs across multiple translations, hadith collections (Bukhari, Muslim, and more), tafsir commentaries (Ibn Kathir, Jalalayn), Quranic people and prophets, topics, and Islamic glossary terms.

Built on widequran.com -- a comprehensive Quran encyclopedia with full-text search, Arabic text with transliteration, and scholarly commentary for students and developers.

Install

[dependencies]
widequran = "0.1"
tokio = { version = "1", features = ["full"] }

Or via the command line:

cargo add widequran tokio --features tokio/full

Quick Start

use widequran::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    // List all 114 surahs
    let surahs = client.list_surahs().await?;
    println!("Total surahs: {:?}", surahs.count);

    // Get surah Al-Fatihah
    let fatihah = client.get_surah("al-fatihah").await?;
    println!("Surah: {:?}", fatihah.name);

    // Search ayahs across the Quran
    let results = client.search("mercy").await?;
    println!("Found {:?} results for 'mercy'", results.count);

    Ok(())
}

What You Can Do

Surahs and Ayahs

The Quran contains 114 surahs (chapters) with 6,236 ayahs (verses). Surahs are classified as Meccan (revealed in Mecca) or Medinan (revealed in Medina). Each ayah is available in Arabic script with multiple English translations.

// List all surahs
let surahs = client.list_surahs().await?;

// Get a specific surah
let baqarah = client.get_surah("al-baqarah").await?;

// Get a specific ayah by ID
let ayah = client.get_ayah(1).await?;

// Search ayahs
let results = client.search("paradise").await?;

Juz and Hizb Divisions

The Quran is divided into 30 juz (parts) for structured reading, each further divided into hizb (half-juz) markers. These divisions support the tradition of completing the Quran during Ramadan.

// List all 30 juz
let juz = client.list_juz().await?;

// Get a specific juz
let juz_1 = client.get_juz(1).await?;

// List hizb markers
let hizbs = client.list_hizbs().await?;

Tafsir (Commentary)

Classical and modern tafsir commentaries provide scholarly interpretation. Available collections include Ibn Kathir, Jalalayn, and others, offering verse-by-verse exegesis.

// List tafsir collections
let tafsirs = client.list_tafsirs().await?;

// Get a specific tafsir
let ibn_kathir = client.get_tafsir("ibn-kathir").await?;

// List tafsir entries
let entries = client.list_tafsir_entries().await?;

Hadith Collections

Hadith (prophetic traditions) from the six canonical collections -- Sahih al-Bukhari, Sahih Muslim, Sunan Abu Dawud, Sunan al-Tirmidhi, Sunan al-Nasa'i, and Sunan Ibn Majah -- with grading (sahih, hasan, da'if).

// List hadith collections
let collections = client.list_hadith_collections().await?;

// Get hadiths from Bukhari
let hadiths = client.list_hadiths(Some("bukhari")).await?;

// Search hadiths
let results = client.search_hadith("prayer").await?;

People and Prophets

The Quran mentions 25 prophets by name, from Adam to Muhammad. WideQuran catalogues each prophet with their Arabic name, story references, and the surahs in which they appear.

let people = client.list_people().await?;
let ibrahim = client.get_person("ibrahim").await?;

Topics and Glossary

Topics group ayahs thematically -- mercy, justice, prayer, charity, patience, and more. The glossary defines Arabic Islamic terms with transliterations, covering words like taqwa (God-consciousness), iman (faith), ihsan (excellence), salah (prayer), and zakat (charity).

let topics = client.list_topics().await?;
let glossary = client.list_glossary().await?;
let term = client.get_glossary_term("taqwa").await?;

API Methods

All methods are async and return Result<T, WideQuranError>.

Custom Base URL

let client = Client::with_base_url("http://localhost:8000/api/v1/quran");

WideHoly Scripture Platform

Part of the WideHoly multi-religion scripture platform.

Also Available

Learn More About the Quran

• Scripture: Surahs · Translations
• Reference: People · Topics · Glossary
• Study: Tafsir · Hadith Collections · Juz Divisions
• Tools: Search · Developer Docs
• API: Developer Docs · OpenAPI Spec

License

MIT