Get paginated tafsir records

Get a paginated list of ayah for the requested tafsir.

See /resources/tafsirs endpoint to fetch available tafsirs.

You can also include more fields of tafsir using fields query string.

Path Parameters

tafsir_id number required

tafsir id

Query Parameters

fields string

comma separated fields of tafsir.

chapter_number integer

Possible values: >= 1 and <= 114

If you want to get tafsir of a specific surah.

juz_number integer

Possible values: >= 1 and <= 30

If you want to get tafsir of a specific juz.

page_number integer

Possible values: >= 1 and <= 604

If you want to get tafsir of a Madani Mushaf page

hizb_number integer

Possible values: >= 1 and <= 60

If you want to get tafsir of a specific hizb.

rub_el_hizb_number integer

Possible values: >= 1 and <= 240

If you want to get tafsir of a specific Rub el Hizb.

manzil_number integer

Possible values: >= 1 and <= 7

If you want to get tafsir of a specific manzil.

ruku_number integer

Possible values: >= 1 and <= 558

If you want to get tafsir of a specific ruku.

verse_key string

If you want to get tafsir of a specific ayah.

page integer

Possible values: >= 1

Default value: 1

For paginating within the result.

per_page any

Records per API call. Defaults to 10 and is capped at 50. Use all to request all available records up to the maximum of 50.

limit any

Alias for per_page. Defaults to 10 and is capped at 50. Use all to request all available records up to the maximum of 50.

Responses

Successful response

application/json

Schema

Example (from schema)

default_success

chapter_filter

verse_key_filter

Schema

tafsirs object[] required

Array [

id integer

resource_id integer

verse_id integer

language_id integer

text string

language_name string

resource_name string

verse_key string

chapter_id integer

verse_number integer

juz_number integer

hizb_number integer

rub_el_hizb_number integer

page_number integer

ruku_number integer

manzil_number integer

slug string

]

meta object

tafsir_name string

author_name string nullable

pagination object required

per_page integer

Entries per api call

current_page integer

Current page in paginated result

next_page integer nullable

Next page in paginated result

total_pages integer

Total number of pages

total_records integer

{
  "tafsirs": [
    {
      "id": 82641,
      "resource_id": 169,
      "verse_id": 1,
      "language_id": 38,
      "text": "<p>Bismillah is a verse of the Holy Qur'an.</p>",
      "language_name": "english",
      "resource_name": "Tafsir Ibn Kathir",
      "verse_key": "1:1",
      "chapter_id": 1,
      "verse_number": 1,
      "juz_number": 1,
      "hizb_number": 1,
      "rub_el_hizb_number": 1,
      "page_number": 1,
      "ruku_number": 1,
      "manzil_number": 1,
      "slug": "tafsir-ibn-kathir"
    }
  ],
  "meta": {
    "tafsir_name": "string",
    "author_name": "string"
  },
  "pagination": {
    "per_page": 1,
    "current_page": 1,
    "next_page": 2,
    "total_pages": 7,
    "total_records": 7
  }
}

Successful response

{
  "tafsirs": [
    {
      "resource_id": 169,
      "text": "<h2 class=\"title\">Which was revealed in Makkah</h2><h2 class=\"title\">The Meaning of Al-Fatihah and its Various Names</h2><p>This Surah is called</p><p>-        Al-Fatihah, that is, the Opener of the Book, the Surah with which prayers are begun."
    }
  ],
  "meta": {
    "tafsir_name": "Tafsir Ibn Kathir",
    "author_name": "Hafiz Ibn Kathir"
  },
  "pagination": {
    "per_page": 10,
    "current_page": 1,
    "next_page": 2,
    "total_pages": 624,
    "total_records": 6236
  }
}

Tafsir records for a chapter

{
  "tafsirs": [
    {
      "id": 82641,
      "resource_id": 169,
      "verse_id": 1,
      "language_id": 38,
      "text": "<p>Bismillah is a verse of the Holy Qur'an.</p>",
      "language_name": "english",
      "resource_name": "Tafsir Ibn Kathir",
      "verse_key": "1:1",
      "chapter_id": 1,
      "verse_number": 1,
      "juz_number": 1,
      "hizb_number": 1,
      "rub_el_hizb_number": 1,
      "page_number": 1,
      "ruku_number": 1,
      "manzil_number": 1,
      "slug": "tafsir-ibn-kathir"
    }
  ],
  "meta": {
    "tafsir_name": "Tafsir Ibn Kathir",
    "author_name": "Hafiz Ibn Kathir",
    "filters": {
      "chapter_number": 1
    }
  },
  "pagination": {
    "per_page": 10,
    "current_page": 1,
    "next_page": null,
    "total_pages": 1,
    "total_records": 7
  }
}

Tafsir record for one ayah

{
  "tafsirs": [
    {
      "id": 82641,
      "resource_id": 169,
      "verse_id": 255,
      "language_id": 38,
      "text": "<p>Bismillah is a verse of the Holy Qur'an.</p>",
      "language_name": "english",
      "resource_name": "Tafsir Ibn Kathir",
      "verse_key": "2:255",
      "chapter_id": 2,
      "verse_number": 255,
      "juz_number": 1,
      "hizb_number": 1,
      "rub_el_hizb_number": 1,
      "page_number": 1,
      "ruku_number": 1,
      "manzil_number": 1,
      "slug": "tafsir-ibn-kathir"
    }
  ],
  "meta": {
    "tafsir_name": "Tafsir Ibn Kathir",
    "author_name": "Hafiz Ibn Kathir",
    "filters": {
      "verse_key": "2:255"
    }
  },
  "pagination": {
    "per_page": 10,
    "current_page": 1,
    "next_page": null,
    "total_pages": 1,
    "total_records": 1
  }
}

Will be returned when the request is invalid e.g. request is missing required headers or with invalid query parameters.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

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]

success boolean

{
  "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.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "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.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "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.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "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.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "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

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "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.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "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

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "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

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "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

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "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 paginated tafsir records​

Get paginated tafsir records