| description |
content |
Successful response |
| application/json |
| schema |
example |
| type |
properties |
object |
| verses |
pagination |
| type |
items |
array |
| title |
required |
type |
properties |
example |
Verse |
hizb_number |
id |
juz_number |
page_number |
rub_number |
verse_key |
verse_number |
|
object |
| id |
chapter_id |
verse_number |
verse_key |
verse_index |
text_uthmani |
text_uthmani_simple |
text_imlaei |
text_imlaei_simple |
text_indopak |
text_uthmani_tajweed |
juz_number |
hizb_number |
rub_number |
page_number |
ruku_number |
manzil_number |
image_url |
image_width |
words |
audio |
translations |
code_v1 |
code_v2 |
v1_page |
v2_page |
|
| type |
description |
integer |
Chapter number of this verse |
|
|
| type |
description |
string |
key of the verse, key is generated using chapter number and ayah number. e.g 1:1 is first ayah of first surah. |
|
|
| type |
description |
string |
Ayah text in Uthmani Script.
Uthmani script is an old-fashion script used by the third Caliph, Uthman, to produce the first standard quran manuscript. |
|
| type |
description |
string |
Uthmani script diacritic marks |
|
| type |
description |
string |
Ayah text in Imla'ei script.
Imla'ei script, is the modern Arabic writing style which is currently in use. |
|
|
|
|
|
|
|
| maximum |
minimum |
type |
description |
604 |
1 |
integer |
page_number is deprecated, please use `v1_page` instead. |
|
|
|
|
|
| type |
items |
array |
| title |
required |
type |
properties |
example |
Word |
audio_url |
char_type_name |
position |
translation |
transliteration |
|
object |
| id |
position |
text_uthmani |
text_indopak |
text_imlaei |
verse_key |
page_number |
line_number |
audio_url |
location |
char_type_name |
code_v1 |
code_v2 |
translation |
transliteration |
v1_page |
v2_page |
|
| type |
description |
integer |
Word position within ayah |
|
| type |
description |
string |
Word text in Uthmanic script |
|
|
| type |
description |
string |
Word text in simple/Imlaei script |
|
|
| maximum |
minimum |
type |
description |
604 |
1 |
integer |
page_number is deprecated, please use `v1_page` instead. |
|
| type |
description |
integer |
Line number in the Mushaf for this word |
|
|
|
|
| type |
description |
string |
glyph code that you can use to render the word using QCF v1 font. |
|
| type |
description |
string |
glyph code that you can use to render the word using QCF v2 font. |
|
|
|
| maximum |
minimum |
type |
description |
604 |
1 |
integer |
Madani Mushaf Page number for v1 font. If `v1_page` value is 2, that means you'll use page 2 font file to render this word using v1 glyph codes. |
|
| maximum |
minimum |
type |
description |
604 |
1 |
integer |
Madani Mushaf Page number for v2 font. If `v2_page` value is 2, that means you'll use page 2 font file to render this ayah using v2 glyph codes. |
|
|
| id |
position |
text_uthmani |
text_indopak |
text_imlaei |
verse_key |
page_number |
line_number |
audio_url |
location |
char_type_name |
code_v1 |
translation |
transliteration |
1 |
1 |
بِسْمِ |
بِسۡمِ |
بِسْمِ |
1:1 |
1 |
2 |
wbw/001_001_001.mp3 |
1:1:1 |
word |
ﭑ |
| text |
language_name |
In (the) name |
english |
|
| text |
language_name |
bis'mi |
english |
|
|
|
|
| title |
type |
properties |
example |
required |
AudioFile |
object |
|
|
|
|
| type |
items |
array |
| title |
required |
type |
properties |
example |
Translation |
|
object |
| resource_id |
resource_name |
id |
text |
verse_id |
language_id |
language_name |
verse_key |
chapter_id |
verse_number |
juz_number |
hizb_number |
rub_number |
page_number |
|
|
|
| type |
description |
string |
Text of the translation, text could have HTML tags for formatting and footnotes. |
|
|
|
|
|
|
|
|
|
|
|
|
| resource_id |
resource_name |
id |
text |
verse_id |
language_id |
language_name |
verse_key |
chapter_id |
verse_number |
juz_number |
hizb_number |
rub_el_hizb_number |
page_number |
ruku_number |
manzil_number |
slug |
131 |
Dr. Mustafa Khattab, the Clear Quran |
903958 |
In the Name of Allah—the Most Compassionate, Most Merciful. |
1 |
38 |
english |
1:1 |
1 |
1 |
1 |
1 |
1 |
1 |
1 |
1 |
tafsir-ibn-kathir |
|
|
|
| type |
description |
string |
Glyphs codes for QCF v1 fonts |
|
| type |
description |
string |
Glyphs codes for QCF v2 fonts |
|
| maximum |
minimum |
type |
description |
604 |
1 |
integer |
Madani Mushaf Page number for v1 font. If `v1_page` value is 2, that means you'll use page 2 font file to render this ayah using v1 glyph codes. |
|
| maximum |
minimum |
type |
description |
604 |
1 |
integer |
Madani Mushaf Page number for v2 font. If `v2_page` value is 2, that means you'll use page 2 font file to render this ayah using v2 glyph codes. |
|
|
| id |
chapter_id |
verse_number |
verse_key |
verse_index |
text_uthmani |
text_uthmani_simple |
text_imlaei |
text_imlaei_simple |
text_indopak |
text_uthmani_tajweed |
juz_number |
hizb_number |
rub_el_hizb_number |
page_number |
image_url |
image_width |
words |
1 |
1 |
1 |
1:1 |
1 |
بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ |
بسم الله الرحمن الرحيم |
بِسْمِ اللَّهِ الرَّحْمَٰنِ الرَّحِيمِ |
بسم الله الرحمن الرحيم |
بِسۡمِ اللهِ الرَّحۡمٰنِ الرَّحِيۡمِ |
بِسْمِ <tajweed class=ham_wasl>ٱ</tajweed>للَّهِ <tajweed class=ham_wasl>ٱ</tajweed><tajweed class=laam_shamsiyah>ل</tajweed>رَّحْمَ<tajweed class=madda_normal>ـٰ</tajweed>نِ <tajweed class=ham_wasl>ٱ</tajweed><tajweed class=laam_shamsiyah>ل</tajweed>رَّح<tajweed class=madda_permissible>ِي</tajweed>مِ <span class=end>١</span> |
1 |
1 |
1 |
1 |
//c22506.r6.cf1.rackcdn.com/1_1.png |
675 |
| id |
position |
audio_url |
char_type_name |
translation |
transliteration |
1 |
1 |
wbw/001_001_001.mp3 |
word |
| text |
language_name |
In (the) name |
english |
|
| text |
language_name |
bis'mi |
english |
|
|
|
|
|
|
| title |
type |
properties |
example |
Pagination |
object |
| per_page |
current_page |
next_page |
total_pages= |
total_records= |
| type |
description |
integer |
Entries per api call |
|
|
| type |
description |
integer |
Next page in paginated result |
|
| type |
description |
integer |
Total number of pages |
|
|
|
| per_page |
current_page |
next_page |
total_pages= |
total_records= |
1 |
1 |
2 |
7 |
7 |
|
|
|
|
| verses |
pagination |
| id |
verse_number |
page_number |
verse_key |
juz_number |
hizb_number |
rub_el_hizb_number |
sajdah_type |
sajdah_number |
words |
translations |
tafsirs |
1 |
1 |
1 |
1:1 |
1 |
1 |
1 |
|
|
| id |
position |
audio_url |
char_type_name |
line_number |
page_number |
code_v1 |
translation |
transliteration |
1 |
1 |
wbw/001_001_001.mp3 |
word |
2 |
1 |
ﭑ |
| text |
language_name |
In (the) name |
english |
|
| text |
language_name |
bis'mi |
english |
|
|
|
| resource_id |
text |
131 |
In the Name of Allah—the Most Compassionate, Most Merciful. |
|
|
| id |
language_name |
name |
text |
82641 |
english |
Tafsir Ibn Kathir |
<h2 class="title">Which was revealed in Makkah</h2><h2 class="title">The Meaning of Al-Fatihah and its Various Names</h2> |
|
|
|
|
| per_page |
current_page |
next_page |
total_pages |
total_records |
1 |
1 |
2 |
7 |
7 |
|
|
|
|
|
| description |
content |
Will be returned when the request is invalid e.g. request is missing required headers or with invalid query parameters. |
| application/json |
| schema |
example |
| title |
type |
properties |
invalidRequestResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The request is missing required headers or is invalid |
invalid_request |
false |
|
|
|
|
| description |
content |
Will be returned when the request is unauthorized. |
| application/json |
| schema |
example |
| title |
type |
properties |
unauthorizedResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The request requires user authentication |
unauthorized |
false |
|
|
|
|
| description |
content |
Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions. |
| application/json |
| schema |
example |
| title |
type |
properties |
forbiddenResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server understood the request, but refuses to authorize it |
forbidden |
false |
|
|
|
|
| description |
content |
Not Found. The resource being accessed does not exist. |
| application/json |
| schema |
example |
| title |
type |
properties |
notFoundResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The requested resource could not be found |
not_found |
false |
|
|
|
|
| description |
content |
Validation Error. The request includes one or more invalid params. Please check the request params and try again. |
| application/json |
| schema |
example |
| title |
type |
properties |
unprocessableEntityResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The request was well-formed but was unable to be followed due to semantic errors |
unprocessable_entity |
false |
|
|
|
|
| description |
content |
Rate-limit exceeded |
| application/json |
| schema |
example |
| title |
type |
properties |
rateLimitExceededResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
Too many requests, please try again later |
rate_limit_exceeded |
false |
|
|
|
|
| description |
content |
Server Error. Something went wrong, try again later. |
| application/json |
| schema |
example |
| title |
type |
properties |
internalServerErrorResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server encountered an internal error and was unable to complete your request |
internal_server_error |
false |
|
|
|
|
| description |
content |
Bad Gateway |
| application/json |
| schema |
example |
| title |
type |
properties |
badGatewayResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server was acting as a gateway or proxy and received an invalid response from the upstream server |
bad_gateway |
false |
|
|
|
|
| description |
content |
Service Unavailable |
| application/json |
| schema |
example |
| title |
type |
properties |
serviceUnavailableResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server is currently unable to handle the request due to a temporary overload or scheduled maintenance |
service_unavailable |
false |
|
|
|
|
| description |
content |
Gateway Timeout |
| application/json |
| schema |
example |
| title |
type |
properties |
gatewayTimeoutResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server was acting as a gateway or proxy and did not receive a timely response from the upstream server |
gateway_timeout |
false |
|
|
|
|