Digital Quran
  • Introduction
  • Standards & conventions
    • Quran
    • Naming convention
    • Translation files: description
    • Translation files: examples
    • Translation texts
    • Quranic Text Markup Language (QTML)
    • Code examples
  • Content & Releases
    • Quran text
    • Font (Kitab)
    • Meta data
    • Translations
    • Tafsirs
    • Word-by-word translations
  • FAQ
    • How can I contribute?
    • Why Quran Academy website has more data than Digital Quran?
    • What if I found a mistake or a typo in a translation?
    • Who is using this standard?
    • How can I use content?
  • API
    • Getting started
    • Authentication
    • Creating an application
    • Limits
    • Errors
    • Pagination
    • CORS
    • Public endpoints
      • Languages
      • Surahs
      • Ayahs
      • Words
      • Translations
  • Other
    • Contributors
Powered by GitBook
On this page

Was this helpful?

  1. API

Getting started

PreviousHow can I use content?NextAuthentication

Last updated 3 years ago

Was this helpful?

API is currently under development. Stay tuned to the on GitHub.

First of all, you need to .

After registering the app you will receive credentials for .

Base API URL is .

General concepts

  • API works exclusively over HTTPS.

  • Every API request must include the "Language" header with the code of a language. See the .

  • Every request to the API must be authenticated.

  • API always returns HTTP code 200 if the request is correctly handled by the server.

  • API returns data in JSON format.

project repository
create an application
authentication
https://digital-quran.quranacademy.org
list of available languages