Get a single translation
Get a single #model:XCinMTfQdCrC3D3vH of all ayah.
See #endpoint:N4JAF8phDshhyrBHs endpoint to fetch available translations.
You can also include more fields of translation using fields
query string.
Path Parameters
Recitation id
Query Parameters
comma seperated fields of translation.
Possible values: >= 1
and <= 114
If you want to get translation of a specific surah.
Possible values: >= 1
and <= 30
If you want to get translation of a specific juz.
Possible values: >= 1
and <= 604
If you want to get translation of a Madani Muhsaf page
Possible values: >= 1
and <= 60
If you want to get translation of a specific hizb.
Possible values: >= 1
and <= 240
If you want to get translation of a specific Rub el Hizb.
If you want to get translation of a specific ayah.
- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 500
- 502
- 503
- 504
Successful response
Schema
- Array [
- ]
translations object[] required
Text of the translation, text could have HTML tags for formatting and footnotes.
meta object
{
"translations": [
{
"resource_id": 131,
"resource_name": "Dr. Mustafa Khattab, the Clear Quran",
"id": 903958,
"text": "In the Name of Allah—the Most Compassionate, Most Merciful.",
"verse_id": 1,
"language_id": 38,
"language_name": "english",
"verse_key": "1:1",
"chapter_id": 1,
"verse_number": 1,
"juz_number": 1,
"hizb_number": 1,
"rub_number": 1,
"page_number": 1
}
],
"meta": {
"translation_name": "string"
}
}
{
"translations": [
{
"resource_id": 131,
"text": "In the Name of Allah—the Most Compassionate, Most Merciful."
}
],
"meta": {
"translation_name": "Dr. Mustafa Khattab, the Clear Quran",
"author_name": "Dr. Mustafa Khattab"
}
}
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
}