By Hizb number
Get all verses from a specific Hizb( half(1-60).
Path Parameters
Possible values: >= 1
and <= 60
Hizb number(1-60)
Query Parameters
Default value: en
Language to fetch word translation in specific language.
Possible values: [true
, false
]
Default value: true
Include words of each ayah?
0 or false will not include words.
1 or true will include the words.
comma separated ids of translations to load for each ayah.
Id of recitation if you want to load audio of each ayah.
Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.
Comma separated list of word fields if you want to add more fields for each word.
Comma separated list of translation fields if you want to add more fields for each translation.
comma separated list of ayah fields.
Default value: 1
For paginating within the result
Possible values: >= 1
and <= 50
Default value: 10
records per api call, you can get maximum 50 records.
- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 500
- 502
- 503
- 504
Successful response
Schema
verses object[]
pagination object
{
"verses": [
{
"id": 1,
"chapter_id": 1,
"verse_number": 1,
"verse_key": "1:1",
"verse_index": 1,
"text_uthmani": "بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ",
"text_uthmani_simple": "بسم الله الرحمن الرحيم",
"text_imlaei": "بِسْمِ اللَّهِ الرَّحْمَٰنِ الرَّحِيمِ",
"text_imlaei_simple": "بسم الله الرحمن الرحيم",
"text_indopak": "بِسۡمِ اللهِ الرَّحۡمٰنِ الرَّحِيۡمِ",
"text_uthmani_tajweed": "بِسْمِ <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>",
"juz_number": 1,
"hizb_number": 1,
"rub_number": 1,
"page_number": 1,
"image_url": "//c22506.r6.cf1.rackcdn.com/1_1.png",
"image_width": 675,
"words": [
{
"id": 1,
"position": 1,
"audio_url": "wbw/001_001_001.mp3",
"char_type_name": "word",
"translation": {
"text": "In (the) name",
"language_name": "english"
},
"transliteration": {
"text": "bis'mi",
"language_name": "english"
}
}
]
}
],
"pagination": {
"per_page": 1,
"current_page": 1,
"next_page": 2,
"total_pages=": 7,
"total_records=": 7
}
}
{
"verses": [
{
"id": 1,
"verse_number": 1,
"page_number": 1,
"verse_key": "1:1",
"juz_number": 1,
"hizb_number": 1,
"rub_el_hizb_number": 1,
"sajdah_type": null,
"sajdah_number": null,
"words": [
{
"id": 1,
"position": 1,
"audio_url": "wbw/001_001_001.mp3",
"char_type_name": "word",
"line_number": 2,
"page_number": 1,
"code_v1": "ﭑ",
"translation": {
"text": "In (the) name",
"language_name": "english"
},
"transliteration": {
"text": "bis'mi",
"language_name": "english"
}
}
],
"translations": [
{
"resource_id": 131,
"text": "In the Name of Allah—the Most Compassionate, Most Merciful."
}
],
"tafsirs": [
{
"id": 82641,
"language_name": "english",
"name": "Tafsir Ibn Kathir",
"text": "<h2 class=\"title\">Which was revealed in Makkah</h2><h2 class=\"title\">The Meaning of Al-Fatihah and its Various Names</h2>"
}
]
}
],
"pagination": {
"per_page": 1,
"current_page": 1,
"next_page": 2,
"total_pages": 7,
"total_records": 7
}
}
Will be returned when the request is invalid e.g. request is missing required headers or with invalid query parameters.
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "The request is missing required headers or is invalid",
"type": "invalid_request",
"success": false
}
Will be returned when the request is unauthorized.
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "The request requires user authentication",
"type": "unauthorized",
"success": false
}
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.
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "The server understood the request, but refuses to authorize it",
"type": "forbidden",
"success": false
}
Not Found. The resource being accessed does not exist.
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "The requested resource could not be found",
"type": "not_found",
"success": false
}
Validation Error. The request includes one or more invalid params. Please check the request params and try again.
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "The request was well-formed but was unable to be followed due to semantic errors",
"type": "unprocessable_entity",
"success": false
}
Rate-limit exceeded
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "Too many requests, please try again later",
"type": "rate_limit_exceeded",
"success": false
}
Server Error. Something went wrong, try again later.
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "The server encountered an internal error and was unable to complete your request",
"type": "internal_server_error",
"success": false
}
Bad Gateway
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
"type": "bad_gateway",
"success": false
}
Service Unavailable
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
"type": "service_unavailable",
"success": false
}
Gateway Timeout
Schema
Possible values: [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": "string",
"type": "gateway_timeout",
"success": true
}
{
"message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
"type": "gateway_timeout",
"success": false
}
GET /verses/by_hizb/:hizb_number
Authorization
name: x-auth-tokentype: apiKeydescription: The JWT access token required for accessing the endpoints.in: header
name: x-client-idtype: apiKeydescription: Your client Idin: header
Request
Request
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/verses/by_hizb/:hizb_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/verses/by_hizb/:hizb_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/verses/by_hizb/:hizb_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/verses/by_hizb/:hizb_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/verses/by_hizb/:hizb_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/verses/by_hizb/:hizb_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/verses/by_hizb/:hizb_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/verses/by_hizb/:hizb_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/verses/by_hizb/:hizb_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'