Get Ayah recitations for specific Madani Mushaf page

Get list of ayah #model:knzdXGgyjYnAqbhGX for a Madani Mushaf page.

Path Parameters

recitation_id number required

Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL

page_number number required

Possible values: >= 1 and <= 604

Responses

Successful response

application/json

Schema

Example (from schema)

Example

Schema

audio_files object[] required

pagination object required

{
  "audio_files": [
    {
      "url": "https://verses.quran.foundation/AbdulBaset/Mujawwad/mp3/001001.mp3",
      "duration": 6,
      "format": "mp3",
      "segments": [
        [
          [
            0,
            120,
            -1
          ],
          [
            120,
            420,
            0
          ],
          [
            540,
            810,
            1
          ],
          [
            1350,
            1006,
            2
          ],
          [
            2356,
            2454,
            3
          ],
          [
            4810,
            390,
            -1
          ]
        ]
      ]
    }
  ],
  "pagination": {
    "per_page": 1,
    "current_page": 1,
    "next_page": 2,
    "total_pages=": 7,
    "total_records=": 7
  }
}

{
  "audio_files": [
    {
      "verse_key": "1:1",
      "url": "AbdulBaset/Mujawwad/mp3/001001.mp3"
    },
    {
      "verse_key": "1:2",
      "url": "AbdulBaset/Mujawwad/mp3/001002.mp3"
    },
    {
      "verse_key": "1:3",
      "url": "AbdulBaset/Mujawwad/mp3/001003.mp3"
    }
  ],
  "pagination": {
    "per_page": 10,
    "current_page": 1,
    "next_page": 2,
    "total_pages": 15,
    "total_records": 148
  }
}

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 /recitations/:recitation_id/by_page/:page_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

Base URL

https://apis-prelive.quran.foundation/content/api/v4

x-auth-token

x-client-id

recitation_id — path required

page_number — path required

curl / cURL
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/recitations/:recitation_id/by_page/:page_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

python / requests
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/recitations/:recitation_id/by_page/:page_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

go / native
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/recitations/:recitation_id/by_page/:page_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

nodejs / axios
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/recitations/:recitation_id/by_page/:page_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

ruby / Net::HTTP
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/recitations/:recitation_id/by_page/:page_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

csharp / RestSharp
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/recitations/:recitation_id/by_page/:page_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

php / cURL
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/recitations/:recitation_id/by_page/:page_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

java / OkHttp
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/recitations/:recitation_id/by_page/:page_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

powershell / RestMethod
curl -L -X GET 'https://apis-prelive.quran.foundation/content/api/v4/recitations/:recitation_id/by_page/:page_number' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'