alquran_cloud

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

The alquran_cloud package is an unofficial Dart client wrapper for the quran.cloud API, enabling developers to easily access and consume the Holy Quran in various formats. It provides a clean, intuitive interface to retrieve Quranic verses, chapters, translations, and tafsir (exegesis). Designed for cross-platform use, it supports Android, iOS, Web, macOS, Windows, and Linux. The package simplifies integration into Flutter apps that require Quranic content, making it ideal for religious, educational, or devotional applications.

Use cases

Integrating Quranic text into mobile apps
Displaying translations and tafsir
Building Quran reading and learning tools
Creating multilingual Islamic education apps
Enabling offline Quran access with caching

Key features

Simple API for fetching Quran data
Supports multiple translations and recitations
Cross-platform compatibility
Built-in error handling
Lightweight and easy to integrate

Suitable for

Flutter developers building Islamic apps
Educational app creators
Religious content platforms
Apps requiring accurate Quranic references
Developers using the quran.cloud API

Considerations

Requires internet connection for live data
Limited to features provided by quran.cloud API
No official endorsement from Quran.cloud
May need additional logic for offline functionality
Dependent on external API stability

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Alquran Cloud

unofficial api wrapper for the free islamic api alquran.cloud usage

void main(List<String> args) async {
  /// to enable logs (disabled by default)
  quran_cloud.quranCloud.enableLogs = true;

  /// use edition identifer to determine which edition of the quran to get
  final allEditions = await quran_cloud.getAllEditions();

  /// also you can query the edition you want
  final editionsQuery = await quran_cloud.getAllEditions(
    format: 'text', // or `audio`
    language: 'ar', // use .getEditionSupportedLanguages(); to get the all available languages
    type: 'quran', // user .getEditionTypes() to get all available types
  );

  final quran = await quran_cloud.getQuranByEdition(allEditions.first);

  /// get surah by number and edition
  final surah = await quran_cloud.getSurahByEdition(1, editionsQuery.first);

  /// get aya by number and edition
  final aya = await quran_cloud.getAyaByNumber(2, editionsQuery.first);

  print(aya.text); // الْحَمْدُ لِلَّهِ رَبِّ الْعَالَمِينَ

Endpoints

[x] Editions
[x] Quran
[x] Juz
[x] Surah
[x] Aya
[ ] Manzil
[ ] Ruku
[ ] Page
[ ] Hizb
[ ] Quarter
[ ] Sajda
[ ] Meta
[x] CDM (audio/image)

Features

[ ] cache (awaiting this PR https://github.com/hurshi/dio-http-cache/pull/84)
[ ] prayer times
[ ] docs
[ ] re-tray

Search categories, packages and repositories

Install package