This Surah is named Al-Fatihah because of its subject-matter. Fatihah is that which opens a subject or a book or any other thing. In other words, Al-Fatihah is a sort of preface.
\r\nThis Surah is called
- 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" } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/quran/verses/code_v1": { "get": { "tags": ["Quran"], "summary": "Get V1 Glyph codes of ayah", "description": "Get glyph codes of ayah for QCF v1 font", "operationId": "QURAN-verses-code_v1", "parameters": [ { "name": "chapter_number", "in": "query", "description": "If you want to get text of a specific surah.", "schema": { "maximum": 114, "minimum": 1, "type": "integer" } }, { "name": "juz_number", "in": "query", "description": "If you want to get text of a specific juz.", "schema": { "maximum": 30, "minimum": 1, "type": "integer" } }, { "name": "page_number", "in": "query", "description": "If you want to get text of a Madani Muhsaf page", "schema": { "maximum": 604, "minimum": 1, "type": "integer" } }, { "name": "hizb_number", "in": "query", "description": "If you want to get text of a specific hizb.", "schema": { "maximum": 60, "minimum": 1, "type": "integer" } }, { "name": "rub_el_hizb_number", "in": "query", "description": "If you want to get text of a specific Rub el Hizb.", "schema": { "maximum": 240, "minimum": 1, "type": "integer" } }, { "name": "verse_key", "in": "query", "description": "If you want to get text of a specific ayah.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "verses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "verse_key": { "type": "string" }, "code_v1": { "type": "string", "description": "Glyph codes for v1" }, "v1_page": { "maximum": 604, "minimum": 1, "type": "integer", "description": "Madani Muhsaf page number. You can use `v1_page` to generate css and font faces for QCF page font. " } } } } } }, "example": { "verses": [ { "id": 1, "verse_key": "1:1", "code_v1": "ﭑ ﭒ ﭓ ﭔ ﭕ", "v1_page": 1 } ] } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/quran/verses/code_v2": { "get": { "tags": ["Quran"], "summary": "Get V2 Glyph codes of ayah", "description": "Get glyph codes of ayah for QCF v2 font", "operationId": "QURAN-verses-code_v2", "parameters": [ { "name": "chapter_number", "in": "query", "description": "If you want to get text of a specific surah.", "schema": { "maximum": 114, "minimum": 1, "type": "integer" } }, { "name": "juz_number", "in": "query", "description": "If you want to get text of a specific juz.", "schema": { "maximum": 30, "minimum": 1, "type": "integer" } }, { "name": "page_number", "in": "query", "description": "If you want to get text of a Madani Muhsaf page", "schema": { "maximum": 604, "minimum": 1, "type": "integer" } }, { "name": "hizb_number", "in": "query", "description": "If you want to get text of a specific hizb.", "schema": { "maximum": 60, "minimum": 1, "type": "integer" } }, { "name": "rub_el_hizb_number", "in": "query", "description": "If you want to get text of a specific Rub el Hizb.", "schema": { "maximum": 240, "minimum": 1, "type": "integer" } }, { "name": "verse_key", "in": "query", "description": "If you want to get text of a specific ayah.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "verses": { "type": "array", "items": { "required": ["code_v2", "v2_page"], "type": "object", "properties": { "id": { "type": "integer" }, "verse_key": { "type": "string" }, "code_v2": { "type": "string", "description": "Glyph codes for v2" }, "v2_page": { "maximum": 604, "minimum": 1, "type": "integer", "description": "Madani Muhsaf page number. You can use `v2_page` to generate css and font faces for QCF page font. " } } } } } }, "example": { "verses": [ { "id": 1, "verse_key": "1:1", "code_v2": " ﱂ ﱃ ﱄ ﱅ", "v2_page": 1 } ] } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/recitations/{recitation_id}/by_chapter/{chapter_number}": { "get": { "tags": ["Audio"], "summary": "Get Ayah recitations for specific Surah", "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Surah.", "operationId": "list-surah-recitation", "parameters": [ { "name": "recitation_id", "in": "path", "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "schema": { "type": "number" } }, { "name": "chapter_number", "in": "path", "required": true, "schema": { "maximum": 114, "minimum": 1, "type": "number" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "audio_files": { "type": "array", "items": { "$ref": "#/components/schemas/audiofile" } }, "pagination": { "$ref": "#/components/schemas/pagination" } } }, "example": { "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": 2, "total_records": 20 } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/recitations/{recitation_id}/by_juz/{juz_number}": { "get": { "tags": ["Audio"], "summary": "Get Ayah recitations for specific Juz", "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a juz.", "operationId": "list-juz-recitaiton", "parameters": [ { "name": "recitation_id", "in": "path", "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "schema": { "type": "number" } }, { "name": "juz_number", "in": "path", "required": true, "schema": { "maximum": 30, "minimum": 1, "type": "number" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": ["audio_files", "pagination"], "type": "object", "properties": { "audio_files": { "type": "array", "items": { "$ref": "#/components/schemas/audiofile" } }, "pagination": { "$ref": "#/components/schemas/pagination" } } }, "example": { "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": 2, "total_records": 20 } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/recitations/{recitation_id}/by_page/{page_number}": { "get": { "tags": ["Audio"], "summary": "Get Ayah recitations for specific Madani Mushaf page", "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Madani Mushaf page.", "operationId": "list-page-recitaiton", "parameters": [ { "name": "recitation_id", "in": "path", "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "schema": { "type": "number" } }, { "name": "page_number", "in": "path", "required": true, "schema": { "maximum": 604, "minimum": 1, "type": "number" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": ["audio_files", "pagination"], "type": "object", "properties": { "audio_files": { "type": "array", "items": { "$ref": "#/components/schemas/audiofile" } }, "pagination": { "$ref": "#/components/schemas/pagination" } } }, "example": { "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 } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/recitations/{recitation_id}/by_rub/{rub_el_hizb_number}": { "get": { "tags": ["Audio"], "summary": "Get Ayah recitations for specific Rub el Hizb", "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Rub el Hizb.", "operationId": "list-rub-el-hizb-recitaiton", "parameters": [ { "name": "recitation_id", "in": "path", "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "schema": { "type": "number" } }, { "name": "rub_el_hizb_number", "in": "path", "required": true, "schema": { "maximum": 240, "minimum": 1, "type": "number" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": ["audio_files", "pagination"], "type": "object", "properties": { "audio_files": { "type": "array", "items": { "$ref": "#/components/schemas/audiofile" } }, "pagination": { "$ref": "#/components/schemas/pagination" } } }, "example": { "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 } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/recitations/{recitation_id}/by_hizb/{hizb_number}": { "get": { "tags": ["Audio"], "summary": "Get Ayah recitations for specific Hizb", "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Hizb.", "operationId": "list-hizb-recitaiton", "parameters": [ { "name": "recitation_id", "in": "path", "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "schema": { "type": "number" } }, { "name": "hizb_number", "in": "path", "required": true, "schema": { "maximum": 60, "minimum": 1, "type": "number" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": ["audio_files", "pagination"], "type": "object", "properties": { "audio_files": { "type": "array", "items": { "$ref": "#/components/schemas/audiofile" } }, "pagination": { "$ref": "#/components/schemas/pagination" } } }, "example": { "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 } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/recitations/{recitation_id}/by_ayah/{ayah_key}": { "get": { "tags": ["Audio"], "summary": "Get Ayah recitations for specific Ayah", "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Hizb.", "operationId": "list-ayah-recitaiton", "parameters": [ { "name": "recitation_id", "in": "path", "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "schema": { "type": "number" } }, { "name": "ayah_key", "in": "path", "description": "Ayah key is combination of surah number and ayah number. e.g 1:1 will be first Ayah of first Surah", "required": true, "schema": { "maximum": 60, "minimum": 1, "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": ["audio_files", "pagination"], "type": "object", "properties": { "audio_files": { "type": "array", "items": { "$ref": "#/components/schemas/audiofile" } }, "pagination": { "$ref": "#/components/schemas/pagination" } } }, "example": { "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 } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/resources/recitations/{recitation_id}/info": { "get": { "tags": ["Resources"], "summary": "Recitation Info", "description": "Get information of a specific recitation. Could include detail about the reciter, recitation style. When and who recorded it etc.", "operationId": "recitation-info", "parameters": [ { "name": "recitation_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "object", "properties": { "id": { "type": "integer" } } } } }, "example": { "info": { "id": 1, "info": null } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/resources/translations/{translation_id}/info": { "get": { "tags": ["Resources"], "summary": "Translation Info", "description": "Get information of a specific translation. Could include detail about the author, publishing date and publisher etc.", "operationId": "translation-info", "parameters": [ { "name": "translation_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "object", "properties": { "id": { "type": "integer" } } } } }, "example": { "info": { "id": 1, "info": null } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/resources/translations": { "get": { "tags": ["Resources"], "summary": "Translations", "description": "Get list of available translations. Use `language` query to get translated names of authors in specific language(e.g language=ur will send translation names in Urdu). \n\nFor list of available language see #endpoint:EZsWyDnekGaDKaCpt endpoint.", "operationId": "translations", "parameters": [ { "name": "language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "translations": { "type": "array", "items": { "$ref": "#/components/schemas/resource" } } } }, "example": { "translations": [ { "id": 131, "name": "Dr. Mustafa Khattab, the Clear Quran", "author_name": "Dr. Mustafa Khattab", "slug": "clearquran-with-tafsir", "language_name": "english", "translated_name": { "name": "Dr. Mustafa Khattab", "language_name": "english" } } ] } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/resources/tafsirs": { "get": { "tags": ["Resources"], "summary": "Tafsirs", "description": "Get list of available tafsirs.", "operationId": "tafsirs", "parameters": [ { "name": "language", "in": "query", "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "tafsirs": { "type": "array", "items": { "$ref": "#/components/schemas/resource" } } } }, "example": { "tafsirs": [ { "id": 169, "name": "Tafsir Ibn Kathir", "author_name": "Hafiz Ibn Kathir", "slug": "en-tafisr-ibn-kathir", "language_name": "english", "translated_name": { "name": "Tafsir Ibn Kathir", "language_name": "english" } } ] } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/resources/tafsirs/{tafsir_id}/info": { "get": { "tags": ["Resources"], "summary": "Tafsir Info", "description": "Get the information of a specific tafsir. Could include information about the author, when it was published etc.", "operationId": "tafsir-info", "parameters": [ { "name": "tafsir_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/resources/recitation_styles": { "get": { "tags": ["Resources"], "summary": "Recitation Styles", "description": "Get the available recitation styles.", "operationId": "recitation-styles", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "mujawwad": { "type": "string" }, "murattal": { "type": "string" }, "muallim": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/resources/languages": { "get": { "tags": ["Resources"], "summary": "Languages", "description": "Get all languages. You can get translated names of languages in specific language using `language` query parameter. For example \n\n ```\n /resources/languages?language=ur\n ```\n \nwill return language names translated into Urdu", "operationId": "languages", "parameters": [ { "name": "language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/language" } }, "example": [ { "id": -71611860, "iso_code": "amet" } ] } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/resources/chapter_infos": { "get": { "tags": ["Resources"], "summary": "Chapter Infos", "description": "Get list of chaper info we've in different languages.", "operationId": "chapter-info", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "chapter_infos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "author_name": { "type": "string" }, "language_name": { "type": "string" }, "translated_name": { "type": "object", "properties": { "name": { "type": "string" }, "language_name": { "type": "string" } } } } } } } }, "example": { "chapter_infos": [ { "id": 155, "name": "Hamza Roberto Piccardo", "author_name": "Hamza Roberto Piccardo", "slug": "hamza-roberto-piccardo-info", "language_name": "italian", "translated_name": { "name": "Hamza Roberto Piccardo", "language_name": "english" } }, { "id": 63, "name": "Chapter Info", "author_name": "Sayyid Abul Ala Maududi", "slug": null, "language_name": "malayalam", "translated_name": { "name": "Chapter Info", "language_name": "english" } }, { "id": 62, "name": "Chapter Info", "author_name": "Sayyid Abul Ala Maududi", "slug": null, "language_name": "tamil", "translated_name": { "name": "Chapter Info", "language_name": "english" } }, { "id": 61, "name": "Chapter Info", "author_name": "Sayyid Abul Ala Maududi", "slug": null, "language_name": "urdu", "translated_name": { "name": "Chapter Info", "language_name": "english" } } ] } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/resources/verse_media": { "get": { "tags": ["Resources"], "summary": "Verse Media", "description": "Get media related to the verse.", "operationId": "verse-media", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "author_name": { "type": "string" }, "language_name": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/invalidRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "422": { "$ref": "#/components/responses/unprocessableEntity" }, "500": { "$ref": "#/components/responses/internalServerError" }, "502": { "$ref": "#/components/responses/badGateway" }, "503": { "$ref": "#/components/responses/serviceUnavailable" }, "504": { "$ref": "#/components/responses/gatewayTimeout" }, "429": { "$ref": "#/components/responses/rateLimitExceeded" } } } }, "/search": { "get": { "tags": ["Search"], "operationId": "search", "parameters": [ { "name": "q", "in": "query", "description": "Search query, you can use *query* as well", "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "Results per page. *s* is also valid parameter.", "schema": { "type": "number", "default": 20 } }, { "name": "page", "in": "query", "description": "Page number, well for pagination. You can use *p* as well", "schema": { "type": "number", "default": 0 } }, { "name": "language", "in": "query", "description": "ISO code of language, use this query params if you want to boost translations for specific language. \nFor list of available language see #endpoint:8rjMCZEyPEZMHAKz9 endpoint.", "schema": { "type": "string", "default": "en" } } ], "responses": { "default": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } } } } } }, "components": { "schemas": { "audiofile": { "title": "AudioFile", "type": "object", "properties": { "url": { "type": "string" }, "duration": { "type": "number" }, "format": { "type": "string" }, "segments": { "type": "array", "items": { "type": "object" } } }, "example": { "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] ] ] } }, "author": { "title": "Author", "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "number" } }, "example": { "name": "Dr. Ghali" } }, "chapter-info": { "title": "Chapter Info", "required": ["chapter_id", "short_text", "source", "text"], "type": "object", "properties": { "chapter_id": { "type": "number" }, "text": { "type": "string", "description": "Long text of chapter info, this could include html tags for formatting and styling." }, "short_text": { "type": "string" }, "language_name": { "type": "string" }, "source": { "type": "string", "description": "Name of the source, could be a book name or site name." } }, "example": { "chapter_id": 1, "text": "
This Surah is named Al-Fatihah because of its subject-matter. Fatihah is that which opens a subject or a book or any other thing. In other words, Al-Fatihah is a sort of preface.
...", "short_text": "This Surah is named Al-Fatihah because of its subject-matter. Fatihah is that which opens a subject or a book or any other thing. In other words, Al-Fatihah is a sort of preface.", "language_name": "English", "source": "Sayyid Abul Ala Maududi - Tafhim al-Qur'an - The Meaning of the Quran" } }, "language": { "title": "Language", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "native_name": { "type": "string" }, "iso_code": { "type": "string", "description": "iso code of the language, you'll pass this code in api calls for fetching content in specific language." }, "direction": { "type": "string" }, "translated_names": { "type": "array", "items": { "$ref": "#/components/schemas/translated-name" } } }, "example": { "id": 1, "name": "English", "native_name": "English", "iso_code": "en", "direction": "ltr", "translated_names": [ { "name": "انگریزی", "language_name": "Urdu" } ] } }, "media-content": { "title": "MediaContent", "type": "object", "properties": { "url": { "type": "string" }, "embed_text": { "type": "string" }, "provider": { "type": "string" }, "author_name": { "type": "string" } }, "example": { "url": "https://www.youtube.com/embed/JyLuLv2hrAo?autoplay=1", "embed_text": "", "provider": "YouTube", "author_name": "Bayyinah" } }, "recitation": { "title": "Recitation", "type": "object", "properties": { "id": { "type": "integer" }, "reciter_name": { "type": "string" }, "style": { "type": "string" }, "translated_name": { "type": "object", "properties": { "name": { "type": "string" }, "language_name": { "type": "string" } } } }, "example": { "id": 1, "reciter_name": "AbdulBaset AbdulSamad", "style": "Mujawwad", "translated_name": { "name": "AbdulBaset AbdulSamad", "language_name": "english" } } }, "tafsir": { "title": "Tafsir", "type": "object", "properties": { "id": { "type": "integer" }, "verse_id": { "type": "integer" }, "language_id": { "type": "integer" }, "text": { "type": "string" }, "language_name": { "type": "string" }, "resource_name": { "type": "string" }, "verse_key": { "type": "string" }, "chapter_id": { "type": "integer" }, "verse_number": { "type": "integer" }, "juz_number": { "type": "integer" }, "hizb_number": { "type": "integer" }, "rub_el_hizb_number": { "type": "integer" }, "page_number": { "type": "integer" } }, "example": { "verse_id": 1, "language_id": 38, "text": "Bismillah بِسْمِ اللَّـهِ is a verse of the Holy Qur'an
", "language_name": "english", "resource_name": "Maarif-ul-Quran", "verse_key": "1:1", "chapter_id": 1, "verse_number": 1, "juz_number": 1, "hizb_number": 1, "rub_number": 1, "page_number": 1 } }, "translated-name": { "title": "TranslatedName", "required": ["language_name", "name"], "type": "object", "properties": { "language_name": { "type": "string", "default": "english" }, "name": { "type": "string", "description": "Name of the resource in specific language." } }, "example": { "language_name": "english", "name": "The Opener" } }, "translation": { "title": "Translation", "required": ["resource_id", "text"], "type": "object", "properties": { "resource_id": { "type": "integer" }, "resource_name": { "type": "string" }, "id": { "type": "integer" }, "text": { "type": "string", "description": "Text of the translation, text could have HTML tags for formatting and footnotes. " }, "verse_id": { "type": "integer" }, "language_id": { "type": "integer" }, "language_name": { "type": "string" }, "verse_key": { "type": "string" }, "chapter_id": { "type": "integer" }, "verse_number": { "type": "integer" }, "juz_number": { "type": "integer" }, "hizb_number": { "type": "integer" }, "rub_number": { "type": "integer" }, "page_number": { "type": "integer" } }, "example": { "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 } }, "transliteration": { "title": "Transliteration", "type": "object", "properties": { "language_name": { "type": "string" }, "text": { "type": "string" } } }, "verse": { "title": "Verse", "required": [ "hizb_number", "id", "juz_number", "page_number", "rub_number", "verse_key", "verse_number" ], "type": "object", "properties": { "id": { "type": "integer" }, "chapter_id": { "type": "integer", "description": "Chapter number of this verse" }, "verse_number": { "type": "integer" }, "verse_key": { "type": "string", "description": "key of the verse, key is generated using chapter number and ayah number. e.g 1:1 is first ayah of first surah." }, "verse_index": { "type": "integer" }, "text_uthmani": { "type": "string", "description": "Ayah text in Uthmani Script.\n\nUthmani script is an old-fashion script used by the third Caliph, Uthman, to produce the first standard quran manuscript." }, "text_uthmani_simple": { "type": "string", "description": "Uthmani script diacritic marks " }, "text_imlaei": { "type": "string", "description": "Ayah text in Imla'ei script.\n\nImla'ei script, is the modern Arabic writing style which is currently in use." }, "text_imlaei_simple": { "type": "string" }, "text_indopak": { "type": "string" }, "text_uthmani_tajweed": { "type": "string" }, "juz_number": { "type": "integer" }, "hizb_number": { "type": "integer" }, "rub_number": { "type": "integer" }, "page_number": { "maximum": 604, "minimum": 1, "type": "integer", "description": "page_number is deperacted, please use `v1_page` instead." }, "image_url": { "type": "string" }, "image_width": { "type": "integer" }, "words": { "type": "array", "items": { "$ref": "#/components/schemas/word" } }, "audio": { "$ref": "#/components/schemas/audiofile" }, "translations": { "type": "array", "items": { "$ref": "#/components/schemas/translation" } }, "code_v1": { "type": "string", "description": "Glyphs codes for QCF v1 fonts" }, "code_v2": { "type": "string", "description": "Glyphs codes for QCF v2 fonts" }, "v1_page": { "maximum": 604, "minimum": 1, "type": "integer", "description": "Madani Muhsaf Page number for v1 font. If `v1_page` value is 2, that means you'll use page 2 font file to render this ayah using v1 glyph codes." }, "v2_page": { "maximum": 604, "minimum": 1, "type": "integer", "description": "Madani Muhsaf Page number for v2 font. If `v2_page` value is 2, that means you'll use page 2 font file to render this ayah using v2 glyph codes." } }, "example": { "id": 1, "chapter_id": 1, "verse_number": 1, "verse_key": "1:1", "verse_index": 1, "text_uthmani": "بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ", "text_uthmani_simple": "بسم الله الرحمن الرحيم", "text_imlaei": "بِسْمِ اللَّهِ الرَّحْمَٰنِ الرَّحِيمِ", "text_imlaei_simple": "بسم الله الرحمن الرحيم", "text_indopak": "بِسۡمِ اللهِ الرَّحۡمٰنِ الرَّحِيۡمِ", "text_uthmani_tajweed": "بِسْمِ