SalamQuran

SalamQuran API Documentation V6

SalamQuran APIs

With our API you can control the entire infrastructure via a standardized programmatic interface. You can using API do just about anything you can do via your dashboard.

Our API is a RESTful API based on HTTPS requests and JSON responses. If you are registered, you can obtain your API key from 'My Account' page. Go to My account.

Audience for APIs

Most peoples manage their settings in the web dashboard, built using these APIs. Virtually anything you can do in the customer dashboard may be done via API.

We offers public APIs with three audiences in mind.

  1. Partners
  2. Customers
  3. Developers

The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints.

Endpoints

The API is accessed by making HTTPS requests to a specific version endpoint URL, in which GET, POST, PUT, PATCH,HEAD and DELETE methods dictate how your interact with the information available. Every endpoint is accessed only via the HTTPS protocol.

Everything (methods, parameters, etc.) is fixed to a version number, and every call must contain one. The latest version is Version 6.

The stable base URL for all Version 6 HTTPS endpoints is

http://quran.pw/api/v6/

Requests

Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required.

Method Usage
GET

For simple retrieval of information about your something you should use the GET method. The information you request will be returned to you as a JSON object.

The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.

POST

To create a new object, your request should specify the POST method.

The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.

DELETE

To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found.

This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.

PUT

To update the information about a resource in your account, the PUT method is available.

Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.

PATCH

To update a portion of the information about a resource in your account, the PATCH method is available.

Like the PUT Method, the PATCH method is idempotent.

HEAD

Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request.

Response headers contain some useful information about your API access and the results that are available for your request.

For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.

Responses

Each response is a JSON object.

  • The data requested is wrapped in the result tag.
  • If you have a response, it will always be within the result field.
  • We also include a ok flag and an array of msg in the response.
  • Some responses can have additional pagination info wrapped in the meta
  • An msg object will contain a type field and a text

Success Response example

{
  "ok": true,
  "result":
  {
      "abc": 123,
      "def": 456
  }
  "msg":
  [
    {
      "type": "info",
      "text": "How are you!"
    }
  ]
}

Error Response example

{
  "ok": false,
  "msg":
  [
    {
      "type": "error",
      "text": "A verification code was sended to user"
    }
  ]
}

HTTP response codes

The status of a response can be determined from the HTTP status code.

Code Status Description
200 OK request successful
304 Not Modified request successful
400 Bad Request request was invalid
401 Unauthorized user does not have permission
403 Forbidden request not authenticated
404 Not Found Invalid url
429 Too many requests client is rate limited
405 Method Not Allowed incorrect HTTP method provided
415 Unsupported Media Type response is not valid JSON

POST
Get Access Token

Get access token of new connection from server

POST http://quran.pw/en/api/v6/token

Required parameters on header

Name type Description example Constraints
appkey
string
APP key generated on the user panel
1234ec8e69c19ebb7c202ae1097aa404
Required
length 32

cURL example

curl -X POST http://quran.pw/en/api/v6/token -H 'appkey: 1234ec8e69c19ebb7c202ae1097aa404'

Response example

{
  "ok": true,
  "result": {
    "token": "ec8e69c19ebb7c202ae1097aa40484e0",
    "create": "2019-02-19 14:04:32",
    "expire": "2019-02-19 14:07:32"
  }
}

POST
Sign Up User

Add new user to service

POST http://quran.pw/en/api/v6/android/user/add

Required parameters on header

Name type Description example Constraints
token
string
Your temporary token
ec8e69c19ebb7c202ae1097aa40484e0
Required
length 32

Required parameters

Name type Description example Constraints
model
string
example
HUAWEI Y560-U02
Required
Max length 100
serial
string
example
60D15B27D1259123456
Required
Max length 100
manufacturer
string
example
HUAWEI
Required
Max length 100
version
string
example
19
Required
Max length 20
hardware
string
example
sc8830
Optional
Max length 50
type
string
example
user
Optional
Max length 50
board
string
example
HUAWEI
Optional
Max length 100
id
string
example
HUAWEIY560-U02
Optional
Max length 100
product
string
example
Y560-U02
Optional
Max length 100
device
string
example
HWY560-U
Optional
Max length 100
brand
string
example
HUAWEI
Optional
Max length 100

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/android/user/add \
  -H 'token: ec8e69c19ebb7c202ae1097aa40484e0' \
  -F 'model=HUAWEI Y560-U02' \
  -F 'serial=60D15B27D1259123456' \
  -F 'manufacturer=HUAWEI' \
  -F 'version=19' \
  -F 'hardware=sc8830' \
  -F 'type=user' \
  -F 'board=HUAWEI' \
  -F 'id=>HUAWEIY560-U02' \
  -F 'product=Y560-U02' \
  -F 'device=HWY560-U' \
  -F 'brand=HUAWEI'

Response example

{
  "ok": true,
  "result": {
    "usercode": "3N5C",
    "zoneid": "android-ZW3N"
    "apikey": "87923bd0d04b30aa5f66b699c2698e3b",
  }
}

GET
Get profile detail

GET http://quran.pw/en/api/v6/profile

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32

cURL example

curl -X GET \
  http://quran.pw/en/api/v6/profile \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b'

Response example

{
    "ok": true,
    "result": {
        "username": "Biqarar",
        "displayname": "Reza mohiti",
        "gender": "male",
        "title": "Programer",
        "mobile": "9891...",
        "verifymobile": "1",
        "status": "active",
        "avatar": "http://quran.pw/static/images/logo.png",
        "datecreated": "2017-12-27 22:40:53",
        "datemodified": "2019-06-18 21:29:32",
        "birthday": "1990-01-16",
        "language": "fa",
        "firstname": "Reza",
        "lastname": "Mohitit",
        "bio": null,
        "email": null
    }
}

POST
Update avatar

Upload your avatar to change it

POST http://quran.pw/en/api/v6/profile

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32

Required parameters

Name type Description example Constraints
avatar
FILE
You file location to upload
Required

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/profile \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F avatar=@/home/reza/Desktop/yourfile.jpg

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "User successfully updated"
    }
  ],
  "result": null
}

PATCH
Update your profile

Update profile detail

PATCH http://quran.pw/en/api/v6/profile

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32

Parameters

Name type Description example Constraints
displayname
string
Example
Reza Mohiti
Optional
firstname
string
Example
Reza
Optional
lastname
string
Example
Mohiti
Optional
username
string
Example
Biqarar
Optional
language
string
Example
fa
Optional
birthday
string
Example
1990-01-16
Optional
gender
string
Example
male Or female
Optional
email
string
Example
name@domain.com
Optional
website
string
Example
http://yourwebsite.tld
Optional
instagram
string
Your account username in instagram
Optional
linkedin
string
Your account username in linkedin
Optional
facebook
string
Your account username in facebook
Optional
twitter
string
Your account username in twitter
Optional
title
string
Example
Programer
Optional
bio
string
Example
your bio text
Optional

cURL example

curl -X PATCH \
  http://quran.pw/en/api/v6/profile \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F 'username=biqarar'\
  -F 'bio=programing is my life'

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "User successfully updated"
    }
  ],
  "result": null
}

GET
Get about text

GET http://quran.pw/en/api/v6/about

cURL example

curl -X GET http://quran.pw/en/api/v6/about

Response example

{
  "ok": true,
  "result": {
    "language": "en",
    "title": "about",
    "slug": "about",
    "url": "http://quran.pw/en/api/v6/about",
    "content": "Your about text"
  }
}

GET
Get mission text

GET http://quran.pw/en/api/v6/mission

cURL example

curl -X GET http://quran.pw/en/api/v6/mission

Response example

{
  "ok": true,
  "result": {
    "language": "en",
    "title": "mission",
    "slug": "mission",
    "url": "http://quran.pw/en/api/v6/mission",
    "content": "Your mission text"
  }
}

GET
Get vision text

GET http://quran.pw/en/api/v6/vision

cURL example

curl -X GET http://quran.pw/en/api/v6/vision

Response example

{
  "ok": true,
  "result": {
    "language": "en",
    "title": "vision",
    "slug": "vision",
    "url": "http://quran.pw/en/api/v6/vision",
    "content": "Your vision text"
  }
}

GET
Get contact text

GET http://quran.pw/en/api/v6/contact

cURL example

curl -X GET http://quran.pw/en/api/v6/contact

Response example

{
  "ok": true,
  "result": {
    "language": "en",
    "title": "contact",
    "slug": "contact",
    "url": "http://quran.pw/en/api/v6/contact",
    "content": "Your contact text"
  }
}

GET
Get last posts

GET http://quran.pw/en/api/v6/posts

cURL example

curl -X GET http://quran.pw/en/api/v6/posts

Response example

{
  "ok": true,
  "result": [
    {
      "id": "3Y",
      "language": "en",
      "title": "test",
      "seotitle": null,
      "slug": "test",
      "parent_url": [],
      "url": "test",
      "excerpt": "test",
      "subtitle": null,
      "content": "test content",
      "status": "publish",
      "publishdate": "2019-07-15 11:43:00",
      "datecreated": "2019-07-15 11:42:48"
    }
  ]
}

GET
Get last get-post

GET http://quran.pw/en/api/v6/posts/get

Required parameters

Name type Description example Constraints
id
code
example
3zC
Required

cURL example

curl -X GET http://quran.pw/en/api/v6/posts/get?id=3zC

Response example

{
    "ok": true,
    "result": {
        "id": "3zC",
        "language": "fa",
        "subdomain": null,
        "title": "Post title",
        "seotitle": null,
        "slug": "post slug",
        "slug_raw": "post slug",
        "parent_url": [],
        "url": "post url",
        "link": "Post full url",
        "content": "Post content",
        "meta": {
            "thumb": "image.jpg",
            "gallery": [
            ],
            "download": {
                "title": "",
                "url": null,
                "target": false,
                "color": ""
            },
            "source": {
                "title": "",
                "url": null
            },
            "redirect": null
        },
        "file": {

        },
        "type": "post",
        "subtype": null,
        "special": "0",
        "comment": "closed",
        "count": null,
        "order": null,
        "status": "publish",
        "parent": null,
        "user_id": "5Xv",
        "publishdate": "2019-08-07 10:03:00",
        "datemodified": "2019-08-26 13:11:11",
        "datecreated": "2019-08-10 09:06:31",
        "subtitle": null,
        "excerpt": "expert"
    }
}

POST
Login user

Login user and get new apikey for this user

POST http://quran.pw/en/api/v6/enter

Required parameters on header

Name type Description example Constraints
token
string
Your temporary token
ec8e69c19ebb7c202ae1097aa40484e0
Required
length 32
To get this token see Read more
apikey
string
Your temporary apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account or signup user Read more

Required parameters

Name type Description example Constraints
mobile
number
example
989121234567
Required
Max length 12 Min length 7

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/enter \
  -H 'token: ec8e69c19ebb7c202ae1097aa40484e0' \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F 'mobile=989121234567'

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "The verification code sended to phone number"
    }
  ],
  "result": null
}

POST
Verify user

After send verification code to user you must verify it

POST http://quran.pw/en/api/v6/enter/verify

Required parameters on header

Name type Description example Constraints
token
string
Your temporary token
ec8e69c19ebb7c202ae1097aa40484e0
Required
length 32
To get this token see Read more
apikey
string
Your temporary apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account or signup user Read more

Required parameters

Name type Description example Constraints
mobile
number
example
989121234567
Required
Max length 12 Min length 7
verifycode
int
example
12345
Required
length 5

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/enter \
  -H 'token: ec8e69c19ebb7c202ae1097aa40484e0' \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F 'mobile=989121234567'
  -F 'verifycode=12345'

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Code is ok"
    }
  ],
  "result": {
    "apikey": "891920636c6cd1993baf0ab5eaac48ce"
  }
}

GET
Get language list

GET http://quran.pw/en/api/v6/language

cURL example

curl -X GET http://quran.pw/en/api/v6/language

Response example

{
  "ok": true,
  "result": {
    "fa": {
      "name": "fa",
      "direction": "rtl",
      "iso": "fa_IR",
      "localname": "فارسی",
      "country": [
          "Iran"
      ]
    },
    "en": {
      "name": "en",
      "direction": "ltr",
      "iso": "en_US",
      "localname": "English",
      "country": [
          "United Kingdom",
          "United States"
      ]
    }
  }
}

POST
Get notification count

To get this user have notification or no

POST http://quran.pw/en/api/v6/smile

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account Read more

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/smile \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \

Response example

{
  "ok": true,
  "result": {
    "notif_new": true,
    "notif_count": 1
  }
}

POST
Get notification list

Get list of your notification

POST http://quran.pw/en/api/v6/notif

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile Read more

Response

Name type Description example
id
String
example
3NW
readdate
Date time
If user not read this notif, this response is null else see read date of this notif
example
2019-02-10 08:14:12
datecreated
Date time
example
2019-02-09 07:15:13
title
String
example
Notif title
icon
String
example
home Read more
cat
String
example
Notif category
excerpt
String
example
Notif excerpt
text
String
example
Notif text
image
URL
example
http://quran.pw/static/images/logo.png
footer
String
example
Notif Footer
url
URL
example
http://quran.pw

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/notif \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \

Response example

{
  "ok": true,
  "result": [
    {
      "id": "36v",
      "readdate": null,
      "datecreated": "2019-02-09 07:15:13",
      "title": "Notif title",
      "icon": "test icon",
      "cat": "category of notif",
      "excerpt": "Notif excerpt",
      "text" : "Notif text",
      "image" : "http://quran.pw/static/images/logo.png",
      "footer" : "Notif footer",
      "url" : "http://quran.pw/static"
    }
  ]
}

GET
Get android detail

Get details like pages, language list, translations, and more.

GET http://quran.pw/en/api/v6/android

cURL example

curl -X GET http://quran.pw/en/api/v6/android

Response example

{
  "ok": true,
  "result": {
    "version": "1.1.1",
    "lang_list": {
      "fa": {
        "name": "fa",
        "direction": "rtl",
        "iso": "fa_IR",
        "localname": "فارسی",
        "country": [
          "Iran"
        ]
      },
      "en": {
        "name": "en",
        "direction": "ltr",
        "iso": "en_US",
        "localname": "English",
        "country": [
          "United Kingdom",
          "United States"
        ]
      }
    }
  }
}

GET
Get application detail

Get details like pages, language list, translations, and more.

GET http://quran.pw/en/api/v6/app

cURL example

curl -X GET http://quran.pw/en/api/v6/app

Response example

{
  "ok": true,
  "result": {
    "lang_list": {
      "fa": {
        "name": "fa",
        "direction": "rtl",
        "iso": "fa_IR",
        "localname": "فارسی",
        "country": [
          "Iran"
        ]
      },
      "en": {
        "name": "en",
        "direction": "ltr",
        "iso": "en_US",
        "localname": "English",
        "country": [
          "United Kingdom",
          "United States"
        ]
      }
    }
    ...
  }
}

GET
Get session list

Get your active session detail.

GET http://quran.pw/en/api/v6/session

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

cURL example

curl -X GET http://quran.pw/en/api/v6/session

Response example

{
  "ok": true,
  "result": [
    {
      "id": "3N",
      "ip": "127.0.0.1",
      "last": "Tuesday 28 May 2019 16:13:49",
      "browser": "Chrome",
      "browserVer": "74.0.3729.169",
      "os": "Linux",
      "os_version": null
    },
    {
      "id": "3J",
      "ip": "127.0.0.1",
      "last": "Friday 17 May 2019 14:18:16",
      "browser": "Chrome",
      "browserVer": "74.0.3729.157",
      "os": "Linux",
      "os_version": null
    }
  ]
}

POST
Terminate session

Terminate one session or all session

POST http://quran.pw/en/api/v6/session

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Parameters

Name type Description example
type
String
terminate Or terminateall
id
String
example
3N
If type is `terminate` the id is require

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/session \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F 'type=terminate' \
  -F 'id=3N'

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "This Session was terminated"
    }
  ],
  "result": true
}

GET
Get one aya

GET http://quran.pw/en/api/v6/aya

Parameters

Name type Description example Constraints
index
number
example
1408

You must set index between 1 and 6236

Required

cURL example

curl -X GET http://quran.pw/en/api/v6/aya?index=1408

Response example

{
  "ok": true,
  "result": {
    "index": "1408",
    "sura": "10",
    "aya": "44",
    "text": "إِنَّ ٱللَّهَ لَا يَظْلِمُ ٱلنَّاسَ شَيْـًٔا وَلَٰكِنَّ ٱلنَّاسَ أَنفُسَهُمْ يَظْلِمُونَ",
    "simple": "إن الله لا يظلم الناس شيئا ولكن الناس أنفسهم يظلمون",
    "juz": "11",
    "hizb": "22",
    "page": "214",
    "word": "10",
    "sajdah": null,
    "sajdah_number": null,
    "rub": "85",
    "verse_key": "10:44",
    "theletter": null,
    "sortnozol": null,
    "sortalphabet": null,
    "type": null,
    "nim": "43",
    "sura_detail": {
      "index": "10",
      "ayas": "109",
      "start": "1364",
      "end": null,
      "name": "يونس",
      "tname": "Yunus",
      "ename": "Jonah",
      "type": "meccan",
      "order": "51",
      "orderalphabet": null,
      "orderquran": null,
      "word": "1843",
      "theletter": "7567",
      "startjuz": "11",
      "endjuz": "11",
      "startpage": "208",
      "endpage": "221"
    },
    "translate": {
      "index": "1408",
      "sura": "10",
      "aya": "44",
      "text": "قطعاً خداوند هیچ ظلمى به مردم نمى‌کند، امّا این خود مردمند که به خویشتن ستم مى‌کنند."
    }
  }
}

GET
Get list of sura

Get sura list by some detail like aya count, type, index and more.

GET http://quran.pw/en/api/v6/sura/list

cURL example

curl -X GET http://quran.pw/en/api/v6/sura/list

Response example

{
  "ok": true,
  "result": [
    {
      "index": "1",
      "ayas": "7",
      "name": "الفاتحة",
      "tname": "Al-Fatihah",
      "ename": "The Opener",
      "type": "meccan",
      "order": "5",
      "word": "29",
      "theletter": "142"
    }
    ...
  ]
}

GET
Get aya of sura

Get list of aya from one sura

GET http://quran.pw/en/api/v6/sura

Parameters

Name type Description example Constraints
index
number
example
108

You must set index between 1 and 114

Required
start
number
example
2

Start aya number

Maximum Max aya count of sura

Optional
limit
number
example
10

Count record to show

Maximum 20

Optional

cURL example

curl -X GET http://quran.pw/en/api/v6/sura?index=108

Response example

{
    "ok": true,
    "result": [
        {
            "index": "6205",
            "sura": "108",
            "aya": "1",
            "text": "إِنَّآ أَعْطَيْنَٰكَ ٱلْكَوْثَرَ",
            "simple": "إنا أعطيناك الكوثر",
            "juz": "30",
            "hizb": "60",
            "page": "602",
            "word": "3",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "240",
            "verse_key": "108:1",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        },
        {
            "index": "6206",
            "sura": "108",
            "aya": "2",
            "text": "فَصَلِّ لِرَبِّكَ وَٱنْحَرْ",
            "simple": "فصل لربك وانحر",
            "juz": "30",
            "hizb": "60",
            "page": "602",
            "word": "3",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "240",
            "verse_key": "108:2",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        },
        {
            "index": "6207",
            "sura": "108",
            "aya": "3",
            "text": "إِنَّ شَانِئَكَ هُوَ ٱلْأَبْتَرُ",
            "simple": "إن شانئك هو الأبتر",
            "juz": "30",
            "hizb": "60",
            "page": "602",
            "word": "4",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "240",
            "verse_key": "108:3",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        }
    ]
}

GET
Get aya of sura word by word

Get list of aya from one sura word by word

GET http://quran.pw/en/api/v6/sura/wbw

Parameters

Name type Description example Constraints
index
number
example
108

You must set index between 1 and 114

Required
start
number
example
2

Start aya number

Maximum Max aya count of sura

Optional
limit
number
example
10

Count record to show

Maximum 20

Optional

cURL example

curl -X GET http://quran.pw/en/api/v6/sura/wbw?index=108

Response example

{
    "ok": true,
    "result": [
        {
            "id": "88078",
            "aya": "1",
            "sura": "108",
            "position": "1",
            "verse_key": "108:1",
            "text": "إِنَّا",
            "simple": "انا",
            "juz": null,
            "hizb": null,
            "rub": null,
            "page": "602",
            "class_name": "p602",
            "line": "14",
            "code": "ﮆ",
            "code_v3": "ﮆ",
            "char_type": "word",
            "audio": "/108_001_001.mp3",
            "translation": "Indeed, We"
        },
        {
            "id": "88079",
            "aya": "1",
            "sura": "108",
            "position": "2",
            "verse_key": "108:1",
            "text": "أَعْطَيْنَاكَ",
            "simple": "اعطيناك",
            "juz": null,
            "hizb": null,
            "rub": null,
            "page": "602",
            "class_name": "p602",
            "line": "14",
            "code": "ﮇ",
            "code_v3": "ﮇ",
            "char_type": "word",
            "audio": "/108_001_002.mp3",
            "translation": "have given you"
        },
       ...
    ]
}

GET
Get aya in one page

Get list of aya from one page

GET http://quran.pw/en/api/v6/page

Parameters

Name type Description example Constraints
index
number
example
1

You must set index between 1 and 604

Required

cURL example

curl -X GET http://quran.pw/en/api/v6/page?index=1

Response example

{
    "ok": true,
    "result": [
        {
            "index": "1",
            "sura": "1",
            "aya": "1",
            "text": "بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ",
            "simple": "بسم الله الرحمن الرحيم",
            "juz": "1",
            "hizb": "1",
            "page": "1",
            "word": "4",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "1",
            "verse_key": "1:1",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        },
        {
            "index": "2",
            "sura": "1",
            "aya": "2",
            "text": "ٱلْحَمْدُ لِلَّهِ رَبِّ ٱلْعَٰلَمِينَ",
            "simple": "الحمد لله رب العالمين",
            "juz": "1",
            "hizb": "1",
            "page": "1",
            "word": "4",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "1",
            "verse_key": "1:2",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        },
       ...
    ]
}

GET
Get aya in one page word by word

Get list of aya from one page word by word

GET http://quran.pw/en/api/v6/page/wbw

Parameters

Name type Description example Constraints
index
number
example
604

You must set index between 1 and 604

Required

cURL example

curl -X GET http://quran.pw/en/api/v6/page/wbw?index=604

Response example

{
  "ok": true,
  "result": [
    {
      "detail": {
        "line_type": "start_sura",
        "line": 1,
        "index": "112",
        "ayas": "4",
        "start": "6221",
        "end": null,
        "name": "الإخلاص",
        "tname": "Al-Ikhlas",
        "ename": "The Sincerity",
        "type": "meccan",
        "order": "22",
        "orderalphabet": null,
        "orderquran": null,
        "word": "19",
        "theletter": "47",
        "startjuz": "30",
        "endjuz": "30",
        "startpage": "604",
        "endpage": "604"
      }
    },
    {
      "detail": {
        "line_type": "besmellah",
        "line": 2
      }
    },
    {
      "detail": {
        "index": null,
        "text": null,
        "simple": null,
        "juz": null,
        "hizb": null,
        "word": null,
        "sajdah": null,
        "sajdah_number": null,
        "rub": null,
        "aya": "1",
        "sura": "112",
        "verse_key": "112:1",
        "verse_title": "قرآن - سوره ۱۱۲ اخلاص - آیه ۱",
        "verse_url": "http://salamquran.local/fa/s112/1",
        "page": "604",
        "line_type": "line",
        "line": 3,
        "audio": "https://dl.salamquran.com/ayat/parhizgar-murattal-48/112001.mp3",
        "translate": false
      },
      "word": [
        {
          "id": "88174",
          "index": "6222",
          "aya": "1",
          "sura": "112",
          "position": "1",
          "verse_key": "112:1",
          "text": "قُلْ",
          "simple": "قل",
          "juz": "30",
          "hizb": "60",
          "rub": "240",
          "page": "604",
          "class_name": "p604",
          "line": "3",
          "code": "ﭑ",
          "code_v3": "ﭑ",
          "char_type": "word",
          "audio": "112/112_001_001.mp3",
          "translation": "Say",
          "nim": "120",
          "audio_key": "112_001_001"
        },
        {
          "id": "88175",
          "index": "6222",
          "aya": "1",
          "sura": "112",
          "position": "2",
          "verse_key": "112:1",
          "text": "هُوَ",
          "simple": "هو",
          "juz": "30",
          "hizb": "60",
          "rub": "240",
          "page": "604",
          "class_name": "p604",
          "line": "3",
          "code": "ﭒ",
          "code_v3": "ﭒ",
          "char_type": "word",
          "audio": "112/112_001_002.mp3",
          "translation": "He",
          "nim": "120",
          "audio_key": "112_001_002"
        },
        ...
      ]
    }
  ]
}

GET
Get juz detail per sura detail

Get all juz detail per sura detail

GET http://quran.pw/en/api/v6/juz/sura

cURL example

curl -X GET http://quran.pw/en/api/v6/juz/sura

Response example

{
  "ok": true,
  "result": {
    "ok": true,
    "result": [
      {
        "index": 1,
        "startpage": 1,
        "sura": [
          {
            "index": "1",
            "ayas": "7",
            "start": "0",
            "end": null,
            "name": "الفاتحة",
            "tname": "Al-Fatihah",
            "ename": "The Opener",
            "type": "meccan",
            "order": "5",
            "orderalphabet": null,
            "orderquran": null,
            "word": "29",
            "theletter": "142",
            "startjuz": "1",
            "endjuz": "1",
            "startpage": "1",
            "endpage": "1"
          },
          {
            "index": "2",
            "ayas": "286",
            "start": "7",
            "end": null,
            "name": "البقرة",
            "tname": "Al-Baqarah",
            "ename": "The Cow",
            "type": "medinan",
            "order": "87",
            "orderalphabet": null,
            "orderquran": null,
            "word": "6144",
            "theletter": "25500",
            "startjuz": "1",
            "endjuz": "3",
            "startpage": "2",
            "endpage": "49"
          }
        ]
      },
      {
        "index": 2,
        "startpage": 22
      },
      {
        "index": 3,
        "startpage": 42,
        "sura": [
          {
            "index": "3",
            "ayas": "200",
            "start": "293",
            "end": null,
            "name": "آل عمران",
            "tname": "Ali 'Imran",
            "ename": "Family of Imran",
            "type": "medinan",
            "order": "89",
            "orderalphabet": null,
            "orderquran": null,
            "word": "3505",
            "theletter": "14525",
            "startjuz": "3",
            "endjuz": "4",
            "startpage": "50",
            "endpage": "76"
          }
        ]
      },
      ...
    ]
  }
}

GET
Get juz detail per hizb detail

Get all juz detail per hizb detail

GET http://quran.pw/en/api/v6/juz/hizb

cURL example

curl -X GET http://quran.pw/en/api/v6/juz/hizb

Response example

{
  "ok": true,
  "result": {
    "1": {
      "1": {
        "1": {
          "index_rub": 1,
          "index_hizb": 1,
          "rub": "1",
          "sura": "1",
          "page": "1",
          "sura_detail": {
            "index": "1",
            "ayas": "7",
            "start": "0",
            "end": null,
            "name": "الفاتحة",
            "tname": "Al-Fatihah",
            "ename": "The Opener",
            "type": "meccan",
            "order": "5",
            "orderalphabet": null,
            "orderquran": null,
            "word": "29",
            "theletter": "142",
            "startjuz": "1",
            "endjuz": "1",
            "startpage": "1",
            "endpage": "1"
          },
          "aya": "1",
          "text": "بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ",
          "simple": "بسم الله الرحمن الرحيم",
          "first_word": "بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ",
          "first_word_simple": "بسم الله الرحمن الرحيم"
        },
        "2": {
          "index_rub": 2,
          "index_hizb": 1,
          "rub": "2",
          "sura": "2",
          "page": "5",
          "sura_detail": {
            "index": "2",
            "ayas": "286",
            "start": "7",
            "end": null,
            "name": "البقرة",
            "tname": "Al-Baqarah",
            "ename": "The Cow",
            "type": "medinan",
            "order": "87",
            "orderalphabet": null,
            "orderquran": null,
            "word": "6144",
            "theletter": "25500",
            "startjuz": "1",
            "endjuz": "3",
            "startpage": "2",
            "endpage": "49"
          },
          "aya": "26",
          "text": "إِنَّ ٱللَّهَ لَا يَسْتَحْىِۦٓ أَن يَضْرِبَ مَثَلًا مَّا بَعُوضَةً فَمَا فَوْقَهَا فَأَمَّا ٱلَّذِينَ ءَامَنُوا۟ فَيَعْلَمُونَ أَنَّهُ ٱلْحَقُّ مِن رَّبِّهِمْ وَأَمَّا ٱلَّذِينَ كَفَرُوا۟ فَيَقُولُونَ مَاذَآ أَرَادَ ٱللَّهُ بِهَٰذَا مَثَلًا يُضِلُّ بِهِۦ كَثِيرًا وَيَهْدِى بِهِۦ كَثِيرًا وَمَا يُضِلُّ بِهِۦٓ إِلَّا ٱلْفَٰسِقِينَ",
          "simple": "إن الله لا يستحيي أن يضرب مثلا ما بعوضة فما فوقها فأما الذين آمنوا فيعلمون أنه الحق من ربهم وأما الذين كفروا فيقولون ماذا أراد الله بهذا مثلا يضل به كثيرا ويهدي به كثيرا وما يضل به إلا الفاسقين",
          "first_word": "إِنَّ ٱللَّهَ لَا يَسْتَحْىِۦٓ أَن يَضْرِبَ",
          "first_word_simple": "إن الله لا يستحيي أن يضرب"
        },
        ...
      }
    }
  }
}

GET
Get quick access

Get list of quick access of some aya or sura or something else

GET http://quran.pw/en/api/v6/nav/quick

cURL example

curl -X GET http://quran.pw/en/api/v6/nav/quick

Response example

{
  "ok": true,
  "result": [
    {
      "title": "فاتحه",
      "desc": null,
      "url": "http://salamquran.local/fa/s1"
    },
    {
      "title": "الرحمان",
      "desc": null,
      "url": "http://salamquran.local/fa/s55"
    },
    {
      "title": "ملک",
      "desc": null,
      "url": "http://salamquran.local/fa/s67"
    },
    {
      "title": "یاسین",
      "desc": null,
      "url": "http://salamquran.local/fa/s36"
    },
    {
      "title": "واقعه",
      "desc": null,
      "url": "http://salamquran.local/fa/s56"
    }
  ]
}

GET
Get verse of the day

A verse will be displayed every day

GET http://quran.pw/en/api/v6/aya/day

cURL example

curl -X GET http://quran.pw/en/api/v6/aya/day

Response example

{
  "ok": true,
  "result": {
    "index": "99",
    "sura": "2",
    "aya": "92",
    "text": "وَلَقَدْ جَآءَكُم مُّوسَىٰ بِٱلْبَيِّنَٰتِ ثُمَّ ٱتَّخَذْتُمُ ٱلْعِجْلَ مِنۢ بَعْدِهِۦ وَأَنتُمْ ظَٰلِمُونَ",
    "simple": "ولقد جاءكم موسى بالبينات ثم اتخذتم العجل من بعده وأنتم ظالمون",
    "juz": "1",
    "hizb": "2",
    "page": "14",
    "word": "11",
    ...
  }
}

GET
Get page of the day

A page will be displayed every day

GET http://quran.pw/en/api/v6/page/day

cURL example

curl -X GET http://quran.pw/en/api/v6/page/day

Response example

{
  "ok": true,
  "result": {
    "page": 449,
    "date": "2019-06-12"
  }
}

GET
Calculator hefz program

Send your time and get result

GET http://quran.pw/en/api/v6/hefz/time

Parameters

Name type Description example Constraints
mytime
number
example
10

Minutes

Required

cURL example

curl -X GET http://quran.pw/en/api/v6/hefz/time?mytime=10

Response example

{
  "ok": true,
  "result": {
      "year": 36,
      "month": 3
  }
}

POST
Add new quran favorites

Add some page, sura and aya to your favorites

POST http://quran.pw/en/api/v6/fav/add

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Parameters

Name type Description example Constraints
type
string
example
sura

["sura", "aya", "page"]

Required
sura
number
example
5

1-114

Required If type is sura or aya
aya
number
example
1

Aya number in the sura

Required If type is aya
page
number
example
100

1-604

Required If type is page

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/fav/add \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6' \
  -F 'type=sura' \
  -F 'sura=5'

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Favorites saved"
    }
  ],
  "result": true
}

POST
Update descriptio of favorites

POST http://quran.pw/en/api/v6/fav/edit

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Parameters

Name type Description example Constraints
id
code
example
c

Required
desc
string
example
test
Required

Maximum 200 Character

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/fav/edit \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6' \
  -F 'id=c' \
  -F 'desc=test'

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Description saved"
    }
  ],
  "result": true
}

POST
Remove a saved favorites

POST http://quran.pw/en/api/v6/fav/remove

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Parameters

Name type Description example Constraints
id
code
example
c

Required

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/fav/remove \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6' \
  -F 'id=c'

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Favorites removed"
    }
  ],
  "result": true
}

GET
List of your favorites

GET http://quran.pw/en/api/v6/fav/list

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Parameters

Name type Description example Constraints
id
code
example
c

Required

cURL example

curl -X GET \
  http://quran.pw/en/api/v6/fav/list \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

Response example

{
  "ok": true,
  "pagination": {
    "desc": "page 1 of 1 - Show record 1 to 5 of 5",
    "page": 1,
    "total_page": 1,
    "limit": 10,
    "total_rows": 5
  },
  "result": [
    {
      "id": "c",
      "user_id": "4",
      "page": null,
      "sura": "2",
      "aya": null,
      "desc": null,
      "type": "sura",
      "datecreated": "2019-07-16 12:37:11"
    },
    {
      "id": "d",
      "user_id": "4",
      "page": null,
      "sura": "3",
      "aya": null,
      "desc": null,
      "type": "sura",
      "datecreated": "2019-07-16 12:37:13"
    }
  ]
}

GET
List of group in lms

GET http://quran.pw/en/api/v6/lms/group

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

cURL example

curl -X GET \
  http://quran.pw/en/api/v6/lms/group \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

Response example

{
  "ok": true,
  "pagination": {
    "desc": "page 1 of 1 - Show record 1 to 2 of 2",
    "page": 1,
    "total_page": 1,
    "limit": 10,
    "total_rows": 2
  },
  "result": [
    {
      "id": "3",
      "title": "ناس تا زلزال",
      "type": null,
      "desc": "آموزش سوره‌های ناس تا زلزال",
      "sort": "1",
      "status": "enable",
      "datecreated": "2019-07-26 16:27:17",
      "file": "https://salamquran.com/static/siftal/images/default/logo.png"
    },
    {
      "id": "4",
      "title": "فلق تا ضحی",
      "type": null,
      "desc": "مکانیزم آموزش سوره‌های فلق تا ضحی",
      "sort": "2",
      "status": "enable",
      "datecreated": "2019-07-26 16:31:03",
      "file": "https://salamquran.com/static/siftal/images/default/logo.png"
    },

  ]
}

GET
Get list of level in one group

GET http://quran.pw/en/api/v6/lms/levellist

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Parameters

Name type Description example Constraints
id
code
example
3

Group id

Required

cURL example

curl -X GET \
  http://quran.pw/en/api/v6/lms/levellist?id=3 \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

Response example

{
  "ok": true,
  "result": [
      {
        "id": "d",
        "lm_group_id": "3",
        "title": "آزمون سراسری تابستان",
        "desc": null,
        "type": "quran",
        "type_title": "Quran",
        "quranfrom": "1",
        "quranto": "36",
        "besmellah": "1",
        "file": "http://salamquran.local/static/siftal/images/default/logo.png",
        "setting": null,
        "sort": null,
        "ratio": null,
        "unlockscore": null,
        "status": "enable",
        "datecreated": "2019-07-27 15:53:15",
        "questionrandcount": null,
        "filepic": null,
        "userstar": "3"
      },
      {
        "id": "4",
        "lm_group_id": "3",
        "title": "آموزش روخوانی سوره ناس",
        "desc": "در این آموزش شما با نحوه صحیح قرائت سوره ناس آشنا خواهید شد",
        "type": "quranvideo",
        "type_title": "Quran video",
        "quranfrom": "1",
        "quranto": "10",
        "besmellah": "1",
        "file": "https://mov.tebyan.net/1395/02/Ensan1_2_174931.mp4",
        "setting": null,
        "sort": "1",
        "ratio": "10",
        "unlockscore": "20",
        "status": "enable",
        "datecreated": "2019-07-26 16:54:10",
        "questionrandcount": null,
        "filepic": "https://qhkarimeh.ir/files/1/440-d3dbecfa8f97078c6eb2ada550a03718.jpg",
        "userstar": "3"
      }
  ]
}

GET
Get detail of one level

GET http://quran.pw/en/api/v6/lms/level

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Parameters

Name type Description example Constraints
id
code
example
3

Group id

Required

cURL example

curl -X GET \
  http://quran.pw/en/api/v6/lms/level?id=3 \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

Response example

{
  "ok": true,
  "result": {
    "id": "3",
    "lm_group_id": "3",
    "title": "آموزش نکات روخوانی و روان خوانی",
    "desc": "در این قسمت شما با آموزش نکات روخوانی و روان‌خوانی این سوره آشنا خواهید شد",
    "type": "learn",
    "type_title": "Learn",
    "quranfrom": null,
    "quranto": null,
    "besmellah": null,
    "file": "https://evazzadeh.com/dl/video/chrikt-php01-intro.mp4",
    "setting": null,
    "sort": "2",
    "ratio": "5",
    "unlockscore": null,
    "status": "enable",
    "datecreated": "2019-07-26 16:33:16",
    "questionrandcount": null,
    "filepic": "https://evazzadeh.com/dl/2016/07/php-evazzadeh.png"
  }
}

GET
Get star of user in one level

GET http://quran.pw/en/api/v6/lms/userstar

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Parameters

Name type Description example Constraints
id
code
example
3

Level id

Required

cURL example

curl -X GET \
  http://quran.pw/en/api/v6/lms/userstar?id=3 \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

Response example

{
  "ok": true,
  "result": {
    "star": 3
  }
}

POST
Set user star in one level

POST http://quran.pw/en/api/v6/lms/star

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Parameters

Name type Description example Constraints
id
code
example
3

Level id

Required
star
number
example
1

Only 1, 2, 3 can use in star

Required

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/lms/star \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'\
  -F star=1 \
  -F id=3

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Hooray!\n⭐️",
      "meta": {
          "alerty": true
      }
    }
  ],
  "result": {
    "id": "3g"
  }
}

POST
Set user audio in one level

POST http://quran.pw/en/api/v6/lms/audio

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Required parameters

Name type Description example Constraints
id
code
example
3

Level id

Required
audio
FILE
You file location to upload
Required

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/lms/audio \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F audio=@/home/reza/Desktop/yourfile.jpg \
  -F id=3

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Your audio uploaded"
    }
  ],
  "result": null
}

POST
Set user answer in one level

POST http://quran.pw/en/api/v6/lms/answer

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Required parameters

Name type Description example Constraints
id
code
example
3

Level id

Required
[question id]
code
1[2,3,4]
User answer option
Repeat the total number of questions you want answered
Required

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/lms/answer \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F id=3 \
  -F z=1 \
  -F y=2 \
  -F C=1 \
  -F D=3 \
  -F B=4

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "هورا!\n⭐️⭐️⭐️",
      "meta": {
          "alerty": true
      }
    },
    {
      "type": "ok",
      "text": "پاسخ شما ذخیره شد"
    }
  ],
  "result": true
}

GET
Get learn mistake list

GET http://quran.pw/en/api/v6/mistake

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

cURL example

curl -X GET \
  http://quran.pw/en/api/v6/mistake \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

Response example

{
  "ok": true,
  "pagination": {
    "desc": "page 1 of 1 - Show record 1 to 8 of 8",
    "page": 1,
    "total_page": 1,
    "limit": 10,
    "total_rows": 8
  },
  "result": [
    {
      "id": "3",
      "title": "اشباه در خواندن کلمه",
      "datecreated": "2019-07-31 10:20:27"
    },
    {
      "id": "4",
      "title": "اشتباه حرفی و اعرابی",
      "datecreated": "2019-07-31 10:26:06"
    },
    {
      "id": "5",
      "title": "تبدیل حرکات کوتاه به حرکات کشیده و بالعکس",
      "datecreated": "2019-07-31 10:26:19"
    },
    {
      "id": "6",
      "title": "تپق",
      "datecreated": "2019-07-31 10:26:40"
    },
    {
      "id": "7",
      "title": "مکث بیش از حد",
      "datecreated": "2019-07-31 10:26:44"
    },
    {
      "id": "8",
      "title": "عدم تسلط بر قواعد روخوانی - الف وصل",
      "datecreated": "2019-07-31 10:27:09"
    },
    {
      "id": "9",
      "title": "عدم تسلط بر قواعد روخوانی - حروف ناخوانا",
      "datecreated": "2019-07-31 10:27:18"
    },
    {
      "id": "b",
      "title": "عدم تسلط بر قواعد روخوانی - ادغام در حد ضرورت",
      "datecreated": "2019-07-31 10:27:26"
    }
  ]
}

GET
Get list of user audio

GET http://quran.pw/en/api/v6/audio

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

cURL example

curl -X GET \
  http://quran.pw/en/api/v6/audio \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

Response example

{
  "ok": true,
  "pagination": {
    "desc": "page 1 of 2 - Show record 1 to 10 of 18",
    "page": 1,
    "total_page": 2,
    "limit": 10,
    "total_rows": 18
  },
  "result": [
    {
      "id": "p",
      "lm_group_id": "4",
      "lm_level_id": "3",
      "user_id": "4",
      "teacher": "2",
      "audio": "http://quran.pw/files/1/89-4a9b426f9386c52184a2bd0e54ce325d.wav",
      "teachertxt": "خوب بود",
      "teacheraudio": null,
      "quality": "2",
      "status": "archive",
      "tstatus": "Archive",
      "datecreated": "2019-08-05 13:03:21",
      "group_title": "سوره ناس تا سوره کافرون",
      "level_title": "سوره ناس",
      "user_displayname": "رضا محیطی",
      "teacher_displayname": "رضا محیطی"
    },
    {
      "id": "n",
      "lm_group_id": "4",
      "lm_level_id": "3",
      "user_id": "4",
      "teacher": "2",
      "audio": "http://quran.pw/files/1/88-4a9b426f9386c52184a2bd0e54ce325d.wav",
      "teachertxt": "عالی بود",
      "teacheraudio": "http://quran.pw/files/1/90-01d0ec51f28b89f990e54d940c1525cc.jpg",
      "quality": "3",
      "status": "archive",
      "tstatus": "Archive",
      "datecreated": "2019-08-05 13:02:57",
      "group_title": "سوره ناس تا سوره کافرون",
      "level_title": "سوره ناس",
      "user_displayname": "رضا محیطی",
      "teacher_displayname": "رضا محیطی"
    }
  ]
}

POST
Edit user audio

POST http://quran.pw/en/api/v6/audio/edit

Required parameters on header

Name type Description example Constraints
apikey
string
Your apikey
87923bd0d04b30aa5f66b699c2698e3b
Required
length 32
Get from your account profile

Required parameters

Name type Description example Constraints
id
code
example
p

Audio id

Required
teachertxt
String

Teacher answer text

teacheraudio
FILE

Your file addr to upload

status
String
example
approved

Allowed status

['awaiting', 'spam', 'deleted', 'admindelete', 'approved', 'reject', 'archive']
quality
Number
example
2

1,2,3

mistake_[mistake id]
String
example
mistake_p mistake_2Kf

Get from api mistake list

cURL example

curl -X POST \
  http://quran.pw/en/api/v6/audio/edit \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6' \
  -F id=p \
  -F status=approved

Response example

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "audio successfully updated"
    }
  ],
  "result": null
}

GET
Get list of qari detail

GET http://quran.pw/en/api/v6/qari

cURL example

curl -X GET http://quran.pw/en/api/v6/qari

Response example

{
  "ok": true,
  "result": [
    {
      "index": 1090,
      "lang": "fa",
      "type": "ترتیل",
      "addr": "https://dl.salamquran.com/ayat/parhizgar-murattal-48/",
      "slug": "parhizgar",
      "name": "شهریار پرهیزگار",
      "image": "https://salamquran.local/static/images/qariyan/parhizgar.png",
      "short_name": "پرهیزگار"
    },
    {
      "index": 1091,
      "lang": "fa",
      "type": "ترتیل",
      "addr": "https://dl.salamquran.com/ayat/mansouri-murattal-40/",
      "slug": "mansouri",
      "name": "کریم منصوری",
      "image": "https://salamquran.local/static/images/qariyan/mansouri.png",
      "short_name": "منصوری"
    }
  ]
}
Please use famous browser to have better experience!