Skip to main content

By Range​

Get verses within a verse key range. Both from and to are inclusive.

Query Parameters
    from string required

    Start verse key (e.g., 2:255).

    to string required

    End verse key (e.g., 2:257).

    language string

    Default value: en

    Language to fetch word-by-word translation in a specific language.

    words string

    Possible values: [true, false]

    Default value: false

    Include words of each ayah? Use this to fetch word-by-word translation and transliteration.

    0 or false will not include words.

    1 or true will include the words.

    Default is false.

    translations string

    comma separated ids of translations to load for each ayah. See /resources/translations for available ids. Use translations=57 to include full-ayah transliteration.

    audio integer

    Ayah-by-ayah recitation ID from /resources/recitations. Chapter-reciter IDs from /resources/chapter_reciters are not supported.

    tafsirs string

    Comma separated ids of tafsirs to load for each ayah if you want to load tafsirs. See /resources/tafsirs for available ids.

    word_fields string

    Comma-separated list of word-level fields to include in response. See full field reference.

    translation_fields string

    Comma separated list of translation fields if you want to add more fields for each translation. See full field reference.

    tafsir_fields string

    Comma separated list of tafsir fields if you want to add more fields for each tafsir. See full field reference.

    fields string

    Comma-separated list of verse-level fields to include in response. Use fields=text_uthmani,text_indopak to include Arabic text. See full field reference.

    page integer

    Default value: 1

    For paginating within the result

    per_page integer

    Possible values: >= 1 and <= 50

    Default value: 10

    records per api call, you can get maximum 50 records.

Responses

Successful response

Schema
    verses object[]
  • Array [
    • id integer required
    chapter_id integer

    Chapter number of this verse

    verse_number integer required
    verse_key string required

    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 integer
    text_uthmani string

    Ayah text in Uthmani Script.

    Uthmani script is an old-fashion script used by the third Caliph, Uthman, to produce the first standard quran manuscript.

    text_uthmani_simple string

    Uthmani script diacritic marks

    text_imlaei string

    Ayah text in Imla'ei script.

    Imla'ei script, is the modern Arabic writing style which is currently in use.

    text_imlaei_simple string
    text_indopak string
    text_uthmani_tajweed string
    juz_number integer required
    hizb_number integer required
    page_number integer required

    Possible values: >= 1 and <= 604

    ruku_number integer
    manzil_number integer
    image_url string
    image_width integer
    words object[]
  • Array [
    • id integer
    position integer required

    Word position within ayah

    text_uthmani string

    Word text in Uthmanic script

    text_indopak string
    text_imlaei string

    Word text in simple/Imlaei script

    verse_key string
    page_number integer

    Possible values: >= 1 and <= 604

    line_number integer

    Line number in the Mushaf for this word

    audio_url string required
    location string
    char_type_name string required
    code_v1 string

    glyph code that you can use to render the word using QCF v1 font.

    code_v2 string

    glyph code that you can use to render the word using QCF v2 font.

    translation object required
    text string
    language_name string
    transliteration object required
    text string
    language_name string
    v1_page integer

    Possible values: >= 1 and <= 604

    Madani Mushaf 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.

    v2_page integer

    Possible values: >= 1 and <= 604

    Madani Mushaf 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.

  • ]
    • audio object
    verse_key string required
    url string required
    translations object[]
  • Array [
    • resource_id integer required
    resource_name string
    id integer
    text string required

    Text of the translation, text could have HTML tags for formatting and footnotes.

    verse_id integer
    language_id integer
    language_name string
    verse_key string
    chapter_id integer
    verse_number integer
    juz_number integer
    hizb_number integer
    page_number integer
    rub_el_hizb_number integer
    ruku_number integer
    manzil_number integer
    foot_notes object

    Map of footnote IDs to their text. Present when foot_notes=true.

    property name* string
  • ]
    • code_v1 string

    Glyphs codes for QCF v1 fonts

    code_v2 string

    Glyphs codes for QCF v2 fonts

    v1_page integer

    Possible values: >= 1 and <= 604

    Madani Mushaf Page number for v1 font. If v1_page value is 2, that means you'll use page 2 font file to render this ayah using v1 glyph codes.

    v2_page integer

    Possible values: >= 1 and <= 604

    Madani Mushaf 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.

    rub_el_hizb_number integer required
  • ]
    • pagination object
    per_page integer

    Entries per api call

    current_page integer

    Current page in paginated result

    next_page integer nullable

    Next page in paginated result

    total_pages integer

    Total number of pages

    total_records integer
Loading...