https://github.com/the-key-software/quran_api.dart
Implementation of the Quran API based on the official documentation
https://github.com/the-key-software/quran_api.dart
android dart flutter freezed ios mobile quran typesafe web
Last synced: 4 months ago
JSON representation
Implementation of the Quran API based on the official documentation
- Host: GitHub
- URL: https://github.com/the-key-software/quran_api.dart
- Owner: the-key-software
- License: gpl-3.0
- Created: 2024-01-31T01:59:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T23:56:00.000Z (over 1 year ago)
- Last Synced: 2026-01-11T16:20:47.418Z (5 months ago)
- Topics: android, dart, flutter, freezed, ios, mobile, quran, typesafe, web
- Language: Dart
- Homepage: https://pub.dev/packages/quran_api
- Size: 564 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-islamic-open-source-apps - quran_api.dart
README
# Quran API
This package provides a Dart and Flutter implementation of the Quran API based on the [official documentation](https://api-docs.quran.com/docs/category/quran.com-api).
## Swagger (OpenApi) Documentation
- https://github.com/quran/qf-api-docs/blob/main/openAPI/quran.com/v4.json
- https://raw.githubusercontent.com/quran/qf-api-docs/refs/heads/main/openAPI/quran.com/v4.json
## Usage
```dart
import "package:quran_api/quran_api.dart";
Future 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:
```yaml
dependencies:
quran_api:
```
Then, run `flutter pub get` in your terminal.
or run this command:
```shell
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](./LICENSE)