From 12c26350d0483bd2b5b32ca93226ea014c45477f Mon Sep 17 00:00:00 2001 From: Amna Khan <97763397+AmnaKhan15@users.noreply.github.com> Date: Mon, 22 Jan 2024 22:23:41 +0500 Subject: [PATCH 1/2] fixing type exampke with example --- docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx | 6 +++--- docs/quran.com_versioned/verses-by-verse-key.api.mdx | 6 +++--- openAPI/quran.com/v4.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx b/docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx index 8876a8d..7f974dc 100644 --- a/docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx +++ b/docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx @@ -1,11 +1,11 @@ --- id: verses-by-verse-key title: "By Specific Verse By Key" -description: "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke." +description: "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example." sidebar_label: "By Specific Verse By Key" hide_title: true hide_table_of_contents: true -api: {"operationId":"verses-by_verse_key","tags":["Verses"],"description":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke.\n\n10:5 is 5th ayah of 10th surah.","parameters":[{"name":"language","in":"query","description":"Language to fetch word translation in specific language.","schema":{"type":"string","default":"en"}},{"name":"words","in":"query","description":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","schema":{"type":"string","enum":[true,false],"default":true}},{"name":"translations","in":"query","description":"comma separated ids of translations to load for each ayah.","schema":{"type":"string"}},{"name":"audio","in":"query","description":"Id of recitation if you want to load audio of each ayah.","schema":{"type":"integer"}},{"name":"tafsirs","in":"query","description":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","schema":{"type":"string"}},{"name":"word_fields","in":"query","description":"Comma separated list of word fields if you want to add more fields for each word. ","schema":{"type":"string"}},{"name":"translation_fields","in":"query","description":"Comma separated list of translation fields if you want to add more fields for each translation. ","schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma separated list of ayah fields.","schema":{"type":"string"}},{"name":"verse_key","in":"path","description":"Verse key ( chapter:verse) ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"verse":{"title":"Verse","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"},"sajdah_type":{"nullable":true},"sajdah_number":{"nullable":true},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"image_url":{"type":"string"},"image_width":{"type":"integer"},"words":{"type":"array","items":{"title":"Word","type":"object","properties":{"id":{"type":"integer"},"position":{"type":"integer","description":"Word position within ayah"},"text_uthmani":{"type":"string","description":"Word text in Uthmanic script"},"text_indopak":{"type":"string"},"text_imlaei":{"type":"string","description":"Word text in simple/Imlaei script"},"verse_key":{"type":"string"},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"line_number":{"type":"integer","description":"Line number in the Muhsaf for this word"},"audio_url":{"type":"string"},"location":{"type":"string"},"char_type_name":{"type":"string"},"code_v1":{"type":"string","description":"glyph code that you can use to render the word using QCF v1 font."},"code_v2":{"type":"string","description":"glyph code that you can use to render the word using QCF v2 font."},"translation":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"transliteration":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"v1_page":{"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 word using v1 glyph codes.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["position","audio_url","char_type_name","translation","transliteration"],"example":{"id":1,"position":1,"text_uthmani":"بِسْمِ","text_indopak":"بِسۡمِ","text_imlaei":"بِسْمِ","verse_key":"1:1","page_number":1,"line_number":2,"audio_url":"wbw/001_001_001.mp3","location":"1:1:1","char_type_name":"word","code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}}},"audio":{"title":"AudioFile","type":"object","properties":{"url":{"type":"string"},"duration":{"type":"number"},"format":{"type":"string"},"segments":{"type":"array","items":{}}},"example":{"url":"https://verses.quran.com/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]]]}},"translations":{"type":"array","items":{"title":"Translation","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"}},"required":["resource_id","text"],"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}}},"code_v1":{"type":"string","description":"Glyphs codes for QCF v1 fonts"},"code_v2":{"type":"string","description":"Glyphs codes for QCF v2 fonts"},"v1_page":{"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.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["id","verse_number","verse_key","juz_number","hizb_number","rub_number","sajdah_type","sajdah_number","page_number"],"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":"بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ ١","juz_number":1,"hizb_number":1,"rub_number":1,"sajdah_type":null,"sajdah_number":null,"page_number":1,"image_url":"//c22506.r6.cf1.rackcdn.com/1_1.png","image_width":675,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}]}}},"required":["verse"]},"examples":{"response":{"value":{"verse":{"id":1,"verse_number":1,"page_number":1,"verse_key":"1:1","juz_number":1,"hizb_number":1,"rub_el_hizb_number":1,"sajdah_type":null,"sajdah_number":null,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","line_number":2,"page_number":1,"code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}],"translations":[{"resource_id":131,"text":"In the Name of Allah—the Most Compassionate, Most Merciful."}],"tafsirs":[{"id":82641,"language_name":"english","name":"Tafsir Ibn Kathir","text":"

Which was revealed in Makkah

The Meaning of Al-Fatihah and its Various Names

"}]}}}}}}}},"method":"get","path":"/verses/by_key/{verse_key}","servers":[{"url":"https://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"By Specific Verse By Key","description":{"content":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke.\n\n10:5 is 5th ayah of 10th surah.","type":"text/plain"},"url":{"path":["verses","by_key",":verse_key"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Language to fetch word translation in specific language.","type":"text/plain"},"key":"language","value":""},{"disabled":false,"description":{"content":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","type":"text/plain"},"key":"words","value":""},{"disabled":false,"description":{"content":"comma separated ids of translations to load for each ayah.","type":"text/plain"},"key":"translations","value":""},{"disabled":false,"description":{"content":"Id of recitation if you want to load audio of each ayah.","type":"text/plain"},"key":"audio","value":""},{"disabled":false,"description":{"content":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","type":"text/plain"},"key":"tafsirs","value":""},{"disabled":false,"description":{"content":"Comma separated list of word fields if you want to add more fields for each word. ","type":"text/plain"},"key":"word_fields","value":""},{"disabled":false,"description":{"content":"Comma separated list of translation fields if you want to add more fields for each translation. ","type":"text/plain"},"key":"translation_fields","value":""},{"disabled":false,"description":{"content":"comma separated list of ayah fields.","type":"text/plain"},"key":"fields","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Verse key ( chapter:verse) ","type":"text/plain"},"type":"any","value":"","key":"verse_key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"operationId":"verses-by_verse_key","tags":["Verses"],"description":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.","parameters":[{"name":"language","in":"query","description":"Language to fetch word translation in specific language.","schema":{"type":"string","default":"en"}},{"name":"words","in":"query","description":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","schema":{"type":"string","enum":[true,false],"default":true}},{"name":"translations","in":"query","description":"comma separated ids of translations to load for each ayah.","schema":{"type":"string"}},{"name":"audio","in":"query","description":"Id of recitation if you want to load audio of each ayah.","schema":{"type":"integer"}},{"name":"tafsirs","in":"query","description":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","schema":{"type":"string"}},{"name":"word_fields","in":"query","description":"Comma separated list of word fields if you want to add more fields for each word. ","schema":{"type":"string"}},{"name":"translation_fields","in":"query","description":"Comma separated list of translation fields if you want to add more fields for each translation. ","schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma separated list of ayah fields.","schema":{"type":"string"}},{"name":"verse_key","in":"path","description":"Verse key ( chapter:verse) ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"verse":{"title":"Verse","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"},"sajdah_type":{"nullable":true},"sajdah_number":{"nullable":true},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"image_url":{"type":"string"},"image_width":{"type":"integer"},"words":{"type":"array","items":{"title":"Word","type":"object","properties":{"id":{"type":"integer"},"position":{"type":"integer","description":"Word position within ayah"},"text_uthmani":{"type":"string","description":"Word text in Uthmanic script"},"text_indopak":{"type":"string"},"text_imlaei":{"type":"string","description":"Word text in simple/Imlaei script"},"verse_key":{"type":"string"},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"line_number":{"type":"integer","description":"Line number in the Muhsaf for this word"},"audio_url":{"type":"string"},"location":{"type":"string"},"char_type_name":{"type":"string"},"code_v1":{"type":"string","description":"glyph code that you can use to render the word using QCF v1 font."},"code_v2":{"type":"string","description":"glyph code that you can use to render the word using QCF v2 font."},"translation":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"transliteration":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"v1_page":{"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 word using v1 glyph codes.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["position","audio_url","char_type_name","translation","transliteration"],"example":{"id":1,"position":1,"text_uthmani":"بِسْمِ","text_indopak":"بِسۡمِ","text_imlaei":"بِسْمِ","verse_key":"1:1","page_number":1,"line_number":2,"audio_url":"wbw/001_001_001.mp3","location":"1:1:1","char_type_name":"word","code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}}},"audio":{"title":"AudioFile","type":"object","properties":{"url":{"type":"string"},"duration":{"type":"number"},"format":{"type":"string"},"segments":{"type":"array","items":{}}},"example":{"url":"https://verses.quran.com/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]]]}},"translations":{"type":"array","items":{"title":"Translation","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"}},"required":["resource_id","text"],"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}}},"code_v1":{"type":"string","description":"Glyphs codes for QCF v1 fonts"},"code_v2":{"type":"string","description":"Glyphs codes for QCF v2 fonts"},"v1_page":{"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.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["id","verse_number","verse_key","juz_number","hizb_number","rub_number","sajdah_type","sajdah_number","page_number"],"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":"بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ ١","juz_number":1,"hizb_number":1,"rub_number":1,"sajdah_type":null,"sajdah_number":null,"page_number":1,"image_url":"//c22506.r6.cf1.rackcdn.com/1_1.png","image_width":675,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}]}}},"required":["verse"]},"examples":{"response":{"value":{"verse":{"id":1,"verse_number":1,"page_number":1,"verse_key":"1:1","juz_number":1,"hizb_number":1,"rub_el_hizb_number":1,"sajdah_type":null,"sajdah_number":null,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","line_number":2,"page_number":1,"code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}],"translations":[{"resource_id":131,"text":"In the Name of Allah—the Most Compassionate, Most Merciful."}],"tafsirs":[{"id":82641,"language_name":"english","name":"Tafsir Ibn Kathir","text":"

Which was revealed in Makkah

The Meaning of Al-Fatihah and its Various Names

"}]}}}}}}}},"method":"get","path":"/verses/by_key/{verse_key}","servers":[{"url":"https://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"By Specific Verse By Key","description":{"content":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.","type":"text/plain"},"url":{"path":["verses","by_key",":verse_key"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Language to fetch word translation in specific language.","type":"text/plain"},"key":"language","value":""},{"disabled":false,"description":{"content":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","type":"text/plain"},"key":"words","value":""},{"disabled":false,"description":{"content":"comma separated ids of translations to load for each ayah.","type":"text/plain"},"key":"translations","value":""},{"disabled":false,"description":{"content":"Id of recitation if you want to load audio of each ayah.","type":"text/plain"},"key":"audio","value":""},{"disabled":false,"description":{"content":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","type":"text/plain"},"key":"tafsirs","value":""},{"disabled":false,"description":{"content":"Comma separated list of word fields if you want to add more fields for each word. ","type":"text/plain"},"key":"word_fields","value":""},{"disabled":false,"description":{"content":"Comma separated list of translation fields if you want to add more fields for each translation. ","type":"text/plain"},"key":"translation_fields","value":""},{"disabled":false,"description":{"content":"comma separated list of ayah fields.","type":"text/plain"},"key":"fields","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Verse key ( chapter:verse) ","type":"text/plain"},"type":"any","value":"","key":"verse_key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/quran.com_versioned/4.0.0/quran-com-api custom_edit_url: null @@ -24,7 +24,7 @@ import TabItem from "@theme/TabItem"; -Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke. +Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example. 10:5 is 5th ayah of 10th surah. diff --git a/docs/quran.com_versioned/verses-by-verse-key.api.mdx b/docs/quran.com_versioned/verses-by-verse-key.api.mdx index 7fece52..5b9f113 100644 --- a/docs/quran.com_versioned/verses-by-verse-key.api.mdx +++ b/docs/quran.com_versioned/verses-by-verse-key.api.mdx @@ -1,11 +1,11 @@ --- id: verses-by-verse-key title: "By Specific Verse By Key" -description: "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke." +description: "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example." sidebar_label: "By Specific Verse By Key" hide_title: true hide_table_of_contents: true -api: {"operationId":"verses-by_verse_key","tags":["Verses"],"description":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke.\n\n10:5 is 5th ayah of 10th surah.","parameters":[{"name":"language","in":"query","description":"Language to fetch word translation in specific language.","schema":{"type":"string","default":"en"}},{"name":"words","in":"query","description":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","schema":{"type":"string","enum":[true,false],"default":true}},{"name":"translations","in":"query","description":"comma separated ids of translations to load for each ayah.","schema":{"type":"string"}},{"name":"audio","in":"query","description":"Id of recitation if you want to load audio of each ayah.","schema":{"type":"integer"}},{"name":"tafsirs","in":"query","description":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","schema":{"type":"string"}},{"name":"word_fields","in":"query","description":"Comma separated list of word fields if you want to add more fields for each word. ","schema":{"type":"string"}},{"name":"translation_fields","in":"query","description":"Comma separated list of translation fields if you want to add more fields for each translation. ","schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma separated list of ayah fields.","schema":{"type":"string"}},{"name":"verse_key","in":"path","description":"Verse key ( chapter:verse) ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"verse":{"title":"Verse","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"},"sajdah_type":{"nullable":true},"sajdah_number":{"nullable":true},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"image_url":{"type":"string"},"image_width":{"type":"integer"},"words":{"type":"array","items":{"title":"Word","type":"object","properties":{"id":{"type":"integer"},"position":{"type":"integer","description":"Word position within ayah"},"text_uthmani":{"type":"string","description":"Word text in Uthmanic script"},"text_indopak":{"type":"string"},"text_imlaei":{"type":"string","description":"Word text in simple/Imlaei script"},"verse_key":{"type":"string"},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"line_number":{"type":"integer","description":"Line number in the Muhsaf for this word"},"audio_url":{"type":"string"},"location":{"type":"string"},"char_type_name":{"type":"string"},"code_v1":{"type":"string","description":"glyph code that you can use to render the word using QCF v1 font."},"code_v2":{"type":"string","description":"glyph code that you can use to render the word using QCF v2 font."},"translation":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"transliteration":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"v1_page":{"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 word using v1 glyph codes.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["position","audio_url","char_type_name","translation","transliteration"],"example":{"id":1,"position":1,"text_uthmani":"بِسْمِ","text_indopak":"بِسۡمِ","text_imlaei":"بِسْمِ","verse_key":"1:1","page_number":1,"line_number":2,"audio_url":"wbw/001_001_001.mp3","location":"1:1:1","char_type_name":"word","code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}}},"audio":{"title":"AudioFile","type":"object","properties":{"url":{"type":"string"},"duration":{"type":"number"},"format":{"type":"string"},"segments":{"type":"array","items":{}}},"example":{"url":"https://verses.quran.com/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]]]}},"translations":{"type":"array","items":{"title":"Translation","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"}},"required":["resource_id","text"],"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}}},"code_v1":{"type":"string","description":"Glyphs codes for QCF v1 fonts"},"code_v2":{"type":"string","description":"Glyphs codes for QCF v2 fonts"},"v1_page":{"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.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["id","verse_number","verse_key","juz_number","hizb_number","rub_number","sajdah_type","sajdah_number","page_number"],"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":"بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ ١","juz_number":1,"hizb_number":1,"rub_number":1,"sajdah_type":null,"sajdah_number":null,"page_number":1,"image_url":"//c22506.r6.cf1.rackcdn.com/1_1.png","image_width":675,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}]}}},"required":["verse"]},"examples":{"response":{"value":{"verse":{"id":1,"verse_number":1,"page_number":1,"verse_key":"1:1","juz_number":1,"hizb_number":1,"rub_el_hizb_number":1,"sajdah_type":null,"sajdah_number":null,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","line_number":2,"page_number":1,"code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}],"translations":[{"resource_id":131,"text":"In the Name of Allah—the Most Compassionate, Most Merciful."}],"tafsirs":[{"id":82641,"language_name":"english","name":"Tafsir Ibn Kathir","text":"

Which was revealed in Makkah

The Meaning of Al-Fatihah and its Various Names

"}]}}}}}}}},"method":"get","path":"/verses/by_key/{verse_key}","servers":[{"url":"https://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"By Specific Verse By Key","description":{"content":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke.\n\n10:5 is 5th ayah of 10th surah.","type":"text/plain"},"url":{"path":["verses","by_key",":verse_key"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Language to fetch word translation in specific language.","type":"text/plain"},"key":"language","value":""},{"disabled":false,"description":{"content":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","type":"text/plain"},"key":"words","value":""},{"disabled":false,"description":{"content":"comma separated ids of translations to load for each ayah.","type":"text/plain"},"key":"translations","value":""},{"disabled":false,"description":{"content":"Id of recitation if you want to load audio of each ayah.","type":"text/plain"},"key":"audio","value":""},{"disabled":false,"description":{"content":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","type":"text/plain"},"key":"tafsirs","value":""},{"disabled":false,"description":{"content":"Comma separated list of word fields if you want to add more fields for each word. ","type":"text/plain"},"key":"word_fields","value":""},{"disabled":false,"description":{"content":"Comma separated list of translation fields if you want to add more fields for each translation. ","type":"text/plain"},"key":"translation_fields","value":""},{"disabled":false,"description":{"content":"comma separated list of ayah fields.","type":"text/plain"},"key":"fields","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Verse key ( chapter:verse) ","type":"text/plain"},"type":"any","value":"","key":"verse_key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"operationId":"verses-by_verse_key","tags":["Verses"],"description":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.","parameters":[{"name":"language","in":"query","description":"Language to fetch word translation in specific language.","schema":{"type":"string","default":"en"}},{"name":"words","in":"query","description":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","schema":{"type":"string","enum":[true,false],"default":true}},{"name":"translations","in":"query","description":"comma separated ids of translations to load for each ayah.","schema":{"type":"string"}},{"name":"audio","in":"query","description":"Id of recitation if you want to load audio of each ayah.","schema":{"type":"integer"}},{"name":"tafsirs","in":"query","description":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","schema":{"type":"string"}},{"name":"word_fields","in":"query","description":"Comma separated list of word fields if you want to add more fields for each word. ","schema":{"type":"string"}},{"name":"translation_fields","in":"query","description":"Comma separated list of translation fields if you want to add more fields for each translation. ","schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma separated list of ayah fields.","schema":{"type":"string"}},{"name":"verse_key","in":"path","description":"Verse key ( chapter:verse) ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"verse":{"title":"Verse","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"},"sajdah_type":{"nullable":true},"sajdah_number":{"nullable":true},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"image_url":{"type":"string"},"image_width":{"type":"integer"},"words":{"type":"array","items":{"title":"Word","type":"object","properties":{"id":{"type":"integer"},"position":{"type":"integer","description":"Word position within ayah"},"text_uthmani":{"type":"string","description":"Word text in Uthmanic script"},"text_indopak":{"type":"string"},"text_imlaei":{"type":"string","description":"Word text in simple/Imlaei script"},"verse_key":{"type":"string"},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"line_number":{"type":"integer","description":"Line number in the Muhsaf for this word"},"audio_url":{"type":"string"},"location":{"type":"string"},"char_type_name":{"type":"string"},"code_v1":{"type":"string","description":"glyph code that you can use to render the word using QCF v1 font."},"code_v2":{"type":"string","description":"glyph code that you can use to render the word using QCF v2 font."},"translation":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"transliteration":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"v1_page":{"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 word using v1 glyph codes.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["position","audio_url","char_type_name","translation","transliteration"],"example":{"id":1,"position":1,"text_uthmani":"بِسْمِ","text_indopak":"بِسۡمِ","text_imlaei":"بِسْمِ","verse_key":"1:1","page_number":1,"line_number":2,"audio_url":"wbw/001_001_001.mp3","location":"1:1:1","char_type_name":"word","code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}}},"audio":{"title":"AudioFile","type":"object","properties":{"url":{"type":"string"},"duration":{"type":"number"},"format":{"type":"string"},"segments":{"type":"array","items":{}}},"example":{"url":"https://verses.quran.com/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]]]}},"translations":{"type":"array","items":{"title":"Translation","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"}},"required":["resource_id","text"],"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}}},"code_v1":{"type":"string","description":"Glyphs codes for QCF v1 fonts"},"code_v2":{"type":"string","description":"Glyphs codes for QCF v2 fonts"},"v1_page":{"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.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["id","verse_number","verse_key","juz_number","hizb_number","rub_number","sajdah_type","sajdah_number","page_number"],"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":"بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ ١","juz_number":1,"hizb_number":1,"rub_number":1,"sajdah_type":null,"sajdah_number":null,"page_number":1,"image_url":"//c22506.r6.cf1.rackcdn.com/1_1.png","image_width":675,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}]}}},"required":["verse"]},"examples":{"response":{"value":{"verse":{"id":1,"verse_number":1,"page_number":1,"verse_key":"1:1","juz_number":1,"hizb_number":1,"rub_el_hizb_number":1,"sajdah_type":null,"sajdah_number":null,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","line_number":2,"page_number":1,"code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}],"translations":[{"resource_id":131,"text":"In the Name of Allah—the Most Compassionate, Most Merciful."}],"tafsirs":[{"id":82641,"language_name":"english","name":"Tafsir Ibn Kathir","text":"

Which was revealed in Makkah

The Meaning of Al-Fatihah and its Various Names

"}]}}}}}}}},"method":"get","path":"/verses/by_key/{verse_key}","servers":[{"url":"https://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"By Specific Verse By Key","description":{"content":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.","type":"text/plain"},"url":{"path":["verses","by_key",":verse_key"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Language to fetch word translation in specific language.","type":"text/plain"},"key":"language","value":""},{"disabled":false,"description":{"content":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","type":"text/plain"},"key":"words","value":""},{"disabled":false,"description":{"content":"comma separated ids of translations to load for each ayah.","type":"text/plain"},"key":"translations","value":""},{"disabled":false,"description":{"content":"Id of recitation if you want to load audio of each ayah.","type":"text/plain"},"key":"audio","value":""},{"disabled":false,"description":{"content":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","type":"text/plain"},"key":"tafsirs","value":""},{"disabled":false,"description":{"content":"Comma separated list of word fields if you want to add more fields for each word. ","type":"text/plain"},"key":"word_fields","value":""},{"disabled":false,"description":{"content":"Comma separated list of translation fields if you want to add more fields for each translation. ","type":"text/plain"},"key":"translation_fields","value":""},{"disabled":false,"description":{"content":"comma separated list of ayah fields.","type":"text/plain"},"key":"fields","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Verse key ( chapter:verse) ","type":"text/plain"},"type":"any","value":"","key":"verse_key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/quran.com_versioned/quran-com-api custom_edit_url: null @@ -24,7 +24,7 @@ import TabItem from "@theme/TabItem"; -Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke. +Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example. 10:5 is 5th ayah of 10th surah. diff --git a/openAPI/quran.com/v4.json b/openAPI/quran.com/v4.json index 9665ea4..8123e2b 100644 --- a/openAPI/quran.com/v4.json +++ b/openAPI/quran.com/v4.json @@ -1159,7 +1159,7 @@ "tags": [ "Verses" ], - "description": "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke.\n\n10:5 is 5th ayah of 10th surah.", + "description": "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.", "parameters": [ { "name": "language", From b3cea390267f314054a40ff79fbaf5f094153639 Mon Sep 17 00:00:00 2001 From: Amna Khan <97763397+AmnaKhan15@users.noreply.github.com> Date: Mon, 22 Jan 2024 22:29:13 +0500 Subject: [PATCH 2/2] fix typo offirst with of first --- docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx | 6 +++--- docs/quran.com_versioned/verses-by-verse-key.api.mdx | 6 +++--- openAPI/quran.com/v4.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx b/docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx index 7f974dc..3191b5f 100644 --- a/docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx +++ b/docs/quran.com_versioned/4.0.0/verses-by-verse-key.api.mdx @@ -1,11 +1,11 @@ --- id: verses-by-verse-key title: "By Specific Verse By Key" -description: "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example." +description: "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah of first surah for example." sidebar_label: "By Specific Verse By Key" hide_title: true hide_table_of_contents: true -api: {"operationId":"verses-by_verse_key","tags":["Verses"],"description":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.","parameters":[{"name":"language","in":"query","description":"Language to fetch word translation in specific language.","schema":{"type":"string","default":"en"}},{"name":"words","in":"query","description":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","schema":{"type":"string","enum":[true,false],"default":true}},{"name":"translations","in":"query","description":"comma separated ids of translations to load for each ayah.","schema":{"type":"string"}},{"name":"audio","in":"query","description":"Id of recitation if you want to load audio of each ayah.","schema":{"type":"integer"}},{"name":"tafsirs","in":"query","description":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","schema":{"type":"string"}},{"name":"word_fields","in":"query","description":"Comma separated list of word fields if you want to add more fields for each word. ","schema":{"type":"string"}},{"name":"translation_fields","in":"query","description":"Comma separated list of translation fields if you want to add more fields for each translation. ","schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma separated list of ayah fields.","schema":{"type":"string"}},{"name":"verse_key","in":"path","description":"Verse key ( chapter:verse) ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"verse":{"title":"Verse","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"},"sajdah_type":{"nullable":true},"sajdah_number":{"nullable":true},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"image_url":{"type":"string"},"image_width":{"type":"integer"},"words":{"type":"array","items":{"title":"Word","type":"object","properties":{"id":{"type":"integer"},"position":{"type":"integer","description":"Word position within ayah"},"text_uthmani":{"type":"string","description":"Word text in Uthmanic script"},"text_indopak":{"type":"string"},"text_imlaei":{"type":"string","description":"Word text in simple/Imlaei script"},"verse_key":{"type":"string"},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"line_number":{"type":"integer","description":"Line number in the Muhsaf for this word"},"audio_url":{"type":"string"},"location":{"type":"string"},"char_type_name":{"type":"string"},"code_v1":{"type":"string","description":"glyph code that you can use to render the word using QCF v1 font."},"code_v2":{"type":"string","description":"glyph code that you can use to render the word using QCF v2 font."},"translation":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"transliteration":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"v1_page":{"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 word using v1 glyph codes.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["position","audio_url","char_type_name","translation","transliteration"],"example":{"id":1,"position":1,"text_uthmani":"بِسْمِ","text_indopak":"بِسۡمِ","text_imlaei":"بِسْمِ","verse_key":"1:1","page_number":1,"line_number":2,"audio_url":"wbw/001_001_001.mp3","location":"1:1:1","char_type_name":"word","code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}}},"audio":{"title":"AudioFile","type":"object","properties":{"url":{"type":"string"},"duration":{"type":"number"},"format":{"type":"string"},"segments":{"type":"array","items":{}}},"example":{"url":"https://verses.quran.com/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]]]}},"translations":{"type":"array","items":{"title":"Translation","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"}},"required":["resource_id","text"],"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}}},"code_v1":{"type":"string","description":"Glyphs codes for QCF v1 fonts"},"code_v2":{"type":"string","description":"Glyphs codes for QCF v2 fonts"},"v1_page":{"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.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["id","verse_number","verse_key","juz_number","hizb_number","rub_number","sajdah_type","sajdah_number","page_number"],"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":"بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ ١","juz_number":1,"hizb_number":1,"rub_number":1,"sajdah_type":null,"sajdah_number":null,"page_number":1,"image_url":"//c22506.r6.cf1.rackcdn.com/1_1.png","image_width":675,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}]}}},"required":["verse"]},"examples":{"response":{"value":{"verse":{"id":1,"verse_number":1,"page_number":1,"verse_key":"1:1","juz_number":1,"hizb_number":1,"rub_el_hizb_number":1,"sajdah_type":null,"sajdah_number":null,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","line_number":2,"page_number":1,"code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}],"translations":[{"resource_id":131,"text":"In the Name of Allah—the Most Compassionate, Most Merciful."}],"tafsirs":[{"id":82641,"language_name":"english","name":"Tafsir Ibn Kathir","text":"

Which was revealed in Makkah

The Meaning of Al-Fatihah and its Various Names

"}]}}}}}}}},"method":"get","path":"/verses/by_key/{verse_key}","servers":[{"url":"https://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"By Specific Verse By Key","description":{"content":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.","type":"text/plain"},"url":{"path":["verses","by_key",":verse_key"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Language to fetch word translation in specific language.","type":"text/plain"},"key":"language","value":""},{"disabled":false,"description":{"content":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","type":"text/plain"},"key":"words","value":""},{"disabled":false,"description":{"content":"comma separated ids of translations to load for each ayah.","type":"text/plain"},"key":"translations","value":""},{"disabled":false,"description":{"content":"Id of recitation if you want to load audio of each ayah.","type":"text/plain"},"key":"audio","value":""},{"disabled":false,"description":{"content":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","type":"text/plain"},"key":"tafsirs","value":""},{"disabled":false,"description":{"content":"Comma separated list of word fields if you want to add more fields for each word. ","type":"text/plain"},"key":"word_fields","value":""},{"disabled":false,"description":{"content":"Comma separated list of translation fields if you want to add more fields for each translation. ","type":"text/plain"},"key":"translation_fields","value":""},{"disabled":false,"description":{"content":"comma separated list of ayah fields.","type":"text/plain"},"key":"fields","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Verse key ( chapter:verse) ","type":"text/plain"},"type":"any","value":"","key":"verse_key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"operationId":"verses-by_verse_key","tags":["Verses"],"description":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah of first surah for example.\n\n10:5 is 5th ayah of 10th surah.","parameters":[{"name":"language","in":"query","description":"Language to fetch word translation in specific language.","schema":{"type":"string","default":"en"}},{"name":"words","in":"query","description":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","schema":{"type":"string","enum":[true,false],"default":true}},{"name":"translations","in":"query","description":"comma separated ids of translations to load for each ayah.","schema":{"type":"string"}},{"name":"audio","in":"query","description":"Id of recitation if you want to load audio of each ayah.","schema":{"type":"integer"}},{"name":"tafsirs","in":"query","description":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","schema":{"type":"string"}},{"name":"word_fields","in":"query","description":"Comma separated list of word fields if you want to add more fields for each word. ","schema":{"type":"string"}},{"name":"translation_fields","in":"query","description":"Comma separated list of translation fields if you want to add more fields for each translation. ","schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma separated list of ayah fields.","schema":{"type":"string"}},{"name":"verse_key","in":"path","description":"Verse key ( chapter:verse) ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"verse":{"title":"Verse","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"},"sajdah_type":{"nullable":true},"sajdah_number":{"nullable":true},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"image_url":{"type":"string"},"image_width":{"type":"integer"},"words":{"type":"array","items":{"title":"Word","type":"object","properties":{"id":{"type":"integer"},"position":{"type":"integer","description":"Word position within ayah"},"text_uthmani":{"type":"string","description":"Word text in Uthmanic script"},"text_indopak":{"type":"string"},"text_imlaei":{"type":"string","description":"Word text in simple/Imlaei script"},"verse_key":{"type":"string"},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"line_number":{"type":"integer","description":"Line number in the Muhsaf for this word"},"audio_url":{"type":"string"},"location":{"type":"string"},"char_type_name":{"type":"string"},"code_v1":{"type":"string","description":"glyph code that you can use to render the word using QCF v1 font."},"code_v2":{"type":"string","description":"glyph code that you can use to render the word using QCF v2 font."},"translation":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"transliteration":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"v1_page":{"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 word using v1 glyph codes.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["position","audio_url","char_type_name","translation","transliteration"],"example":{"id":1,"position":1,"text_uthmani":"بِسْمِ","text_indopak":"بِسۡمِ","text_imlaei":"بِسْمِ","verse_key":"1:1","page_number":1,"line_number":2,"audio_url":"wbw/001_001_001.mp3","location":"1:1:1","char_type_name":"word","code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}}},"audio":{"title":"AudioFile","type":"object","properties":{"url":{"type":"string"},"duration":{"type":"number"},"format":{"type":"string"},"segments":{"type":"array","items":{}}},"example":{"url":"https://verses.quran.com/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]]]}},"translations":{"type":"array","items":{"title":"Translation","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"}},"required":["resource_id","text"],"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}}},"code_v1":{"type":"string","description":"Glyphs codes for QCF v1 fonts"},"code_v2":{"type":"string","description":"Glyphs codes for QCF v2 fonts"},"v1_page":{"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.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["id","verse_number","verse_key","juz_number","hizb_number","rub_number","sajdah_type","sajdah_number","page_number"],"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":"بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ ١","juz_number":1,"hizb_number":1,"rub_number":1,"sajdah_type":null,"sajdah_number":null,"page_number":1,"image_url":"//c22506.r6.cf1.rackcdn.com/1_1.png","image_width":675,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}]}}},"required":["verse"]},"examples":{"response":{"value":{"verse":{"id":1,"verse_number":1,"page_number":1,"verse_key":"1:1","juz_number":1,"hizb_number":1,"rub_el_hizb_number":1,"sajdah_type":null,"sajdah_number":null,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","line_number":2,"page_number":1,"code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}],"translations":[{"resource_id":131,"text":"In the Name of Allah—the Most Compassionate, Most Merciful."}],"tafsirs":[{"id":82641,"language_name":"english","name":"Tafsir Ibn Kathir","text":"

Which was revealed in Makkah

The Meaning of Al-Fatihah and its Various Names

"}]}}}}}}}},"method":"get","path":"/verses/by_key/{verse_key}","servers":[{"url":"https://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"By Specific Verse By Key","description":{"content":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah of first surah for example.\n\n10:5 is 5th ayah of 10th surah.","type":"text/plain"},"url":{"path":["verses","by_key",":verse_key"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Language to fetch word translation in specific language.","type":"text/plain"},"key":"language","value":""},{"disabled":false,"description":{"content":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","type":"text/plain"},"key":"words","value":""},{"disabled":false,"description":{"content":"comma separated ids of translations to load for each ayah.","type":"text/plain"},"key":"translations","value":""},{"disabled":false,"description":{"content":"Id of recitation if you want to load audio of each ayah.","type":"text/plain"},"key":"audio","value":""},{"disabled":false,"description":{"content":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","type":"text/plain"},"key":"tafsirs","value":""},{"disabled":false,"description":{"content":"Comma separated list of word fields if you want to add more fields for each word. ","type":"text/plain"},"key":"word_fields","value":""},{"disabled":false,"description":{"content":"Comma separated list of translation fields if you want to add more fields for each translation. ","type":"text/plain"},"key":"translation_fields","value":""},{"disabled":false,"description":{"content":"comma separated list of ayah fields.","type":"text/plain"},"key":"fields","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Verse key ( chapter:verse) ","type":"text/plain"},"type":"any","value":"","key":"verse_key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/quran.com_versioned/4.0.0/quran-com-api custom_edit_url: null @@ -24,7 +24,7 @@ import TabItem from "@theme/TabItem"; -Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example. +Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah of first surah for example. 10:5 is 5th ayah of 10th surah. diff --git a/docs/quran.com_versioned/verses-by-verse-key.api.mdx b/docs/quran.com_versioned/verses-by-verse-key.api.mdx index 5b9f113..33f6e83 100644 --- a/docs/quran.com_versioned/verses-by-verse-key.api.mdx +++ b/docs/quran.com_versioned/verses-by-verse-key.api.mdx @@ -1,11 +1,11 @@ --- id: verses-by-verse-key title: "By Specific Verse By Key" -description: "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example." +description: "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah of first surah for example." sidebar_label: "By Specific Verse By Key" hide_title: true hide_table_of_contents: true -api: {"operationId":"verses-by_verse_key","tags":["Verses"],"description":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.","parameters":[{"name":"language","in":"query","description":"Language to fetch word translation in specific language.","schema":{"type":"string","default":"en"}},{"name":"words","in":"query","description":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","schema":{"type":"string","enum":[true,false],"default":true}},{"name":"translations","in":"query","description":"comma separated ids of translations to load for each ayah.","schema":{"type":"string"}},{"name":"audio","in":"query","description":"Id of recitation if you want to load audio of each ayah.","schema":{"type":"integer"}},{"name":"tafsirs","in":"query","description":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","schema":{"type":"string"}},{"name":"word_fields","in":"query","description":"Comma separated list of word fields if you want to add more fields for each word. ","schema":{"type":"string"}},{"name":"translation_fields","in":"query","description":"Comma separated list of translation fields if you want to add more fields for each translation. ","schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma separated list of ayah fields.","schema":{"type":"string"}},{"name":"verse_key","in":"path","description":"Verse key ( chapter:verse) ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"verse":{"title":"Verse","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"},"sajdah_type":{"nullable":true},"sajdah_number":{"nullable":true},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"image_url":{"type":"string"},"image_width":{"type":"integer"},"words":{"type":"array","items":{"title":"Word","type":"object","properties":{"id":{"type":"integer"},"position":{"type":"integer","description":"Word position within ayah"},"text_uthmani":{"type":"string","description":"Word text in Uthmanic script"},"text_indopak":{"type":"string"},"text_imlaei":{"type":"string","description":"Word text in simple/Imlaei script"},"verse_key":{"type":"string"},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"line_number":{"type":"integer","description":"Line number in the Muhsaf for this word"},"audio_url":{"type":"string"},"location":{"type":"string"},"char_type_name":{"type":"string"},"code_v1":{"type":"string","description":"glyph code that you can use to render the word using QCF v1 font."},"code_v2":{"type":"string","description":"glyph code that you can use to render the word using QCF v2 font."},"translation":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"transliteration":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"v1_page":{"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 word using v1 glyph codes.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["position","audio_url","char_type_name","translation","transliteration"],"example":{"id":1,"position":1,"text_uthmani":"بِسْمِ","text_indopak":"بِسۡمِ","text_imlaei":"بِسْمِ","verse_key":"1:1","page_number":1,"line_number":2,"audio_url":"wbw/001_001_001.mp3","location":"1:1:1","char_type_name":"word","code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}}},"audio":{"title":"AudioFile","type":"object","properties":{"url":{"type":"string"},"duration":{"type":"number"},"format":{"type":"string"},"segments":{"type":"array","items":{}}},"example":{"url":"https://verses.quran.com/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]]]}},"translations":{"type":"array","items":{"title":"Translation","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"}},"required":["resource_id","text"],"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}}},"code_v1":{"type":"string","description":"Glyphs codes for QCF v1 fonts"},"code_v2":{"type":"string","description":"Glyphs codes for QCF v2 fonts"},"v1_page":{"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.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["id","verse_number","verse_key","juz_number","hizb_number","rub_number","sajdah_type","sajdah_number","page_number"],"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":"بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ ١","juz_number":1,"hizb_number":1,"rub_number":1,"sajdah_type":null,"sajdah_number":null,"page_number":1,"image_url":"//c22506.r6.cf1.rackcdn.com/1_1.png","image_width":675,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}]}}},"required":["verse"]},"examples":{"response":{"value":{"verse":{"id":1,"verse_number":1,"page_number":1,"verse_key":"1:1","juz_number":1,"hizb_number":1,"rub_el_hizb_number":1,"sajdah_type":null,"sajdah_number":null,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","line_number":2,"page_number":1,"code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}],"translations":[{"resource_id":131,"text":"In the Name of Allah—the Most Compassionate, Most Merciful."}],"tafsirs":[{"id":82641,"language_name":"english","name":"Tafsir Ibn Kathir","text":"

Which was revealed in Makkah

The Meaning of Al-Fatihah and its Various Names

"}]}}}}}}}},"method":"get","path":"/verses/by_key/{verse_key}","servers":[{"url":"https://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"By Specific Verse By Key","description":{"content":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.","type":"text/plain"},"url":{"path":["verses","by_key",":verse_key"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Language to fetch word translation in specific language.","type":"text/plain"},"key":"language","value":""},{"disabled":false,"description":{"content":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","type":"text/plain"},"key":"words","value":""},{"disabled":false,"description":{"content":"comma separated ids of translations to load for each ayah.","type":"text/plain"},"key":"translations","value":""},{"disabled":false,"description":{"content":"Id of recitation if you want to load audio of each ayah.","type":"text/plain"},"key":"audio","value":""},{"disabled":false,"description":{"content":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","type":"text/plain"},"key":"tafsirs","value":""},{"disabled":false,"description":{"content":"Comma separated list of word fields if you want to add more fields for each word. ","type":"text/plain"},"key":"word_fields","value":""},{"disabled":false,"description":{"content":"Comma separated list of translation fields if you want to add more fields for each translation. ","type":"text/plain"},"key":"translation_fields","value":""},{"disabled":false,"description":{"content":"comma separated list of ayah fields.","type":"text/plain"},"key":"fields","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Verse key ( chapter:verse) ","type":"text/plain"},"type":"any","value":"","key":"verse_key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"operationId":"verses-by_verse_key","tags":["Verses"],"description":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah of first surah for example.\n\n10:5 is 5th ayah of 10th surah.","parameters":[{"name":"language","in":"query","description":"Language to fetch word translation in specific language.","schema":{"type":"string","default":"en"}},{"name":"words","in":"query","description":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","schema":{"type":"string","enum":[true,false],"default":true}},{"name":"translations","in":"query","description":"comma separated ids of translations to load for each ayah.","schema":{"type":"string"}},{"name":"audio","in":"query","description":"Id of recitation if you want to load audio of each ayah.","schema":{"type":"integer"}},{"name":"tafsirs","in":"query","description":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","schema":{"type":"string"}},{"name":"word_fields","in":"query","description":"Comma separated list of word fields if you want to add more fields for each word. ","schema":{"type":"string"}},{"name":"translation_fields","in":"query","description":"Comma separated list of translation fields if you want to add more fields for each translation. ","schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma separated list of ayah fields.","schema":{"type":"string"}},{"name":"verse_key","in":"path","description":"Verse key ( chapter:verse) ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"verse":{"title":"Verse","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"},"sajdah_type":{"nullable":true},"sajdah_number":{"nullable":true},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"image_url":{"type":"string"},"image_width":{"type":"integer"},"words":{"type":"array","items":{"title":"Word","type":"object","properties":{"id":{"type":"integer"},"position":{"type":"integer","description":"Word position within ayah"},"text_uthmani":{"type":"string","description":"Word text in Uthmanic script"},"text_indopak":{"type":"string"},"text_imlaei":{"type":"string","description":"Word text in simple/Imlaei script"},"verse_key":{"type":"string"},"page_number":{"type":"integer","description":"page_number is deperacted, please use `v1_page` instead.","minimum":1,"maximum":604},"line_number":{"type":"integer","description":"Line number in the Muhsaf for this word"},"audio_url":{"type":"string"},"location":{"type":"string"},"char_type_name":{"type":"string"},"code_v1":{"type":"string","description":"glyph code that you can use to render the word using QCF v1 font."},"code_v2":{"type":"string","description":"glyph code that you can use to render the word using QCF v2 font."},"translation":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"transliteration":{"type":"object","properties":{"text":{"type":"string"},"language_name":{"type":"string"}}},"v1_page":{"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 word using v1 glyph codes.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["position","audio_url","char_type_name","translation","transliteration"],"example":{"id":1,"position":1,"text_uthmani":"بِسْمِ","text_indopak":"بِسۡمِ","text_imlaei":"بِسْمِ","verse_key":"1:1","page_number":1,"line_number":2,"audio_url":"wbw/001_001_001.mp3","location":"1:1:1","char_type_name":"word","code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}}},"audio":{"title":"AudioFile","type":"object","properties":{"url":{"type":"string"},"duration":{"type":"number"},"format":{"type":"string"},"segments":{"type":"array","items":{}}},"example":{"url":"https://verses.quran.com/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]]]}},"translations":{"type":"array","items":{"title":"Translation","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"}},"required":["resource_id","text"],"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}}},"code_v1":{"type":"string","description":"Glyphs codes for QCF v1 fonts"},"code_v2":{"type":"string","description":"Glyphs codes for QCF v2 fonts"},"v1_page":{"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.","minimum":1,"maximum":604},"v2_page":{"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.","minimum":1,"maximum":604}},"required":["id","verse_number","verse_key","juz_number","hizb_number","rub_number","sajdah_type","sajdah_number","page_number"],"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":"بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ ١","juz_number":1,"hizb_number":1,"rub_number":1,"sajdah_type":null,"sajdah_number":null,"page_number":1,"image_url":"//c22506.r6.cf1.rackcdn.com/1_1.png","image_width":675,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}]}}},"required":["verse"]},"examples":{"response":{"value":{"verse":{"id":1,"verse_number":1,"page_number":1,"verse_key":"1:1","juz_number":1,"hizb_number":1,"rub_el_hizb_number":1,"sajdah_type":null,"sajdah_number":null,"words":[{"id":1,"position":1,"audio_url":"wbw/001_001_001.mp3","char_type_name":"word","line_number":2,"page_number":1,"code_v1":"ﭑ","translation":{"text":"In (the) name","language_name":"english"},"transliteration":{"text":"bis'mi","language_name":"english"}}],"translations":[{"resource_id":131,"text":"In the Name of Allah—the Most Compassionate, Most Merciful."}],"tafsirs":[{"id":82641,"language_name":"english","name":"Tafsir Ibn Kathir","text":"

Which was revealed in Makkah

The Meaning of Al-Fatihah and its Various Names

"}]}}}}}}}},"method":"get","path":"/verses/by_key/{verse_key}","servers":[{"url":"https://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"By Specific Verse By Key","description":{"content":"Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah of first surah for example.\n\n10:5 is 5th ayah of 10th surah.","type":"text/plain"},"url":{"path":["verses","by_key",":verse_key"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Language to fetch word translation in specific language.","type":"text/plain"},"key":"language","value":""},{"disabled":false,"description":{"content":"Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.","type":"text/plain"},"key":"words","value":""},{"disabled":false,"description":{"content":"comma separated ids of translations to load for each ayah.","type":"text/plain"},"key":"translations","value":""},{"disabled":false,"description":{"content":"Id of recitation if you want to load audio of each ayah.","type":"text/plain"},"key":"audio","value":""},{"disabled":false,"description":{"content":"Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.","type":"text/plain"},"key":"tafsirs","value":""},{"disabled":false,"description":{"content":"Comma separated list of word fields if you want to add more fields for each word. ","type":"text/plain"},"key":"word_fields","value":""},{"disabled":false,"description":{"content":"Comma separated list of translation fields if you want to add more fields for each translation. ","type":"text/plain"},"key":"translation_fields","value":""},{"disabled":false,"description":{"content":"comma separated list of ayah fields.","type":"text/plain"},"key":"fields","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Verse key ( chapter:verse) ","type":"text/plain"},"type":"any","value":"","key":"verse_key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/quran.com_versioned/quran-com-api custom_edit_url: null @@ -24,7 +24,7 @@ import TabItem from "@theme/TabItem"; -Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example. +Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah of first surah for example. 10:5 is 5th ayah of 10th surah. diff --git a/openAPI/quran.com/v4.json b/openAPI/quran.com/v4.json index 8123e2b..50d1778 100644 --- a/openAPI/quran.com/v4.json +++ b/openAPI/quran.com/v4.json @@ -1159,7 +1159,7 @@ "tags": [ "Verses" ], - "description": "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for example.\n\n10:5 is 5th ayah of 10th surah.", + "description": "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah of first surah for example.\n\n10:5 is 5th ayah of 10th surah.", "parameters": [ { "name": "language",