https://github.com/quran/api-js
Quran Foundation's Official JS SDK https://npmjs.com/package/@quranjs/api
https://github.com/quran/api-js
javascript quran quran-api-client quranjs
Last synced: about 2 months ago
JSON representation
Quran Foundation's Official JS SDK https://npmjs.com/package/@quranjs/api
- Host: GitHub
- URL: https://github.com/quran/api-js
- Owner: quran
- License: mit
- Created: 2022-03-28T14:29:28.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-28T03:25:38.000Z (2 months ago)
- Last Synced: 2026-04-28T03:27:27.476Z (2 months ago)
- Topics: javascript, quran, quran-api-client, quranjs
- Language: TypeScript
- Homepage: https://api-docs.quran.foundation/docs/sdk/javascript
- Size: 2.64 MB
- Stars: 49
- Watchers: 2
- Forks: 12
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-islamic-open-source-apps - api-js
README
A library for fetching quran data from the [quran.com API][qdc-api]. This library also works on both Node.js and the browser.
[Checkout Docs][docs]
[![Build Status][build-badge]][build]
[![MIT License][license-badge]][license]
[![NPM Version][npm-badge]][npm]
[![Minziped Size][size-badge]][npm]
[![NPM Monthly downloads][downloads-badge]][npm]
## Installation
using npm:
```ssh
npm install @quranjs/api
```
using yarn:
```ssh
yarn add @quranjs/api
```
## Getting Started
you can visit the [docs][docs] for more details.
[qdc-api]: https://api-docs.quran.foundation/docs/category/content-apis
[docs]: https://api-docs.quran.foundation/docs/sdk/javascript
[build-badge]: https://github.com/quran/api-js/workflows/CI/badge.svg
[build]: https://github.com/quran/api-js/actions?query=workflow%3ACI
[license-badge]: https://badgen.net/github/license/quranjs/api
[license]: https://github.com/quran/api-js/blob/main/LICENSE
[npm]: https://www.npmjs.com/package/@quranjs/api
[npm-badge]: https://badgen.net/npm/v/@quranjs/api
[downloads-badge]: https://img.shields.io/npm/dm/@quranjs/api.svg
[size-badge]: https://badgen.net/packagephobia/publish/@quranjs/api