Coder Social home page Coder Social logo

quran-api's Introduction

Quran API

In the name of God, who has guided me to do this work

This repo contains collection of Quran Translations and to allow development of websites, apps etc, it is structured in REST Architectural Style. The purpose of this repo is to spread the word of God everywhere in the world

Features:

  • Free & Blazing Fast response
  • No Rate limits
  • 90+ languages & 440+ Translations including Latin/roman translations

URL Structure:

https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@{apiVersion}/{endpoint}

Formats:

The Endpoints Supports HTTP GET Method and returns the data in two formats:

/{endpoint}.json

/{endpoint}.min.json

The above formats also work for fallback i.e if .min.json link fails, you can use .json link and vice versa

Warning: You should include fallback mechanism in your code, to avoid issues

Endpoints:

  • /editions

Lists all the available editions in prettified json format:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions.json

Get a minified version of it:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions.min.json

  • /editions/{editionName}

Get the whole quran/quran translation:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions/ben-muhiuddinkhan.json

Get a latin(roman) script version of it by adding -la:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions/ben-muhiuddinkhan-la.json

Get a latin(roman) script with diacritical marks by adding -lad:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions/ben-muhiuddinkhan-lad.json

  • /editions/{editionName}/{ChapterNo}

Get the whole chapter 5:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions/ben-muhiuddinkhan-la/5.json

Get the whole chapter 5 in minified format:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions/ben-muhiuddinkhan-la/5.min.json

  • /editions/{editionName}/{ChapterNo}/{VerseNo}

Get Chapter 5 verse 10:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions/ben-muhiuddinkhan-lad/5/10.json

  • /editions/{editionName}/juzs/{juzNo}

Get juz 3:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions/ben-muhiuddinkhan-lad/juzs/3.json

Similarly:

  • /editions/{editionName}/rukus/{rukuNo}

  • /editions/{editionName}/pages/{pageNo}

  • /editions/{editionName}/manzils/{manzilNo}

  • /editions/{editionName}/maqras/{maqraNo}

  • /info

Get all the details about quran such as number of juzs,sajdas, rukus etc in quran
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/info.json

  • /fonts

Lists arabic fonts available:
https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/fonts.json

Displaying Text:

  • Use Arabic Fonts to display the Quran text. In case the font shows few tofu characters, then use fonts with -full suffix which has complete Arabic Unicode Support.
    Refer font-full to know more.

  • Use Google Noto Fonts to display the translation. By default OS doesn't have font installed for every language. So you will have to use fonts for few languages such as Burmese etc, to show properly. Otherwise you will end up with tofu characters.

Languages Available:

By the mercy of God, there are 98 different language translations available and a collection of 440+ translations. Few of the translations were OCRed and may contain mistakes. Please do report the mistakes.

Contribution:

Without your contribution, this repo won't survive, whenever you find any issue, don't just fix it at your end, please let me Know, so that I can also fix it and people can benefit from it, incase of any question, issue or problems etc
you can let me Know

  • Please help by adding new translations to this repo, you can share me the translation here

or

  • Read Contribute to add/update the translation directly to this repo

Download: Here

Authenticity:

I have taken care to not include any controversial authors, for example: 'Rashad Khalifa' , because there are chances that the translation may contain opinions of the author and not the meaning of the verse. The Ahmaddiya community has done great work in translating the quran to many different languages of the world. May God reward them with guidance. But I cannot take those translations also because the verses such as those talking about Jesus (4:157) usually have opinions of the author of what actually happened to Jesus etc.

I might have mistakenly added a few of them. In case you find any translation whose authenticity could be questioned, please let me know at here .After verifying the claims, I remove the translation

Any Issues: Raise here

Demo:

Projects using Quran API:

Other Similar Projects:

Share:

Please Share this repo with your fellow mates and Star this repo by clicking on ⭐ button above ↗️

Donation:

Even though I worked very hard on this project, I will not ask donation for myself. I will take the reward from God in this world and the next, may God accept my work.

But what I ask you is to donate directly to the authors and Islamic/dawah publishers who have worked so hard to make these translations, so that the word of God could spread around the world and people will know about the one who created them. Here is the Editions and References list, you might have to Google to get more details about them.

References:

All the open source projects and dawah/Islamic organizations

Please see Editions and References




✏️Improve this page

quran-api's People

Contributors

fawazahmed0 avatar mend-bolt-for-github[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.