README.md

Quran API

This is a simple API that provides the verses of the Quran. Unlike other APIs, this API doesn't require any authentication. It's free and open for everyone without any rate limits.

Documentation

The documentation for this API can be found here.

Host it yourself

Docker

docker build -t quran-api .
docker run -p 3000:3000 quran-api

One line command

docker build -t quran-api . && docker run -p 3000:3000 quran-api

Node.js

git clone https://github.com/The-Quran-Project/Quran-API/ --depth 1
cd Quran-API
npm i --loglevel=error
python public/main.py
npm run build
npx -y serve@latest out

One line command:

git clone https://github.com/The-Quran-Project/Quran-API/ --depth 1 && cd Quran-API && npm i --loglevel=error &&  python public/main.py && npm run build && npx -y serve@latest out

How it works

This API serves static JSON files that contain the verses of the Quran. /api/ folder is generated at build time.

The data is taken from Quran.com.

Repo Activity

Star History