Skip to main content

Field Reference

📘 Verse-Level Fields (fields)

These fields can be used in the fields query parameter:

FieldDescription
chapter_idChapter number of this verse
text_indopak
text_imlaei_simple
text_imlaeiWord text in simple/Imlaei script
text_uthmaniWord text in Uthmanic script
text_uthmani_simple
text_uthmani_tajweed
text_qpc_hafs
qpc_uthmani_hafs# deprecated alias of text_qpc_hafs
text_qpc_nastaleeq_hafs
text_qpc_nastaleeq
text_indopak_nastaleeq
image_url
image_width
code_v1
code_v2
page_number
v1_page
v2_page

📗 Word-Level Fields (word_fields)

These fields can be used in the word_fields query parameter:

FieldDescription
verse_idID of the verse the word belongs to
chapter_id
text_uthmaniWord text in Uthmanic script
text_indopak
text_imlaei_simple
text_imlaeiWord text in simple/Imlaei script
text_uthmani_simple
text_uthmani_tajweed
text_qpc_hafs
verse_keyVerse key (e.g., 2:255)
locationPosition of word in the verse
code_v1
code_v2
v1_page
v2_page
line_number
line_v2
line_v1

📙 Translation Fields (translation_fields)

These fields can be used in the translation_fields query parameter:

FieldDescription
chapter_idChapter number of this verse
verse_numberVerse number within the chapter
verse_keyVerse key (e.g., 2:255)
juz_numberJuz number this verse belongs to
hizb_numberHizb number this verse belongs to
rub_el_hizb_numberRub el Hizb number for the verse
page_numberMushaf page number
ruku_numberRuku number this verse belongs to
manzil_numberManzil number this verse belongs to
resource_nameName of the translation resource
language_nameName of the translation language
language_idLanguage ID
idID of the translation

📕 Tafsir Fields (tafsir_fields)

These fields can be used in the tafsir_fields query parameter:

FieldDescription
chapter_idChapter number of this verse
verse_numberVerse number within the chapter
verse_keyVerse key (e.g., 2:255)
juz_numberJuz number this verse belongs to
hizb_numberHizb number this verse belongs to
rub_el_hizb_numberRub el Hizb number for the verse
page_numberMushaf page number
group_verse_key_fromGrouped tafsir start verse key
group_verse_key_toGrouped tafsir end verse key
group_tafsir_idGroup tafsir ID
start_verse_idStart verse ID
end_verse_idEnd verse ID
resource_nameName of the tafsir resource
language_nameName of the tafsir language
language_idLanguage ID
idID of the tafsir