Quran API #

This package provides a Dart and Flutter implementation of the Quran API based on the official documentation.

Swagger (OpenApi) Documentation #

• https://github.com/quran/qf-api-docs/blob/main/openAPI/quran.com/v4.json
• https://rawgit.flutter-io.cn/quran/qf-api-docs/refs/heads/main/openAPI/quran.com/v4.json

Usage #

import "package:quran_api/quran_api.dart";

Future<void> main() async {
  final value = await QuranApi.instance.search.search(
    queries: SearchQueries(q: "مدهامتان"),
  );

  print(value.data.search.query);
}

Getting started #

In your pubspec.yaml file, add the following dependency:

dependencies:
  quran_api: 

Then, run flutter pub get in your terminal.

or run this command:

flutter pub add quran_api

Additional information #

This package is still in development, and the API is subject to change. feel free to contribute to this package.

License #

Read more about the license here