Show Ayas and Search

Show Ayas API will retrieve list of verses/ayas list from the Holy Quran, based on the page and limit filters. If filtering parameter (keywords) used then the output will be limited with search result. Otherwise, the output will be a sequential display of the verses/ayas.

Version

URL

https://ialharami.com/quran-projects/api/v1/ayas[?pgae= ][&limit= ][&keyword= ]

Method

GET

API Authentication

Not required

URL Params

None

Data Params

page : number
limit : number
Keywords: string, Arabic Unicode

Success Response

Code: 200 OK

Example 1: https://ialharami.com/quran-projects/api/v1/ayas?limit=3

{
  "success": true,
  "meta": {
    "count": 3,
    "page": 1,
    "limit": 3,
    "totalPages": 2116,
    "totalRecords": 6348
  },
  "data": {
    "ayas": [
      {
        "id": "1",
        "ayaNumber": "1",
        "ayaText": "بسم الله الرحمن الرحيم",
        "suraName": "الفاتحه",
        "suraNumber": "1"
      },
      {
        "id": "2",
        "ayaNumber": "2",
        "ayaText": "الحمد لله رب العالمين",
        "suraName": "الفاتحه",
        "suraNumber": "1"
      },
      {
        "id": "3",
        "ayaNumber": "3",
        "ayaText": "الرحمن الرحيم",
        "suraName": "الفاتحه",
        "suraNumber": "1"
      }
    ]
  }
}

Example 2 (Search): https://ialharami.com/quran-projects/api/v1/ayas?keywords=محمد

{
  "success": true,
  "meta": {
    "count": 4,
    "page": 1,
    "limit": 100,
    "totalPages": 1,
    "totalRecords": 4
  },
  "data": {
    "ayas": [
      {
        "id": "439",
        "ayaNumber": "144",
        "ayaText": "وما محمد إلا رسول قد خلت من قبله الرسل أفإن مات أو قتل انقلبتم على أعقابكم ومن ينقلب على عقبيه فلن يضر الله شيئا وسيجزي الله الشاكرين",
        "suraName": "ال عمران",
        "suraNumber": "3"
      },
      {
        "id": "3604",
        "ayaNumber": "40",
        "ayaText": "ما كان محمد أبا أحد من رجالكم ولكن رسول الله وخاتم النبيين وكان الله بكل شيء عليما",
        "suraName": "الاحزاب",
        "suraNumber": "33"
      },
      {
        "id": "4592",
        "ayaNumber": "2",
        "ayaText": "والذين آمنوا وعملوا الصالحات وآمنوا بما نزل على محمد وهو الحق من ربهم كفر عنهم سيئاتهم وأصلح بالهم",
        "suraName": "محمد",
        "suraNumber": "47"
      },
      {
        "id": "4658",
        "ayaNumber": "29",
        "ayaText": "محمد رسول الله والذين معه أشداء على الكفار رحماء بينهم تراهم ركعا سجدا يبتغون فضلا من الله ورضوانا سيماهم في وجوههم من أثر السجود ذلك مثلهم في التوراة ومثلهم في الإنجيل كزرع أخرج شطأه فآزره فاستغلظ فاستوى على سوقه يعجب الزراع ليغيظ بهم الكفار وعد الله الذين آمنوا وعملوا الصالحات منهم مغفرة وأجرا عظيما",
        "suraName": "الفتح",
        "suraNumber": "48"
      }
    ]
  }
}

id : number(4)
ayaNumber : number(3)
ayaText : string, Arabic Unicode
suraName : string(10), Arabic Unicode
suraNumber : number(3)

Not Found Response

Code: 404 Not Found

Example:  https://ialharami.com/quran-projects/api/v1/ayas?page=1000

{
  "success": false,
  "errors": {
    "code": 404,
    "message": "Not Found",
    "detail": "No data found, or end of Ayas list"
  }
}

Error Response

Code: 500 Internal Server Error

Note: The detailed message varies depending on the type of error.

{
  "success": false,
  "errors": {
    "code": 500,
    "message": "Internal Server Error",
    "detail": "Database: SQLSTATE[HY000] [2002] No connection could be made because the target machine actively refused it"
  }
}